Fetch a specific Service

GET /v1/Services/{Sid}

TODO: Resource-level docs

Fetch a specific Service.

Path parameters

  • Sid string Required

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

Responses

  • OK

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

      The SID of the Account that created the resource

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

    • callback_url string(uri) | null

      The URL we call when the interaction status changes

    • chat_instance_sid string | null

      The SID of the Chat Service Instance

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

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • default_ttl integer | null

      Default TTL for a Session, in seconds

    • geo_match_level string | null

      Where a proxy number must be located relative to the participant identifier

      Values are area-code, overlay, radius, or country.

    • intercept_callback_url string(uri) | null

      The URL we call on each interaction

    • The preference for Proxy Number selection for the Service instance

      Values are avoid-sticky or prefer-sticky.

    • The URL we call when an inbound call or SMS action occurs on a closed or non-existent Session

    • sid string | null

      The unique string that identifies the resource

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

    • unique_name string | null

      An application-defined string that uniquely identifies the resource

    • url string(uri) | null

      The absolute URL of the Service resource

GET /v1/Services/{Sid}
curl \
 -X GET https://proxy.twilio.com/v1/Services/{Sid} \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "callback_url": "https://example.com",
  "chat_instance_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "default_ttl": 42,
  "geo_match_level": "area-code",
  "intercept_callback_url": "https://example.com",
  "links": {},
  "number_selection_behavior": "avoid-sticky",
  "out_of_session_callback_url": "https://example.com",
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}
Response examples (200)
{
  "account_sid": "string",
  "callback_url": "https://example.com",
  "chat_instance_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "default_ttl": 42,
  "geo_match_level": "area-code",
  "intercept_callback_url": "https://example.com",
  "links": {},
  "number_selection_behavior": "avoid-sticky",
  "out_of_session_callback_url": "https://example.com",
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}