User Channel Resource
Programmable Chat has been deprecated and is no longer supported. Instead, we'll be focusing on the next generation of chat: Twilio Conversations. Find out more about the EOL process here.
If you're starting a new project, please visit the Conversations Docs to begin. If you've already built on Programmable Chat, please visit our Migration Guide to learn about how to switch.
The User Channel resource of Programmable Chat is a read-only resource that describes a Channel that the User is a Member of.
UserChannel properties
Each User Channel resource contains these properties.
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The SID of the Account that created the User Channel resource. |
service_sid
|
The SID of the Service the User Channel resource is associated with. |
channel_sid
|
The SID of the Channel the User Channel resource belongs to. |
user_sid
|
The SID of the User the User Channel belongs to. |
member_sid
|
The SID of a Member that represents the User on the Channel. |
status
|
The status of the User on the Channel. Can be: |
last_consumed_message_index
|
The index of the last Message in the Channel that the Member has read. |
unread_messages_count
|
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
|
The absolute URLs of the Members, Messages , Invites and, if it exists, the last Message for the Channel. |
url
|
The absolute URL of the User Channel resource. |
notification_level
|
The push notification level of the User for the Channel. Can be: |
Fetch a UserChannel resource
https://chat.twilio.com/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}
The {UserSid} value can be either the sid or the identity of the User resource and the {ChannelSid} value can be either the sid or the unique_name of the Channel to fetch.
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to fetch the User Channel resource from. |
user_sid
Path
|
The SID of the User to fetch the User Channel resource from. This value can be either the |
channel_sid
Path
|
The SID of the Channel that has the User Channel to fetch. This value can be either the |
Example 1
Read multiple UserChannel resources
https://chat.twilio.com/v2/Services/{ServiceSid}/Users/{UserSid}/Channels
The {UserSid} value can be either the sid or the identity of the User resource to read User Channel resources from.
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to read the User Channel resources from. |
user_sid
Path
|
The SID of the User to read the User Channel resources from. This value can be either the |
Example 1
Set the NotificationLevel
https://chat.twilio.com/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}
The NotificationLevel property expresses whether a user receives pushes for this channel or not. This can be set separately for each user/channel pair.
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to update the User Channel resource in. |
user_sid
Path
|
The SID of the User to update the User Channel resource from. This value can be either the |
channel_sid
Path
|
The SID of the Channel with the User Channel resource to update. This value can be the Channel resource's |
notification_level
Optional
|
The push notification level to assign to the User Channel. Can be: |
last_consumed_message_index
Optional
|
The index of the last Message in the Channel that the Member has read. |
last_consumption_timestamp
Optional
|
The ISO 8601 timestamp of the last Message read event for the Member within the Channel. |
Example 1
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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
