Fetch user channel

GET /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}

TODO: Resource-level docs

Path parameters

Responses

  • OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • channel_sid string | null

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.

    • member_sid string | null

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MB[0-9a-fA-F]{32}$.

    • notification_level string | null

      Values are default or muted.

    • service_sid string | null

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

    • status string | null

      Values are joined, invited, or not_participating.

    • url string(uri) | null
    • user_sid string | null

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^US[0-9a-fA-F]{32}$.

GET /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}
curl \
 -X GET https://ip-messaging.twilio.com/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid} \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "channel_sid": "string",
  "last_consumed_message_index": 42,
  "links": {},
  "member_sid": "string",
  "notification_level": "default",
  "service_sid": "string",
  "status": "joined",
  "unread_messages_count": 42,
  "url": "https://example.com",
  "user_sid": "string"
}
Response examples (200)
{
  "account_sid": "string",
  "channel_sid": "string",
  "last_consumed_message_index": 42,
  "links": {},
  "member_sid": "string",
  "notification_level": "default",
  "service_sid": "string",
  "status": "joined",
  "unread_messages_count": 42,
  "url": "https://example.com",
  "user_sid": "string"
}