Menu

Expand
Rate this page:

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
sid<IS> Not PII

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

default_conversation_creator_role_sid
sid<RL> Not PII

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_sid
sid<RL> Not PII

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

default_chat_service_role_sid
sid<RL> Not PII

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

url
url Not PII

An absolute API resource URL for this service configuration.

links
uri_map Not PII

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

reachability_enabled
boolean Not PII

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

Fetch a ServiceConfiguration resource

get
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration
Parameters
Parameters in REST API format
chat_service_sid
Path
get sid<IS> Not PII

The SID of the Service configuration resource to fetch.

Example 1
        
        
        
        

        Update a ServiceConfiguration resource

        post
        https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration
        Parameters
        Parameters in REST API format
        chat_service_sid
        Path
        post sid<IS> Not PII

        The SID of the Service configuration resource to update.

        default_conversation_creator_role_sid
        Optional
        post sid<RL> Not PII

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

        default_conversation_role_sid
        Optional
        post sid<RL> Not PII

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

        default_chat_service_role_sid
        Optional
        post sid<RL> Not PII

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

        reachability_enabled
        Optional
        post boolean Not PII

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

        Example 1
              
              
              
              
              Rate this page:

              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 browsing the Twilio tag on Stack Overflow.

                    
                    
                    

                    Thank you for your feedback!

                    We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                    Sending your feedback...
                    🎉 Thank you for your feedback!
                    Something went wrong. Please try again.

                    Thanks for your feedback!

                    Refer us and get $10 in 3 simple steps!

                    Step 1

                    Get link

                    Get a free personal referral link here

                    Step 2

                    Give $10

                    Your user signs up and upgrade using link

                    Step 3

                    Get $10

                    1,250 free SMSes
                    OR 1,000 free voice mins
                    OR 12,000 chats
                    OR more