Fetch user channel

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

Account sid auth token

List of channels for a given user

Path parameters

ServiceSid string Required

The SID of the Service to fetch the User Channel resource from.

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

The SID of the User to fetch the User Channel resource from. This value can be either the sid or the identity of the User resource.
ChannelSid string Required

The SID of the Channel that has the User Channel to fetch. This value can be either the sid or the unique_name of the Channel to fetch.

Responses

200 application/json

OK
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the User Channel resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- service_sid string | null
  
  The SID of the Service the User Channel resource is associated with.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
- channel_sid string | null
  
  The SID of the Channel the User Channel resource belongs to.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.
- user_sid string | null
  
  The SID of the User the User Channel belongs to.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^US[0-9a-fA-F]{32}$.
- member_sid string | null
  
  The SID of a Member that represents the User on the Channel.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MB[0-9a-fA-F]{32}$.
- status string
  
  The status of the User on the Channel. Can be: joined, invited, or not_participating.
  
  Values are joined, invited, or not_participating.
- last_consumed_message_index integer | null
  
  The index of the last Message in the Channel that the Member has read.
- unread_messages_count integer | null
  
  The number of unread Messages in the Channel for the User. Note that retrieving messages on a client endpoint does not mean that messages are consumed or read. See Consumption Horizon feature to learn how to mark messages as consumed.
- links object(uri-map) | null
  
  The absolute URLs of the Members, Messages , Invites and, if it exists, the last Message for the Channel.
- url string(uri) | null
  
  The absolute URL of the User Channel resource.
- notification_level string
  
  The push notification level of the User for the Channel. Can be: default or muted.
  
  Values are default or muted.

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

curl \
 --request GET 'https://chat.twilio.com/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}' \
 --user "username:password"

Response examples (200)

{
  "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "member": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "channel": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "status": "joined",
  "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "notification_level": "default",
  "unread_messages_count": 5,
  "last_consumed_message_index": 5
}