Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-054014269.7 KB
ChatV1Service

get/v1/Services/{Sid}

Path parameters

Sidstring required

The Twilio-provided string that uniquely identifies the Service resource to fetch.

Response

OK

sidstring nullable

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

account_sidstring nullable

The SID of the Account that created the Service resource.

friendly_namestring nullable

The string that you assigned to describe the resource.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in RFC 2822 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

default_service_role_sidstring nullable

The service role assigned to users when they are added to the service. See the Roles endpoint for more details.

default_channel_role_sidstring nullable

The channel role assigned to users when they are added to a channel. See the Roles endpoint for more details.

default_channel_creator_role_sidstring nullable

The channel role assigned to a channel creator when they join a new channel. See the Roles endpoint for more details.

read_status_enabledboolean nullable

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

reachability_enabledboolean nullable

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

typing_indicator_timeoutinteger

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.

consumption_report_intervalinteger

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

{"stackTrail":"components:schemas:chat.v1.service:properties:limits","oasType":"schema","type":"unknown","description":"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.","nullable":true}
{"stackTrail":"components:schemas:chat.v1.service:properties:webhooks","oasType":"schema","type":"unknown","description":"An object that contains information about the webhooks configured for this service.","nullable":true}
pre_webhook_urlstring nullable

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

post_webhook_urlstring nullable

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

webhook_methodstring nullable

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_filtersstring[] nullable

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

{"stackTrail":"components:schemas:chat.v1.service:properties:notifications","oasType":"schema","type":"unknown","description":"The notification configuration for the Service instance. See [Push Notification Configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more information.","nullable":true}
urlstring uri nullable

The absolute URL of the Service resource.

linksobject nullable

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