Path parameters

• Sid string Required

  The SID of the Service 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

  • sid string | null

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

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

  • account_sid string | null

    The SID of the Account that created the Service resource.

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

  • friendly_name string | null

    The string that you assigned to describe the resource.

  • date_created string(date-time) | null

    The date and time in GMT when the resource was created specified in ISO 8601 format.

  • date_updated string(date-time) | null

    The date and time in GMT when the resource was last updated specified in ISO 8601 format.

  • default_service_role_sid string | null

    The service role assigned to users when they are added to the service. See the Role resource 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_channel_role_sid string | null

    The channel role assigned to users when they are added to a channel. See the Role resource 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_channel_creator_role_sid string | null

    The channel role assigned to a channel creator when they join a new channel. See the Role resource 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}$.

  • read_status_enabled boolean | null

    Whether the Message Consumption Horizon feature is enabled. The default is true.

  • reachability_enabled boolean | null

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

  • typing_indicator_timeout integer

    How long in seconds after a started typing event until clients should assume that user is no longer typing, even if no ended typing message was received. The default is 5 seconds.

    Default value is 0.

  • consumption_report_interval integer

    DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.

    Default value is 0.

  • limits

    An object that describes the limits of the service instance. The limits object contains channel_members to describe the members/channel limit and user_channels to describe the channels/user limit. channel_members can be 1,000 or less, with a default of 250. user_channels can be 1,000 or less, with a default value of 100.

  • pre_webhook_url string | null

    The URL for pre-event webhooks, which are called by using the webhook_method. See Webhook Events for more details.

  • post_webhook_url string | null

    The URL for post-event webhooks, which are called by using the webhook_method. See Webhook Events for more details.

  • webhook_method string | null

    The HTTP method to use for calls to the pre_webhook_url and post_webhook_url webhooks. Can be: POST or GET and the default is POST. See Webhook Events for more details.

  • webhook_filters array[string] | null

    The list of webhook events that are enabled for this Service instance. See Webhook Events for more details.

  • pre_webhook_retry_count integer

    The number of times to retry a call to the pre_webhook_url if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried.

    Default value is 0.

  • post_webhook_retry_count integer

    The number of times to retry a call to the post_webhook_url if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried.

    Default value is 0.

  • notifications

    The notification configuration for the Service instance. See Push Notification Configuration for more info.

  • media

    An object that describes the properties of media that the service supports. The object contains the size_limit_mb property, which describes the size of the largest media file in MB; and the compatibility_message property, which contains the message text to send when a media message does not have any text.

  • url string(uri) | null

    The absolute URL of the Service resource.

  • links object(uri-map) | null

    The absolute URLs of the Service's Channels, Roles, Bindings, and Users.