TWtwilio
ProxyV1Service

Fetch a specific Service.

Changed on

Fetch a specific Service.

get/v1/Services/{Sid}

Request

  • Base URL
    https://proxy.twilio.com
  • URL
    https://proxy.twilio.com/v1/Services/{Sid}
  • Auth
    HTTP basic

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.

unique_namestring nullable

An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. Supports UTF-8 characters. This value should not have PII.

account_sidstring nullable

The SID of the Account that created the Service resource.

chat_instance_sidstring nullable

The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.

callback_urlstring uri nullable

The URL we call when the interaction status changes.

default_ttlinteger

The default ttl value for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of 0 indicates an unlimited Session length. You can override a Session's default TTL value by setting its ttl value.

number_selection_behavior'avoid-sticky' | 'prefer-sticky'

The preference for Proxy Number selection in the Service instance. Can be: prefer-sticky or avoid-sticky. prefer-sticky means that we will try and select the same Proxy Number for a given participant if they have previous Sessions, but we will not fail if that Proxy Number cannot be used. avoid-sticky means that we will try to use different Proxy Numbers as long as that is possible within a given pool rather than try and use a previously assigned number.

geo_match_level'area-code' | 'overlay' | 'radius' | 'country'

Where a proxy number must be located relative to the participant identifier. Can be: country, area-code, or extended-area-code. The default value is country and more specific areas than country are only available in North America.

intercept_callback_urlstring uri nullable

The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.

out_of_session_callback_urlstring uri nullable

The URL we call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio function) responds with valid TwiML, we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See Out-of-Session Callback Response Guide for more information.

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

urlstring uri nullable

The absolute URL of the Service resource.

linksobject nullable

The URLs of resources related to the Service.

Changes