A Service is the top-level scope of all other resources in Notify REST API.
You can create up to 10 Service resources per account and you can use them to:
If you need more than 10 Service resources for your account, please contact support.
sid
type: SID<IS>The unique string that we created to identify the Service resource.
^IS[0-9a-fA-F]{32}$
34
34
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 RFC 2822 format.
date_updated
type: string<date-time>The date and time in GMT when the resource was last updated specified in RFC 2822 format.
apn_credential_sid
type: SID<CR>The SID of the Credential to use for APN Bindings.
^CR[0-9a-fA-F]{32}$
34
34
gcm_credential_sid
type: SID<CR>The SID of the Credential to use for GCM Bindings.
^CR[0-9a-fA-F]{32}$
34
34
fcm_credential_sid
type: SID<CR>The SID of the Credential to use for FCM Bindings.
^CR[0-9a-fA-F]{32}$
34
34
messaging_service_sid
type: SID<MG>The SID of the Messaging Service to use for SMS Bindings. In order to send SMS notifications this parameter has to be set.
^MG[0-9a-fA-F]{32}$
34
34
default_apn_notification_protocol_version
type: stringThe protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
default_gcm_notification_protocol_version
type: stringThe protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
default_fcm_notification_protocol_version
type: stringThe protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
log_enabled
type: booleanWhether to log notifications. Can be: true
or false
and the default is true
.
links
type: object<uri-map>The URLs of the Binding, Notification, Segment, and User resources related to the service.
delivery_callback_enabled
type: booleanCallback configuration that enables delivery callbacks, default false
POST https://notify.twilio.com/v1/Services
FriendlyName
type: stringA descriptive string that you create to describe the resource. It can be up to 64 characters long.
ApnCredentialSid
type: SID<CR>The SID of the Credential to use for APN Bindings.
^CR[0-9a-fA-F]{32}$
34
34
GcmCredentialSid
type: SID<CR>The SID of the Credential to use for GCM Bindings.
^CR[0-9a-fA-F]{32}$
34
34
MessagingServiceSid
type: SID<MG>The SID of the Messaging Service to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
^MG[0-9a-fA-F]{32}$
34
34
DefaultApnNotificationProtocolVersion
type: stringThe protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
DefaultGcmNotificationProtocolVersion
type: stringThe protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
FcmCredentialSid
type: SID<CR>The SID of the Credential to use for FCM Bindings.
^CR[0-9a-fA-F]{32}$
34
34
DefaultFcmNotificationProtocolVersion
type: stringThe protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
LogEnabled
type: booleanWhether to log notifications. Can be: true
or false
and the default is true
.
DeliveryCallbackEnabled
type: booleanCallback configuration that enables delivery callbacks, default false
GET https://notify.twilio.com/v1/Services/{Sid}
Sid
type: SID<IS>The Twilio-provided string that uniquely identifies the Service resource to fetch.
^IS[0-9a-fA-F]{32}$
34
34
GET https://notify.twilio.com/v1/Services
FriendlyName
type: stringThe string that identifies the Service resources to read.
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://notify.twilio.com/v1/Services/{Sid}
Sid
type: SID<IS>The Twilio-provided string that uniquely identifies the Service resource to update.
^IS[0-9a-fA-F]{32}$
34
34
FriendlyName
type: stringA descriptive string that you create to describe the resource. It can be up to 64 characters long.
ApnCredentialSid
type: SID<CR>The SID of the Credential to use for APN Bindings.
^CR[0-9a-fA-F]{32}$
34
34
GcmCredentialSid
type: SID<CR>The SID of the Credential to use for GCM Bindings.
^CR[0-9a-fA-F]{32}$
34
34
MessagingServiceSid
type: SID<MG>The SID of the Messaging Service to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
^MG[0-9a-fA-F]{32}$
34
34
DefaultApnNotificationProtocolVersion
type: stringThe protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
DefaultGcmNotificationProtocolVersion
type: stringThe protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
FcmCredentialSid
type: SID<CR>The SID of the Credential to use for FCM Bindings.
^CR[0-9a-fA-F]{32}$
34
34
DefaultFcmNotificationProtocolVersion
type: stringThe protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
LogEnabled
type: booleanWhether to log notifications. Can be: true
or false
and the default is true
.
DeliveryCallbackEnabled
type: booleanCallback configuration that enables delivery callbacks, default false
DELETE https://notify.twilio.com/v1/Services/{Sid}
Sid
type: SID<IS>The Twilio-provided string that uniquely identifies the Service resource to delete.
^IS[0-9a-fA-F]{32}$
34
34