Chat User 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 resource of Programmable Chat represents a single user who is identified by an
identity value that you provide when the User resource is created. The User resource's identity must be unique within its Service instance.
Within Twilio Programmable Chat, the user identity is a case-sensitive value.
We recommend following the standard URI specification and avoid the following reserved characters ! * ' ( ) ; : @ & = + $ , / ? % # [ ] for values such as identity and friendly name.
User resources are used to assign permissions, which determine what the user can and cannot do within the service.
Users can be created within a Service instance by using the client capability token or the User resource's Create action.
When Programmable Chat encounters a new Identity in a Service instance, a new User instance is created for that identity. When an Identity exists, its corresponding User record will be used the session/request for endpoints, Access Tokens, and when the REST API is used to create a Member resource.
User properties
The User resource contains these properties.
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the User resource. |
account_sid
|
The SID of the Account that created the User resource. |
service_sid
|
The SID of the Service the User resource is associated with. |
attributes
|
The JSON string that stores application-specific data. If attributes have not been set, |
friendly_name
|
The string that you assigned to describe the resource. |
role_sid
|
The SID of the Role assigned to the user. |
identity
|
The application-defined string that uniquely identifies the resource's User within the Service. This value is often a username or an email address, and is case-sensitive. See access tokens for more info. |
is_online
|
Whether the User is actively connected to the Service instance and online. This value is only returned by Fetch actions that return a single resource and |
is_notifiable
|
Whether the User has a potentially valid Push Notification registration (APN or GCM) for the Service instance. If at least one registration exists, |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
joined_channels_count
|
The number of Channels the User is a Member of. |
links
|
The absolute URLs of the Channel and Binding resources related to the user. |
url
|
The absolute URL of the User resource. |
Create a User resource
https://chat.twilio.com/v2/Services/{ServiceSid}/Users
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to create the User resource under. |
identity
Required
|
The |
role_sid
Optional
|
The SID of the Role to assign to the new User. |
attributes
Optional
|
A valid JSON string that contains application-specific data. |
friendly_name
Optional
|
A descriptive string that you create to describe the new resource. This value is often used for display purposes. |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Fetch a User resource
https://chat.twilio.com/v2/Services/{ServiceSid}/Users/{Sid}
The {Sid} value can be either the sid or the identity of the User resource to fetch.
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to fetch the User resource from. |
sid
Path
|
The SID of the User resource to fetch. This value can be either the |
Example 1
Read multiple User resources
https://chat.twilio.com/v2/Services/{ServiceSid}/Users
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to read the User resources from. |
Example 1
Update a User resource
https://chat.twilio.com/v2/Services/{ServiceSid}/Users/{Sid}
The {Sid} value can be either the sid or the identity of the User resource to update.
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to update the User resource in. |
sid
Path
|
The SID of the User resource to update. This value can be either the |
role_sid
Optional
|
The SID of the Role to assign to the User. |
attributes
Optional
|
A valid JSON string that contains application-specific data. |
friendly_name
Optional
|
A descriptive string that you create to describe the resource. It is often used for display purposes. |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Delete a User resource
https://chat.twilio.com/v2/Services/{ServiceSid}/Users/{Sid}
The {Sid} value can be either the sid or the identity of the User resource to delete.
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to delete the User resource from. |
sid
Path
|
The SID of the User resource to delete. This value can be either the |
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.
