Twilio SMS and Call management Service¶

Summary¶

Use Twilio to send SMS notifications and make calls.

This service provides integration with Twilio to allow your Murano solution to send SMS messages or make calls.

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¶

createCall¶

Description

Make a phone call

Arguments

Responses

• Returns {object} when Call created

  A Call details {object}

  Name	Type	Description
  to	string(E.164)	The destination phone number. Format with a '+' and country code e.g., +16175551212 (E.164 format).
  sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  uri	string(uri)	The URI for this resource, relative to https://api.twilio.com
  from	string(E.164)	A Twilio phone number (in E.164 format) or alphanumeric sender ID enabled for the type of message you wish to send
  price	^-?[0-9]*.?[0-9]*$	The amount billed for the call, in the currency associated with the account.
  status	"queued", "ringing", "in-progress", "canceled", "completed", "failed", "busy", "no-answer"	The status of this message.
  duration	integer	The length of the call in seconds.
  end_time	string(date-time)	The end time of the call, given as GMT in RFC 2822 format.
  direction	"inbound", "outbound-api", "outbound-dial"	The direction of this message.
  price_unit	string(ISO 4127)	The currency in which Price is measured, in ISO 4127 format (e.g., usd, eur, jpy).
  start_time	string(date-time)	The start time of the call, given as GMT in RFC 2822 format.
  account_sid	^[0-9a-zA-Z]{34}$	The 34 character unique ID of the Messaging Service you want to associate with this Message.
  answered_by	"human", "machine"	If this call was initiated with answering machine detection.
  api_version	string(date)	The version of the Twilio API used to process the message.
  caller_name	string	If this call was an incoming call to a phone number with Caller ID Lookup enabled, the caller's name.
  date_created	string(date)	The date that this resource was created, given in RFC 2822 format.
  date_updated	string(date)	The date that this resource was last updated, given in RFC 2822 format.
  formatted_to	string	Formatted To
  formatted_from	string	Formatted From
  forwarded_from	string	If this call was an incoming call forwarded from another number, the forwarding phone number.
  parent_call_sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  phone_number_sid	^[0-9a-zA-Z]{34}$	If the call was inbound, this is the Sid of the IncomingPhoneNumber that received the call.
  subresource_uris	object	The URIs for any sub-resources associate with this resource, relative to https://api.twilio.com

• Returns {object} when Error

  Request error {object}

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

Example

-- you need to provide a url that has the predefined TwiML files -- for reference - https://www.twilio.com/docs/api/twiml
local out = Twilio.createCall({
  From = "+15555555550",
  To = "+15555555555",
  Url = "https://your-app-example.apps.exosite.io/twiml"
})
response.message = out

deleteCall¶

Description

Delete a call

Arguments

Responses

• Returns nil for Call deleted

• Returns {object} when Error

  Request error {object}

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

Example

-- get a list of call records
local list = Twilio.listCall()
local calls = list.calls

-- get CallSid of the first call
local first_call_sid = calls[1].sid

-- use CallSid as argument to delete the record of first call
local out = Twilio.deleteCall({CallSid = first_call_sid})
response.message = out

getCall¶

Description

Returns the call details

Arguments

Responses

• Returns {object} when Call information retrieved

  A Call details {object}

  Name	Type	Description
  to	string(E.164)	The destination phone number. Format with a '+' and country code e.g., +16175551212 (E.164 format).
  sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  uri	string(uri)	The URI for this resource, relative to https://api.twilio.com
  from	string(E.164)	A Twilio phone number (in E.164 format) or alphanumeric sender ID enabled for the type of message you wish to send
  price	^-?[0-9]*.?[0-9]*$	The amount billed for the call, in the currency associated with the account.
  status	"queued", "ringing", "in-progress", "canceled", "completed", "failed", "busy", "no-answer"	The status of this message.
  duration	integer	The length of the call in seconds.
  end_time	string(date-time)	The end time of the call, given as GMT in RFC 2822 format.
  direction	"inbound", "outbound-api", "outbound-dial"	The direction of this message.
  price_unit	string(ISO 4127)	The currency in which Price is measured, in ISO 4127 format (e.g., usd, eur, jpy).
  start_time	string(date-time)	The start time of the call, given as GMT in RFC 2822 format.
  account_sid	^[0-9a-zA-Z]{34}$	The 34 character unique ID of the Messaging Service you want to associate with this Message.
  answered_by	"human", "machine"	If this call was initiated with answering machine detection.
  api_version	string(date)	The version of the Twilio API used to process the message.
  caller_name	string	If this call was an incoming call to a phone number with Caller ID Lookup enabled, the caller's name.
  date_created	string(date)	The date that this resource was created, given in RFC 2822 format.
  date_updated	string(date)	The date that this resource was last updated, given in RFC 2822 format.
  formatted_to	string	Formatted To
  formatted_from	string	Formatted From
  forwarded_from	string	If this call was an incoming call forwarded from another number, the forwarding phone number.
  parent_call_sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  phone_number_sid	^[0-9a-zA-Z]{34}$	If the call was inbound, this is the Sid of the IncomingPhoneNumber that received the call.
  subresource_uris	object	The URIs for any sub-resources associate with this resource, relative to https://api.twilio.com

• Returns {object} when Error

  Request error {object}

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

Example

-- get a list of call records
local list = Twilio.listCall()
local calls = list.calls

-- get CallSid of the first call
local first_call_sid = calls[1].sid

-- use CallSid as argument for getCall -- to get the details of the call
local out = Twilio.getCall({CallSid = first_call_sid})
response.message = out

listCall¶

Description

List all calls on Twilio.

Arguments

Responses

• Returns {object} for List call results

  Name	Type	Description
  uri	string(uri)	Current page URI
  page	integer	The current page number. Zero-indexed, so the first page is 0.
  calls	[ object ]	Call list
  calls[].to	string(E.164)	The destination phone number. Format with a '+' and country code e.g., +16175551212 (E.164 format).
  calls[].sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  calls[].uri	string(uri)	The URI for this resource, relative to https://api.twilio.com
  calls[].from	string(E.164)	A Twilio phone number (in E.164 format) or alphanumeric sender ID enabled for the type of message you wish to send
  calls[].price	^-?[0-9]*.?[0-9]*$	The amount billed for the call, in the currency associated with the account.
  calls[].status	"queued", "ringing", "in-progress", "canceled", "completed", "failed", "busy", "no-answer"	The status of this message.
  calls[].duration	integer	The length of the call in seconds.
  calls[].end_time	string(date-time)	The end time of the call, given as GMT in RFC 2822 format.
  calls[].direction	"inbound", "outbound-api", "outbound-dial"	The direction of this message.
  calls[].price_unit	string(ISO 4127)	The currency in which Price is measured, in ISO 4127 format (e.g., usd, eur, jpy).
  calls[].start_time	string(date-time)	The start time of the call, given as GMT in RFC 2822 format.
  calls[].account_sid	^[0-9a-zA-Z]{34}$	The 34 character unique ID of the Messaging Service you want to associate with this Message.
  calls[].answered_by	"human", "machine"	If this call was initiated with answering machine detection.
  calls[].api_version	string(date)	The version of the Twilio API used to process the message.
  calls[].caller_name	string	If this call was an incoming call to a phone number with Caller ID Lookup enabled, the caller's name.
  calls[].date_created	string(date)	The date that this resource was created, given in RFC 2822 format.
  calls[].date_updated	string(date)	The date that this resource was last updated, given in RFC 2822 format.
  calls[].formatted_to	string	Formatted To
  calls[].formatted_from	string	Formatted From
  calls[].forwarded_from	string	If this call was an incoming call forwarded from another number, the forwarding phone number.
  calls[].parent_call_sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  calls[].phone_number_sid	^[0-9a-zA-Z]{34}$	If the call was inbound, this is the Sid of the IncomingPhoneNumber that received the call.
  calls[].subresource_uris	object	The URIs for any sub-resources associate with this resource, relative to https://api.twilio.com
  page_size	integer	Number of items in this page
  next_page_uri	string,null(uri)	Next page URI
  first_page_uri	string,null(uri)	First page URI
  previous_page_uri	string,null(uri)	Previous page URI

• Returns {object} when Error

  Request error {object}

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

Example

local out = Twilio.listCall()
response.message = out

deleteMedia¶

Description

Delete a media

Arguments

Responses

• Returns nil for Media deleted

• Returns {object} when Error

  Request error {object}

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

Example

-- delete a media from a message
local out = Twilio.deleteMedia({MessageSid = "xxxx", MediaSid = "yyyy"})
response.message = out

getMedia¶

Description

Returns the media details

Arguments

Responses

• Returns {object} when Media information retrieved

  The SMS media in Twilio {object}

  Name	Type	Description
  sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  uri	string(uri)	The URI for this resource, relative to https://api.twilio.com
  parent_sid	^[0-9a-zA-Z]{34}$	The unique ID of the resource that created the media.
  account_sid	^[0-9a-zA-Z]{34}$	The 34 character unique ID of the Messaging Service you want to associate with this Media.
  content_type	string(mime-type)	The default mime-type of the media, for example image/jpeg, image/png, or image/gif
  date_created	string(date)	The date that this resource was created, given in RFC 2822 format.
  date_updated	string(date)	The date that this resource was last updated, given in RFC 2822 format.

• Returns {object} when Error

  Request error {object}

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

Example

-- get media from a message
local out = Twilio.getMedia({MessageSid = "xxxx", MediaSid = "yyyy"})
response.message = out

listMedia¶

Description

List all SMS media on Twilio

Arguments

Responses

• Returns {object} for Media list result

  Name	Type	Description
  uri	string(uri)	Current page URI
  page	integer	The current page number. Zero-indexed, so the first page is 0.
  page_size	integer	Number of items in this page
  media_list	[ object ]	Media list
  media_list[].sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  media_list[].uri	string(uri)	The URI for this resource, relative to https://api.twilio.com
  media_list[].parent_sid	^[0-9a-zA-Z]{34}$	The unique ID of the resource that created the media.
  media_list[].account_sid	^[0-9a-zA-Z]{34}$	The 34 character unique ID of the Messaging Service you want to associate with this Media.
  media_list[].content_type	string(mime-type)	The default mime-type of the media, for example image/jpeg, image/png, or image/gif
  media_list[].date_created	string(date)	The date that this resource was created, given in RFC 2822 format.
  media_list[].date_updated	string(date)	The date that this resource was last updated, given in RFC 2822 format.
  next_page_uri	string,null(uri)	Next page URI
  first_page_uri	string,null(uri)	First page URI
  previous_page_uri	string,null(uri)	Previous page URI

• Returns {object} when Error

  Request error {object}

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

Example

-- get a list of messages
local list = Twilio.listMessage()
local messages = list.messages

-- get MessageSid of the first message
local first_msg_sid = messages[1].sid

-- use MessageSid as argument to get media list of the message
local out = Twilio.listMedia({MessageSid = first_msg_sid})
response.message = out

deleteMessage¶

Description

Delete a message

Arguments

Responses

• Returns nil for Message deleted

• Returns {object} when Error

  Request error {object}

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

Example

-- get a list of messages
local list = Twilio.listMessage()
local messages = list.messages

-- get the MessageSid of the first message
local first_msg_sid = messages[1].sid

-- use MessageSid as argument to delete the first message
local out = Twilio.deleteMessage({MessageSid = first_msg_sid})
response.message = out

getMessage¶

Description

Returns the message details

Arguments

Responses

• Returns {object} when Message information retrieved

  The SMS message in Twilio {object}

  Name	Type	Description
  to	string(E.164)	The destination phone number. Format with a '+' and country code e.g., +16175551212 (E.164 format).
  sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  uri	string(uri)	The URI for this resource, relative to https://api.twilio.com
  body	string	The text of the message you want to send, limited to 1600 characters.
  from	string(E.164)	A Twilio phone number (in E.164 format) or alphanumeric sender ID enabled for the type of message you wish to send
  price	^-?[0-9]*.?[0-9]*$	The amount billed for the message, in the currency associated with the account.
  status	"accepted", "queued", "sending", "sent", "failed", "delivered", "undelivered", "receiving", "received"	The status of this message.
  date_sent	string(date)	The date that the message was sent or received, given in RFC 2822 format.
  direction	"inbound", "outbound-api", "outbound-call", "outbound-reply"	The direction of this message.
  num_media	string(integer)	This property indicates the number of media files associated with the message. Each message may send up to 10 media files.
  error_code	string	The error code, if any, associated with your message. If your message status is failed or undelivered, the ErrorCode can give you more information about the failure.
  price_unit	string(ISO 4127)	The currency in which Price is measured, in ISO 4127 format (e.g., usd, eur, jpy).
  account_sid	^[0-9a-zA-Z]{34}$	The 34 character unique ID of the Messaging Service you want to associate with this Message.
  api_version	string(date)	The version of the Twilio API used to process the message.
  date_created	string(date)	The date that this resource was created, given in RFC 2822 format.
  date_updated	string(date)	The date that this resource was last updated, given in RFC 2822 format.
  num_segments	string(integer)	This property indicates the number of segments that make up the message. If your body is too large to be sent as a single SMS message, it will be segmented and charged accordingly.
  error_message	string	The human readable description of the ErrorCode above.
  subresource_uri	string(uri)	The URIs for any sub-resources associate with this resource, relative to https://api.twilio.com
  MessagingServiceSid	^[0-9a-zA-Z]{34}$	The unique ID of the Messaging Service used with the message.

• Returns {object} when Error

  Request error {object}

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

Example

-- get a list of messages
local list = Twilio.listMessage()
local messages = list.messages

-- get MessageSid of the first message
local first_msg_sid = messages[1].sid

-- use MessageSid as the argument to getMessage
-- to get details about the message
local out = Twilio.getMessage({MessageSid = first_msg_sid})
response.message = out

listMessage¶

Description

List all SMS messages on Twilio

Arguments

Responses

• Returns {object} for Message list result

  Name	Type	Description
  uri	string(uri)	Current page URI
  page	integer	The current page number. Zero-indexed, so the first page is 0.
  messages	[ object ]	Message list
  messages[].to	string(E.164)	The destination phone number. Format with a '+' and country code e.g., +16175551212 (E.164 format).
  messages[].sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  messages[].uri	string(uri)	The URI for this resource, relative to https://api.twilio.com
  messages[].body	string	The text of the message you want to send, limited to 1600 characters.
  messages[].from	string(E.164)	A Twilio phone number (in E.164 format) or alphanumeric sender ID enabled for the type of message you wish to send
  messages[].price	^-?[0-9]*.?[0-9]*$	The amount billed for the message, in the currency associated with the account.
  messages[].status	"accepted", "queued", "sending", "sent", "failed", "delivered", "undelivered", "receiving", "received"	The status of this message.
  messages[].date_sent	string(date)	The date that the message was sent or received, given in RFC 2822 format.
  messages[].direction	"inbound", "outbound-api", "outbound-call", "outbound-reply"	The direction of this message.
  messages[].num_media	string(integer)	This property indicates the number of media files associated with the message. Each message may send up to 10 media files.
  messages[].error_code	string	The error code, if any, associated with your message. If your message status is failed or undelivered, the ErrorCode can give you more information about the failure.
  messages[].price_unit	string(ISO 4127)	The currency in which Price is measured, in ISO 4127 format (e.g., usd, eur, jpy).
  messages[].account_sid	^[0-9a-zA-Z]{34}$	The 34 character unique ID of the Messaging Service you want to associate with this Message.
  messages[].api_version	string(date)	The version of the Twilio API used to process the message.
  messages[].date_created	string(date)	The date that this resource was created, given in RFC 2822 format.
  messages[].date_updated	string(date)	The date that this resource was last updated, given in RFC 2822 format.
  messages[].num_segments	string(integer)	This property indicates the number of segments that make up the message. If your body is too large to be sent as a single SMS message, it will be segmented and charged accordingly.
  messages[].error_message	string	The human readable description of the ErrorCode above.
  messages[].subresource_uri	string(uri)	The URIs for any sub-resources associate with this resource, relative to https://api.twilio.com
  messages[].MessagingServiceSid	^[0-9a-zA-Z]{34}$	The unique ID of the Messaging Service used with the message.
  page_size	integer	Number of items in this page
  next_page_uri	string,null(uri)	Next page URI
  first_page_uri	string,null(uri)	First page URI
  previous_page_uri	string,null(uri)	Previous page URI

• 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 = Twilio.listMessage()
response.message = list

postMessage¶

Description

Send an SMS message

Arguments

Responses

• Returns {object} when Message posted

  The SMS message in Twilio {object}

  Name	Type	Description
  to	string(E.164)	The destination phone number. Format with a '+' and country code e.g., +16175551212 (E.164 format).
  sid	^[0-9a-zA-Z]{34}$	A 34 character string that uniquely identifies this resource.
  uri	string(uri)	The URI for this resource, relative to https://api.twilio.com
  body	string	The text of the message you want to send, limited to 1600 characters.
  from	string(E.164)	A Twilio phone number (in E.164 format) or alphanumeric sender ID enabled for the type of message you wish to send
  price	^-?[0-9]*.?[0-9]*$	The amount billed for the message, in the currency associated with the account.
  status	"accepted", "queued", "sending", "sent", "failed", "delivered", "undelivered", "receiving", "received"	The status of this message.
  date_sent	string(date)	The date that the message was sent or received, given in RFC 2822 format.
  direction	"inbound", "outbound-api", "outbound-call", "outbound-reply"	The direction of this message.
  num_media	string(integer)	This property indicates the number of media files associated with the message. Each message may send up to 10 media files.
  error_code	string	The error code, if any, associated with your message. If your message status is failed or undelivered, the ErrorCode can give you more information about the failure.
  price_unit	string(ISO 4127)	The currency in which Price is measured, in ISO 4127 format (e.g., usd, eur, jpy).
  account_sid	^[0-9a-zA-Z]{34}$	The 34 character unique ID of the Messaging Service you want to associate with this Message.
  api_version	string(date)	The version of the Twilio API used to process the message.
  date_created	string(date)	The date that this resource was created, given in RFC 2822 format.
  date_updated	string(date)	The date that this resource was last updated, given in RFC 2822 format.
  num_segments	string(integer)	This property indicates the number of segments that make up the message. If your body is too large to be sent as a single SMS message, it will be segmented and charged accordingly.
  error_message	string	The human readable description of the ErrorCode above.
  subresource_uri	string(uri)	The URIs for any sub-resources associate with this resource, relative to https://api.twilio.com
  MessagingServiceSid	^[0-9a-zA-Z]{34}$	The unique ID of the Messaging Service used with the message.

• Returns {object} when Error

  Request error {object}

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

Example

-- send an SMS message to a phone number
local out = Twilio.postMessage({
  From = "+16125550923",
  To = "+17635551234",
  Body = "Your device is in an error state."
})
response.message = out

createToken¶

Description

Network Traversal Service Tokens are ephemeral credentials that let you access TURN resources from WebRTC and VoIP clients. It also provide STUN service.

Arguments

Responses

• Returns {object} when Returns tokens

  A Token instance resource has the following properties. {object}

  Name	Type	Description
  Ttl	integer	The duration in seconds for which the username and password are valid. Default: 86400
  Password	string	The temporary password that the username will use when authenticating with Twilio.
  Username	string	The temporary username that uniquely identifies a Token.
  AccountSid	string	The unique id of the Account that created this Token.
  IceServers	array	An array representing the ephemeral credentials and the STUN and TURN server URIs.
  DateCreated	string(date)	The date that this resource was created, given in RFC 2822 format.
  DateUpdated	string(date)	The date that this resource was last updated, given in RFC 2822 format.

• Returns {object} when Error

  Request error {object}

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

Example

-- get network traversal service tokens
local out = Twilio.createToken({
  Ttl = 3600
})
response.message = out