TWtwilio
ConversationsV1User

Add a new conversation user to your service

Changed on

Add a new conversation user to your service

post/v1/Services/{ChatServiceSid}/Users

Request

  • Base URL
    https://conversations.twilio.com
  • URL
    https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Users
  • Auth
    HTTP basic

Path parameters

ChatServiceSidstring required

The SID of the Conversation Service the User resource is associated with.

Headers

X-Twilio-Webhook-Enabled'true' | 'false'

The X-Twilio-Webhook-Enabled HTTP request header

Request body application/x-www-form-urlencoded

Identitystring required

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.

FriendlyNamestring

The string that you assigned to describe the resource.

Attributesstring

The JSON Object string that stores application-specific data. If attributes have not been set, {} is returned.

RoleSidstring

The SID of a service-level Role to assign to the user.

Response

Created

sidstring nullable

The unique string that we created to identify the User resource.

account_sidstring nullable

The SID of the Account that created the User resource.

chat_service_sidstring nullable

The SID of the Conversation Service the User resource is associated with.

role_sidstring nullable

The SID of a service-level Role assigned to the user.

identitystring nullable

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.

friendly_namestring nullable

The string that you assigned to describe the resource.

attributesstring nullable

The JSON Object string that stores application-specific data. If attributes have not been set, {} is returned.

is_onlineboolean nullable

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.

is_notifiableboolean nullable

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.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring uri nullable

An absolute API resource URL for this user.

linksobject nullable

Changes