Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

User Channels Resource

The User Channels resource of Programmable Chat is a list only resource which will return the list of Channels the User is a Member of.

The underlying resource is the normal Channel resource of Chat.

Properties

Each channel instance returned in the list has the following properties:

Names in PHP format
accountSid
sid<AC> Not PII

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

serviceSid
sid<IS> Not PII

The SID of the Service the resource is associated with.

channelSid
sid<CH> Not PII

The SID of the Channel the resource belongs to.

userSid
sid<US> Not PII

The SID of the User the User Channel belongs to.

memberSid
sid<MB> Not PII

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

status
enum:channel_status Not PII

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

lastConsumedMessageIndex
integer? Not PII

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

unreadMessagesCount
integer? Not PII

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
uri_map Not PII

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

url
url Not PII

The absolute URL of the User Channel resource.

notificationLevel
enum:notification_level Not PII

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


List All User Channels

GET /Services/{Instance SID}/Users/{User SID}/Channels
        
        
        
        
        Rate this page:

        Need some help?

        We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.