Twilio Notify & Mobile push Service¶

Summary¶

Twilio Notify API allows sending notifications across multiple channels.
Available channels: SMS, iOS and Android mobile push notifications

This service is in Beta status from Twilio. Please review limitations at https://www.twilio.com/notify.
Before you can use this service, you need to add your twilio credentials in the service configuration. You can refer to the "configuration" section in following doc for instructions of setting your service configuration.

Operations

Configuration parameters¶

Operations¶

createBinding¶

Description

Create a binding between a device identity and a target service

Arguments

Responses

• Returns {object} when Binding posted

  Details of posted binding {object}

  Name	Type	Description
  sid	^[0-9a-zA-Z]{34}$	A 34-character string that uniquely identifies this resource.
  url	string	The URL of created Binding.
  tags	string	The list of tags associated with this Binding.
  address	string	The address specific to the channel. For APNS it is the device token.
  endpoint	string	The identifier of the endpoint to which this Binding belongs to.
  identity	string	The Identity to which this Binding belongs to.
  account_sid	^[0-9a-zA-Z]{34}$	The 34-character unique ID of Twilio account.
  service_sid	^[0-9a-zA-Z]{34}$	The 34-character unique ID of the Service of Notify API.
  binding_type	string	The type of the Binding determining the transport technology to use.
  date_created	string(date)	The date this resource was created, given in RFC 2822 format.
  date_updated	string(date)	The date this resource was updated, given in RFC 2822 format.
  credential_sid	string	The unique identifier (SID) of the Credential resource to be used to send notifications to this Binding.
  notification_protocol_version	string	The version of the protocol (data format) used to send the notification.

• Returns {object} when Error

  Request error {object}

  Name	Type	Description
  type	string	Error type
  error	string	Error message
  status	integer	Response code

Example

-- Create a binding by client-side information
local out = Twilionotify.createBinding({
  ServiceSid = "ISXXXXXXXXXXXXXXXXXXX",
  Identity = "dev00001",
  Endpoint = "dev_test_device",
  BindingType = "apn",
  Address = "apn_device_token"
})
response.message = out

deleteBinding¶

Description

Delete the binding of a service

Arguments

Responses

• Returns nil for Binding deleted

• Returns {object} when Error

  Request error {object}

  Name	Type	Description
  type	string	Error type
  error	string	Error message
  status	integer	Response code

Example

local binding = Twilionotify.deleteBinding({
  ServiceSid = "ISXXXXXXXXXXXXXXXXXXX",
  BindingSid = "BSYYYYYYYYYYYYYYYYYYY"
})
response.message = binding

getBinding¶

Description

Get the binding of a service

Arguments

Responses

• Returns {object} when Binding information

  Details of posted binding {object}

  Name	Type	Description
  sid	^[0-9a-zA-Z]{34}$	A 34-character string that uniquely identifies this resource.
  url	string	The URL of created Binding.
  tags	string	The list of tags associated with this Binding.
  address	string	The address specific to the channel. For APNS it is the device token.
  endpoint	string	The identifier of the endpoint to which this Binding belongs to.
  identity	string	The Identity to which this Binding belongs to.
  account_sid	^[0-9a-zA-Z]{34}$	The 34-character unique ID of Twilio account.
  service_sid	^[0-9a-zA-Z]{34}$	The 34-character unique ID of the Service of Notify API.
  binding_type	string	The type of the Binding determining the transport technology to use.
  date_created	string(date)	The date this resource was created, given in RFC 2822 format.
  date_updated	string(date)	The date this resource was updated, given in RFC 2822 format.
  credential_sid	string	The unique identifier (SID) of the Credential resource to be used to send notifications to this Binding.
  notification_protocol_version	string	The version of the protocol (data format) used to send the notification.

• Returns {object} when Error

  Request error {object}

  Name	Type	Description
  type	string	Error type
  error	string	Error message
  status	integer	Response code

Example

local binding = Twilionotify.getBinding({
  ServiceSid = "ISXXXXXXXXXXXXXXXXXXX",
  BindingSid = "BSYYYYYYYYYYYYYYYYYYY"
})
response.message = binding

listBinding¶

Description

List all created bindings to this service

Arguments

Responses

• Returns {object} when Binding list retrieved

  Binding list result {object}

  Name	Type	Description
  meta	object	Meta information
  meta.key	string	Key name of meta information
  meta.url	string	Current page URL
  meta.page	integer	The current page number. Zero-indexed, so the first page is 0.
  meta.page_size	integer	Number of items in this page
  meta.next_page_url	string	Next page URL
  meta.first_page_url	string	First page URL
  meta.previous_page_url	string	Previous page URL
  bindings	[ object ]	Binding list
  bindings[].sid	^[0-9a-zA-Z]{34}$	A 34-character string that uniquely identifies this resource.
  bindings[].url	string	The URL of created Binding.
  bindings[].tags	string	The list of tags associated with this Binding.
  bindings[].address	string	The address specific to the channel. For APNS it is the device token.
  bindings[].endpoint	string	The identifier of the endpoint to which this Binding belongs to.
  bindings[].identity	string	The Identity to which this Binding belongs to.
  bindings[].account_sid	^[0-9a-zA-Z]{34}$	The 34-character unique ID of Twilio account.
  bindings[].service_sid	^[0-9a-zA-Z]{34}$	The 34-character unique ID of the Service of Notify API.
  bindings[].binding_type	string	The type of the Binding determining the transport technology to use.
  bindings[].date_created	string(date)	The date this resource was created, given in RFC 2822 format.
  bindings[].date_updated	string(date)	The date this resource was updated, given in RFC 2822 format.
  bindings[].credential_sid	string	The unique identifier (SID) of the Credential resource to be used to send notifications to this Binding.
  bindings[].notification_protocol_version	string	The version of the protocol (data format) used to send the notification.

• Returns {object} when Error

  Request error {object}

  Name	Type	Description
  type	string	Error type
  error	string	Error message
  status	integer	Response code

Example

local list = Twilionotify.listBinding({
  ServiceSid = "ISXXXXXXXXXXXXXXXXXXX"
})
response.message = list

send¶

Description

Send a notification to binding channels

Arguments

Responses

• Returns {object} when Notification posted

  Details of posted notification {object}

  Name	Type	Description
  apn	string	APNS specific payload.
  fcm	string	FCM specific payload.
  gcm	string	GCM specific payload.
  sid	^[0-9a-zA-Z]{34}$	A 34-character string that uniquely identifies this resource.
  sms	string	SMS specific payload.
  ttl	string	How long (in seconds) the notification is valid and should be attempted to be delivered if the device is offline.
  body	string	Notification body text.
  data	string	Custom key-value pairs of the notification’s payload.
  tags	string	Tags used.
  sound	string	Sound to be played.
  title	string	Notification title.
  action	string	Actions to be displayed.
  priority	string	Priority of notification delivery.
  identities	string	List of Identities for which this notification is intended.
  account_sid	^[0-9a-zA-Z]{34}$	The 34-character unique ID of Twilio account.
  service_sid	^[0-9a-zA-Z]{34}$	The 34-character unique ID of the Service of Notify API.
  date_created	string(date)	The date that this resource was created, given in RFC 2822 format.
  facebook_messenger	string	Messenger specific payload (not available yet).

• Returns {object} when Error

  Request error {object}

  Name	Type	Description
  type	string	Error type
  error	string	Error message
  status	integer	Response code

Example

-- Send a notification to a device with SMS configuration.
local out = Twilionotify.send({
  ServiceSid = "ISXXXXXXXXXXXXXXXXXXX",
  Identity = "dev00001",
  Body = "Device alarm trigger for dev00001!",
  Sms = "{\"from\": \"+123456789\"}"
})
response.message = out