A Service is the top-level scope of all other resources in the REST API. It contains all the objects in a Sync application. Services allow you to:
An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid
in the URL to address the resource. It is a read-only property, it cannot be assigned using REST API.
The date and time in GMT when the resource was created specified in ISO 8601 format.
The date and time in GMT when the resource was last updated specified in ISO 8601 format.
Whether the Service instance should call webhook_url
when the REST API is used to update Sync objects. The default is false
.
Whether the service instance calls webhook_url
when client endpoints connect to Sync. The default is false
.
Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource. It is disabled (false) by default.
Whether every endpoint_disconnected
event should occur after a configurable delay. The default is false
, where the endpoint_disconnected
event occurs immediately after disconnection. When true
, intervening reconnections can prevent the endpoint_disconnected
event.
The reachability event delay in milliseconds if reachability_debouncing_enabled
= true
. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before webhook_url
is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring.
The URLs of related resources.
POST https://sync.twilio.com/v1/Services
Whether the service instance should call webhook_url
when client endpoints connect to Sync. The default is false
.
Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource.
Whether every endpoint_disconnected
event should occur after a configurable delay. The default is false
, where the endpoint_disconnected
event occurs immediately after disconnection. When true
, intervening reconnections can prevent the endpoint_disconnected
event.
The reachability event delay in milliseconds if reachability_debouncing_enabled
= true
. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the webhook_url
is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the call to webhook_url
.
Whether the Service instance should call webhook_url
when the REST API is used to update Sync objects. The default is false
.
GET https://sync.twilio.com/v1/Services/{Sid}
GET https://sync.twilio.com/v1/Services
How many resources to return in each list page. The default is 50, and the maximum is 1000.
POST https://sync.twilio.com/v1/Services/{Sid}
Whether the service instance should call webhook_url
when client endpoints connect to Sync. The default is false
.
Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource.
Whether every endpoint_disconnected
event should occur after a configurable delay. The default is false
, where the endpoint_disconnected
event occurs immediately after disconnection. When true
, intervening reconnections can prevent the endpoint_disconnected
event.
The reachability event delay in milliseconds if reachability_debouncing_enabled
= true
. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the webhook is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the webhook from being called.
Whether the Service instance should call webhook_url
when the REST API is used to update Sync objects. The default is false
.
DELETE https://sync.twilio.com/v1/Services/{Sid}