Fetch the configuration of a conversation service

GET /v1/Services/{ChatServiceSid}/Configuration
Account sid auth token

A Service Configuration resource manages service-level settings applicable to the Conversation API.

Fetch the configuration of a conversation service

Path parameters

  • ChatServiceSid string Required

    The SID of the Service configuration resource to fetch.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • chat_service_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

    • default_conversation_creator_role_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

    • default_conversation_role_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

    • default_chat_service_role_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

    • url string(uri) | null

      An absolute API resource URL for this service configuration.

    • links object(uri-map) | null

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

    • reachability_enabled boolean | null

      Whether the Reachability Indicator is enabled for this Conversations Service. The default is false.
GET /v1/Services/{ChatServiceSid}/Configuration 
curl \
 --request GET 'https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration' \
 --user "username:password"
Response examples (200) 
{
  "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration",
  "links": {
    "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks",
    "notifications": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications"
  },
  "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "reachability_enabled": false,
  "default_chat_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "default_conversation_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "default_conversation_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}