Twilio

Twilio module for RobinPath.

Package: @robinpath/twilio | Category: Utility | Type: Utility

Authentication

twilio.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the twilio module when you need to:

• sendSms -- Use twilio.sendSms to perform this operation
• sendMms -- Use twilio.sendMms to perform this operation
• listMessages -- Use twilio.listMessages to perform this operation
• getMessage -- Use twilio.getMessage to perform this operation
• makeCall -- Use twilio.makeCall to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure twilio credentials.	object
sendSms	sendSms	object
sendMms	sendMms	object
listMessages	listMessages	object
getMessage	getMessage	object
makeCall	makeCall	object
listCalls	listCalls	object
getCall	getCall	object
listPhoneNumbers	listPhoneNumbers	object
lookupPhoneNumber	lookupPhoneNumber	object
createVerifyService	createVerifyService	object
sendVerification	sendVerification	object
checkVerification	checkVerification	object
listConversations	listConversations	object
createConversation	createConversation	object
addParticipant	addParticipant	object
sendConversationMessage	sendConversationMessage	object
getAccountInfo	getAccountInfo	object
deleteMessage	deleteMessage	object

Functions

setCredentials

Configure twilio credentials.

Module: twilio | Returns: object -- API response.

twilio.setCredentials

Parameter	Type	Required	Description
accountSid	string	Yes	accountSid
authToken	string	Yes	authToken

---

sendSms

sendSms

Module: twilio | Returns: object -- API response.

twilio.sendSms

Parameter	Type	Required	Description
input	string	No	Input parameter

---

sendMms

sendMms

Module: twilio | Returns: object -- API response.

twilio.sendMms

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listMessages

listMessages

Module: twilio | Returns: object -- API response.

twilio.listMessages

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getMessage

getMessage

Module: twilio | Returns: object -- API response.

twilio.getMessage

Parameter	Type	Required	Description
input	string	No	Input parameter

---

makeCall

makeCall

Module: twilio | Returns: object -- API response.

twilio.makeCall

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listCalls

listCalls

Module: twilio | Returns: object -- API response.

twilio.listCalls

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getCall

getCall

Module: twilio | Returns: object -- API response.

twilio.getCall

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listPhoneNumbers

listPhoneNumbers

Module: twilio | Returns: object -- API response.

twilio.listPhoneNumbers

Parameter	Type	Required	Description
input	string	No	Input parameter

---

lookupPhoneNumber

lookupPhoneNumber

Module: twilio | Returns: object -- API response.

twilio.lookupPhoneNumber

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createVerifyService

createVerifyService

Module: twilio | Returns: object -- API response.

twilio.createVerifyService

Parameter	Type	Required	Description
input	string	No	Input parameter

---

sendVerification

sendVerification

Module: twilio | Returns: object -- API response.

twilio.sendVerification

Parameter	Type	Required	Description
input	string	No	Input parameter

---

checkVerification

checkVerification

Module: twilio | Returns: object -- API response.

twilio.checkVerification

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listConversations

listConversations

Module: twilio | Returns: object -- API response.

twilio.listConversations

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createConversation

createConversation

Module: twilio | Returns: object -- API response.

twilio.createConversation

Parameter	Type	Required	Description
input	string	No	Input parameter

---

addParticipant

addParticipant

Module: twilio | Returns: object -- API response.

twilio.addParticipant

Parameter	Type	Required	Description
input	string	No	Input parameter

---

sendConversationMessage

sendConversationMessage

Module: twilio | Returns: object -- API response.

twilio.sendConversationMessage

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getAccountInfo

getAccountInfo

Module: twilio | Returns: object -- API response.

twilio.getAccountInfo

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteMessage

deleteMessage

Module: twilio | Returns: object -- API response.

twilio.deleteMessage

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Twilio API error (${res.status}): ${t}	Check the error message for details
twilio.setCredentials requires accountSid, authToken.	Check the error message for details
twilio.deleteMessage requires an ID.	Check the error message for details
Twilio: "..." not configured. Call twilio.setCredentials first.	Check the error message for details

@desc "Send sms and validate result"
do
  set $result as twilio.sendSms
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Messages

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  twilio.setCredentials $token
enddo

@desc "List messages and iterate results"
do
  set $result as twilio.listMessages
  each $item in $result
    print $item
  end
enddo

2. Create a new item with sendSms

Create a new resource and capture the result.

@desc "Setup authentication"
do
  twilio.setCredentials $token
enddo

@desc "Send sms"
do
  set $result as twilio.sendSms
  print "Created: " + $result
enddo

3. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  twilio.setCredentials $token
enddo

@desc "List messages and send sms"
do
  set $existing as twilio.listMessages
  if $existing == null
    twilio.sendSms
    print "Item created"
  else
    print "Item already exists"
  end
enddo

4. Multi-step Twilio workflow

Chain multiple twilio operations together.

@desc "Setup authentication"
do
  twilio.setCredentials $token
enddo

@desc "Send sms, send mms, and more"
do
  set $r_sendSms as twilio.sendSms
  set $r_sendMms as twilio.sendMms
  set $r_listMessages as twilio.listMessages
  print "All operations complete"
enddo

5. Safe sendSms with validation

Check results before proceeding.

@desc "Setup authentication"
do
  twilio.setCredentials $token
enddo

@desc "Send sms and validate result"
do
  set $result as twilio.sendSms
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• json -- JSON module for complementary functionality