Twilio SMS and Call Service

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 credentails in the service configuration. You can refer to the "configuration" section in following doc for instructions of setting your service configuration - http://docs.exosite.com/reference/ui/send-notifications/.

Operations

Calls

• Twilio.createCall() - create call
• Twilio.deleteCall() - delete a call
• Twilio.getCall() - get a call
• Twilio.listCall() - list calls

Media

• Twilio.deleteMedia() - delete a media
• Twilio.getMedia() - get a media
• Twilio.listMedia() - get a list of media from a message

Messages

• Twilio.deleteMessage() - delete a message
• Twilio.getMessage() - get a message
• Twilio.listMessage() - list messages
• Twilio.postMessage() - send an SMS message

Tokens

• Twilio.createToken() - create network traversal service tokens

Operations

Calls

createCall

Make a phone call

Arguments

parameters - object - Object containing service call parameters.

Responses

Call created

Content: object A Call details

Error

Content: object Request error

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 = "+16123409875",
  To = "+886912345678",
  Url = "https://markpeng-test01.apps.exosite-dev.io/twiml"
})
response.message = out

deleteCall

Delete a call

Responses

Call deleted

Content: nil

Error

Content: object Request error

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

Returns the call details

Responses

Call information retrieved

Content: object A Call details

Error

Content: object Request error

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

List all calls on Twilio.

Arguments

parameters - object - Object containing service call parameters.

Responses

List call results

Content: object

Error

Content: object Request error

Example

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

Media

deleteMedia

Delete a media

Responses

Media deleted

Content: nil

Error

Content: object Request error

Example

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

getMedia

Returns the media details

Responses

Media information retrieved

Content: object The SMS media in Twilio

Error

Content: object Request error

Example

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

listMedia

List all SMS media on Twilio

Arguments

parameters - object - Object containing service call parameters.

Responses

Media list result

Content: object

Error

Content: object Request error

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

Messages

deleteMessage

Delete a message

Responses

Message deleted

Content: nil

Error

Content: object Request error

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

Returns the message details

Responses

Message information retrieved

Content: object The SMS message in Twilio

Error

Content: object Request error

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

List all SMS messages on Twilio

Arguments

parameters - object - Object containing service call parameters.

Responses

Message list result

Content: object

Error

Content: object Request error

Example

local list = Twilio.listMessage()
response.message = list

postMessage

Send an SMS message

Arguments

parameters - object - Object containing service call parameters.

Responses

Message posted

Content: object The SMS message in Twilio

Error

Content: object Request error

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

Tokens

createToken

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

Arguments

parameters - object - Object containing service call parameters.

Responses

Returns tokens

Content: object A Token instance resource has the following properties.

Error

Content: object Request error

Example

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