Create service

POST /v1/Services

Account sid auth token

application/x-www-form-urlencoded

Body

FriendlyName string

A descriptive string that you create to describe the resource. It can be up to 64 characters long.
ApnCredentialSid string

The SID of the Credential to use for APN Bindings.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CR[0-9a-fA-F]{32}$.
GcmCredentialSid string

The SID of the Credential to use for GCM Bindings.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CR[0-9a-fA-F]{32}$.
MessagingServiceSid string

The SID of the Messaging Service to use for SMS Bindings. This parameter must be set in order to send SMS notifications.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.
FacebookMessengerPageId string

Deprecated.
DefaultApnNotificationProtocolVersion string

The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
DefaultGcmNotificationProtocolVersion string

The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
FcmCredentialSid string

The SID of the Credential to use for FCM Bindings.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CR[0-9a-fA-F]{32}$.
DefaultFcmNotificationProtocolVersion string

The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
LogEnabled boolean

Whether to log notifications. Can be: true or false and the default is true.
AlexaSkillId string

Deprecated.
DefaultAlexaNotificationProtocolVersion string

Deprecated.
DeliveryCallbackUrl string

URL to send delivery status callback.
DeliveryCallbackEnabled boolean

Callback configuration that enables delivery callbacks, default false

Responses

201 application/json

Created
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- sid string | null
  
  The unique string that we created to identify the Service resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
- account_sid string | null
  
  The SID of the Account that created the Service resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- friendly_name string | null
  
  The string that you assigned to describe the resource.
- date_created string(date-time) | null
  
  The date and time in GMT when the resource was created specified in RFC 2822 format.
- date_updated string(date-time) | null
  
  The date and time in GMT when the resource was last updated specified in RFC 2822 format.
- apn_credential_sid string | null
  
  The SID of the Credential to use for APN Bindings.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CR[0-9a-fA-F]{32}$.
- gcm_credential_sid string | null
  
  The SID of the Credential to use for GCM Bindings.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CR[0-9a-fA-F]{32}$.
- fcm_credential_sid string | null
  
  The SID of the Credential to use for FCM Bindings.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CR[0-9a-fA-F]{32}$.
- messaging_service_sid string | null
  
  The SID of the Messaging Service to use for SMS Bindings. In order to send SMS notifications this parameter has to be set.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.
- facebook_messenger_page_id string | null
  
  Deprecated.
- default_apn_notification_protocol_version string | null
  
  The 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 string | null
  
  The 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 string | null
  
  The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.
- log_enabled boolean | null
  
  Whether to log notifications. Can be: true or false and the default is true.
- url string(uri) | null
  
  The absolute URL of the Service resource.
- links object(uri-map) | null
  
  The URLs of the Binding, Notification, Segment, and User resources related to the service.
- alexa_skill_id string | null
  
  Deprecated.
- default_alexa_notification_protocol_version string | null
  
  Deprecated.
- delivery_callback_url string | null
  
  URL to send delivery status callback.
- delivery_callback_enabled boolean | null
  
  Callback configuration that enables delivery callbacks, default false

POST /v1/Services

curl \
 --request POST 'https://notify.twilio.com/v1/Services' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Type=S&LogEnabled=True&FriendlyName=friendly_name&ApnCredentialSid=CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&GcmCredentialSid=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DeliveryCallbackUrl=Hello&MessagingServiceSid=MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DeliveryCallbackEnabled=True&FacebookMessengerPageId=4&DefaultApnNotificationProtocolVersion=3&DefaultFcmNotificationProtocolVersion=3&DefaultGcmNotificationProtocolVersion=3'

Request example

{"Type"=>"S", "LogEnabled"=>"True", "FriendlyName"=>"friendly_name", "ApnCredentialSid"=>"CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "GcmCredentialSid"=>"ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "DeliveryCallbackUrl"=>"Hello", "MessagingServiceSid"=>"MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "DeliveryCallbackEnabled"=>"True", "FacebookMessengerPageId"=>"4", "DefaultApnNotificationProtocolVersion"=>"3", "DefaultFcmNotificationProtocolVersion"=>"3", "DefaultGcmNotificationProtocolVersion"=>"3"}

Response examples (201)

{
  "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "type": "S",
  "links": {
    "users": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users",
    "bindings": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings",
    "segments": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments",
    "notifications": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications"
  },
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "log_enabled": true,
  "date_created": "2016-03-09T20:22:31Z",
  "date_updated": "2016-03-09T20:22:31Z",
  "friendly_name": "733c7f0f-6541-42ec-84ce-e2ae1cac588c",
  "alexa_skill_id": null,
  "apn_credential_sid": null,
  "fcm_credential_sid": null,
  "gcm_credential_sid": null,
  "delivery_callback_url": "Hello",
  "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "delivery_callback_enabled": true,
  "facebook_messenger_page_id": "4",
  "default_apn_notification_protocol_version": "3",
  "default_fcm_notification_protocol_version": "3",
  "default_gcm_notification_protocol_version": "3",
  "default_alexa_notification_protocol_version": "3"
}