Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1410161228.2 KB

Fetch a conversation user from your service

get/v1/Services/{ChatServiceSid}/Users/{Sid}

Path parameters

ChatServiceSidstring required

The SID of the Conversation Service to fetch the User resource from.

Sidstring required

The SID of the User resource to fetch. This value can be either the sid or the identity of the User resource to fetch.

Response

OK

account_sidstring nullable

The SID of the Account that created the User resource.

attributesstring nullable

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

chat_service_sidstring nullable

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

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.

friendly_namestring nullable

The string that you assigned to describe the resource.

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.

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.

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.

linksobject nullable
role_sidstring nullable

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

sidstring nullable

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

urlstring uri nullable

An absolute API resource URL for this user.