Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-055427357.6 KB
ChatV2UserChannel

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

Path parameters

ServiceSidstring required

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

UserSidstring 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.

ChannelSidstring 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.

Response

OK

account_sidstring nullable

The SID of the Account that created the User Channel resource.

service_sidstring nullable

The SID of the Service the User Channel resource is associated with.

channel_sidstring nullable

The SID of the Channel the User Channel resource belongs to.

user_sidstring nullable

The SID of the User the User Channel belongs to.

member_sidstring nullable

The SID of a Member that represents the User on the Channel.

status'joined' | 'invited' | 'notParticipating'

The status of the User on the Channel. Can be: joined, invited, or notParticipating.

last_consumed_message_indexinteger nullable

The index of the last Message in the Channel that the Member has read.

unread_messages_countinteger nullable

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.

linksobject nullable

The absolute URLs of the Members, Messages , Invites and, if it exists, the last Message for the Channel.

urlstring uri nullable

The absolute URL of the User Channel resource.

notification_level'default' | 'muted'

The push notification level of the User for the Channel. Can be: default or muted.