Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1410161228.2 KB

Fetch the configuration of a conversation service

get/v1/Services/{ChatServiceSid}/Configuration

Path parameters

ChatServiceSidstring required

The SID of the Service configuration resource to fetch.

Response

OK

chat_service_sidstring nullable

The unique string that we created to identify the Service configuration resource.

default_chat_service_role_sidstring nullable

The service-level role assigned to users when they are added to the service. See the Conversation Role for more info about roles.

default_conversation_creator_role_sidstring nullable

The conversation-level role assigned to a conversation creator user when they join a new conversation. See the Conversation Role for more info about roles.

default_conversation_role_sidstring nullable

The conversation-level role assigned to users when they are added to a conversation. See the Conversation Role for more info about roles.

linksobject nullable

Contains an absolute API resource URL to access the push notifications configuration of this service.

reachability_enabledboolean nullable

Whether the Reachability Indicator is enabled for this Conversations Service. The default is false.

urlstring uri nullable

An absolute API resource URL for this service configuration.