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 unique id of the Account responsible for this channel.

serviceSid
sid<IS> Not PII

The unique id of the Service this channel belongs to.

channelSid
sid<CH> Not PII

The unique id of a Channel.

userSid
sid<US> Not PII

The unique id of the User this Channel belongs to.

memberSid
sid<MB> Not PII

The unique id of a Member representing the User on this Channel.

status
enum:channel_status Not PII

The status of the User (joined, invited or not_participating) on this Channel.

lastConsumedMessageIndex
integer? Not PII

The index of the last read Message in this Channel for this User.

unreadMessagesCount
integer? Not PII

The count of unread Messages in this Channel for this User. Note that just retrieving messages on a client endpoint does not mean that messages are consumed/read, please consider reading about Consumption Horizon feature to find out how to mark messages as consumed.

links
uri_map Not PII

url
url Not PII

An absolute URL for this User Channel.

notificationLevel
enum:notification_level Not PII

The notification level of the User (default or muted) for this Channel.


List All User Channels

GET /Services/{Instance SID}/Users/{User SID}/Channels
        
        
        
        

        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.