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:
sid
type: SID<IS>The unique string that we created to identify the Service resource.
^IS[0-9a-fA-F]{32}$
34
34
unique_name
type: stringAn 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.
account_sid
type: SID<AC>The SID of the Account that created the Service resource.
^AC[0-9a-fA-F]{32}$
34
34
date_created
type: string<date-time>The date and time in GMT when the resource was created specified in ISO 8601 format.
date_updated
type: string<date-time>The date and time in GMT when the resource was last updated specified in ISO 8601 format.
webhooks_from_rest_enabled
type: booleanWhether the Service instance should call webhook_url
when the REST API is used to update Sync objects. The default is false
.
reachability_webhooks_enabled
type: booleanWhether the service instance calls webhook_url
when client endpoints connect to Sync. The default is false
.
acl_enabled
type: booleanWhether token identities in the Service must be granted access to Sync objects by using the Permissions resource. It is disabled (false) by default.
reachability_debouncing_enabled
type: booleanWhether 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.
reachability_debouncing_window
type: integerThe 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.
POST https://sync.twilio.com/v1/Services
ReachabilityWebhooksEnabled
type: booleanWhether the service instance should call webhook_url
when client endpoints connect to Sync. The default is false
.
AclEnabled
type: booleanWhether token identities in the Service must be granted access to Sync objects by using the Permissions resource.
ReachabilityDebouncingEnabled
type: booleanWhether 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.
ReachabilityDebouncingWindow
type: integerThe 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
.
WebhooksFromRestEnabled
type: booleanWhether 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
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0
POST https://sync.twilio.com/v1/Services/{Sid}
ReachabilityWebhooksEnabled
type: booleanWhether the service instance should call webhook_url
when client endpoints connect to Sync. The default is false
.
AclEnabled
type: booleanWhether token identities in the Service must be granted access to Sync objects by using the Permissions resource.
ReachabilityDebouncingEnabled
type: booleanWhether 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.
ReachabilityDebouncingWindow
type: integerThe 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.
WebhooksFromRestEnabled
type: booleanWhether 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}