Path parameters
-
The Twilio-provided string that uniquely identifies the Service resource to update.
Minimum length is
34, maximum length is34. Format should match the following pattern:^KS[0-9a-fA-F]{32}$.
Body
-
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.
-
The default
ttlvalue 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 of0indicates an unlimited Session length. You can override a Session's default TTL value by setting itsttlvalue. -
The URL we should call when the interaction status changes.
-
Where a proxy number must be located relative to the participant identifier. Can be:
country,area-code, orextended-area-code. The default value iscountryand more specific areas thancountryare only available in North America.Values are
area-code,overlay,radius, orcountry. -
The preference for Proxy Number selection in the Service instance. Can be:
prefer-stickyoravoid-sticky.prefer-stickymeans 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-stickymeans 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-stickyorprefer-sticky. -
The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.
-
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.
-
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}$.
curl \
--request POST 'https://proxy.twilio.com/v1/Services/{Sid}' \
--user "username:password" \
--header "Content-Type: application/x-www-form-urlencoded" \
--data 'DefaultTtl=3600&UniqueName=My+Service&CallbackUrl=http%3A%2F%2Fwww.example.com&ChatInstanceSid=ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
{"DefaultTtl" => 3600, "UniqueName" => "My Service", "CallbackUrl" => "http://www.example.com", "ChatInstanceSid" => "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}
{
"sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"links": {
"sessions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions",
"phone_numbers": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers"
},
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"default_ttl": 3600,
"unique_name": "My Service",
"callback_url": "http://www.example.com",
"date_created": "2015-07-30T20:00:00Z",
"date_updated": "2015-07-30T20:00:00Z",
"geo_match_level": "country",
"chat_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"intercept_callback_url": "http://www.example.com",
"number_selection_behavior": "prefer-sticky",
"out_of_session_callback_url": "http://www.example.com"
}