Update a specific Service
TODO: Resource-level docs
Update a specific Service.
Path parameters
-
The Twilio-provided string that uniquely identifies the Service resource to update.
Body
-
CallbackUrl string(uri)
The URL we should call when the interaction status changes.
-
ChatInstanceSid string
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.
Minimum length is
34
, maximum length is34
. Format should match the following pattern:^IS[0-9a-fA-F]{32}$
. -
DefaultTtl integer
The default
ttl
value to set 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 of0
indicates an unlimited Session length. You can override a Session's default TTL value by setting itsttl
value. -
GeoMatchLevel string
Where a proxy number must be located relative to the participant identifier. Can be:
country
,area-code
, orextended-area-code
. The default value iscountry
and more specific areas thancountry
are only available in North America.Values are
area-code
,overlay
,radius
, orcountry
. -
InterceptCallbackUrl string(uri)
The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.
-
NumberSelectionBehavior string
The preference for Proxy Number selection in the Service instance. Can be:
prefer-sticky
oravoid-sticky
and the default isprefer-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.Values are
avoid-sticky
orprefer-sticky
. -
OutOfSessionCallbackUrl string(uri)
The URL we should 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.
-
UniqueName string
An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. This value should not have PII.
curl \
-X POST https://proxy.twilio.com/v1/Services/{Sid} \
--user "username:password" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d 'CallbackUrl=https%3A%2F%2Fexample.com&ChatInstanceSid=string&DefaultTtl=42&GeoMatchLevel=area-code&InterceptCallbackUrl=https%3A%2F%2Fexample.com&NumberSelectionBehavior=avoid-sticky&OutOfSessionCallbackUrl=https%3A%2F%2Fexample.com&UniqueName=string'
{
"CallbackUrl": "https://example.com",
"ChatInstanceSid": "string",
"DefaultTtl": 42,
"GeoMatchLevel": "area-code",
"InterceptCallbackUrl": "https://example.com",
"NumberSelectionBehavior": "avoid-sticky",
"OutOfSessionCallbackUrl": "https://example.com",
"UniqueName": "string"
}
{
"CallbackUrl": "https://example.com",
"ChatInstanceSid": "string",
"DefaultTtl": 42,
"GeoMatchLevel": "area-code",
"InterceptCallbackUrl": "https://example.com",
"NumberSelectionBehavior": "avoid-sticky",
"OutOfSessionCallbackUrl": "https://example.com",
"UniqueName": "string"
}
{
"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"
}
{
"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"
}