Service Configuration Resource
The Configuration Resource represents all of the configuration settings for a Conversation Service, such as the default roles assigned to Users.
ServiceConfiguration properties
| Resource Properties in REST API format | |
|---|---|
chat_service_sid
|
The unique string that we created to identify the Service configuration resource. |
default_conversation_creator_role_sid
|
The conversation-level role assigned to a conversation creator when they join a new conversation. See Conversation Role for more info about roles. |
default_conversation_role_sid
|
The conversation-level role assigned to users when they are added to a conversation. See Conversation Role for more info about roles. |
default_chat_service_role_sid
|
The service-level role assigned to users when they are added to the service. See Conversation Role for more info about roles. |
url
|
An absolute API resource URL for this service configuration. |
links
|
Contains an absolute API resource URL to access the push notifications configuration of this service. |
reachability_enabled
|
Whether the Reachability Indicator is enabled for this Conversations Service. The default is |
Fetch a ServiceConfiguration resource
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Service configuration resource to fetch. |
Example 1
Update a ServiceConfiguration resource
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Service configuration resource to update. |
default_conversation_creator_role_sid
Optional
|
The conversation-level role assigned to a conversation creator when they join a new conversation. See Conversation Role for more info about roles. |
default_conversation_role_sid
Optional
|
The conversation-level role assigned to users when they are added to a conversation. See Conversation Role for more info about roles. |
default_chat_service_role_sid
Optional
|
The service-level role assigned to users when they are added to the service. See Conversation Role for more info about roles. |
reachability_enabled
Optional
|
Whether the Reachability Indicator is enabled for this Conversations Service. The default is |
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.
