In Conversations, Users are Participants with privileges such as the ability to edit and delete Messages.
Every Conversation Participant who connects with a Chat SDK (browser or mobile) is backed by a User. Participants over SMS or other non-chat channel, in contrast, do not have a corresponding User. Attached to the User is:
the Role assigned to the User
, which determines their permissions in your application
a JSON blob of arbitrary Attributes
, which you can use to store profile information for display in your application
Online/Offline status
, determined by whether the User is presently connected through a frontend SDK
the Identity string
, which uniquely identifies a user in each Conversation Service.
We recommend following the standard URI specification and avoid the following reserved characters! * ' ( ) ; : @ & = + $ , / ? % # [ ]for values such as identity and friendly name.
API Base URL
All URLs in the reference documentation use the following base URL:
_10
https://conversations.twilio.com/v1
Using the shortened base URL
Using the REST API, you can interact with User resources in the default Conversation Service instance via a "shortened" URL that does not include the Conversation Service instance SID ("ISXXX..."). If you are only using one Conversation Service (the default), you do not need to include the Conversation Service SID in your URL, e.g.
_10
GET /v1/Users/
For Conversations applications that build on more than one Conversation Service instance, you will need to specify the Conversation Service SID in the REST API call:
The application-defined string that uniquely identifies the resource's User within the Conversation Service. This value is often a username or an email address, and is case-sensitive.
Whether the User is actively connected to this Conversations Service and online. This value is only returned by Fetch actions that return a single resource and null is always returned by a Read action. This value is null if the Service's reachability_enabled is false, if the User has never been online for this Conversations Service, even if the Service's reachability_enabled is true.
Whether the User has a potentially valid Push Notification registration (APN or GCM) for this Conversations Service. If at least one registration exists, true; otherwise false. This value is only returned by Fetch actions that return a single resource and null is always returned by a Read action. This value is null if the Service's reachability_enabled is false, and if the User has never had a notification registration, even if the Service's reachability_enabled is true.
The application-defined string that uniquely identifies the resource's User within the Conversation Service. This value is often a username or an email address, and is case-sensitive.
The SID of a service-level Role to assign to the user.
Create a User
Users are usually autocreated with default roles the first time the appear. To control a User's assigned Role from the moment of creation, use this resource.
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl
_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure