Twilio
App Vendor: Twilio
Connector Category: Live Chat
Connector version: 1.1.0
API Version: 1.0.0
About App
Twilio is an API to send and receive SMS, MMS, OTT messages globally. In Orchestrate, the Twilio app allows you to query metadata about your account, phone numbers, calls, text messages, and recordings.
The Twilio app is configured with Orchestrate to perform the following actions:
Action | Description |
Send SMS | This action sends an SMS to a number. |
Get SMS Details | This action retrieves the details of a particular SMS. |
List All SMS | This action lists all the SMS in your account |
Redact SMS | This action redacts the body of an SMS. |
Make a Call | This action makes a phone call via the Twilio API. |
Get Call Details | This action retrieves call details via the call SID (String Identifier). |
Configuration Parameters
The following configuration parameters are required for the Twilio app to communicate with the Twilio enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Access key | Enter the access key. | Text | Required | |
Secret key | Enter the secret key. | Text | Required | |
Sender | Enter the sender's mobile number. Example: "+16175551212" | Text | Required | Enter a plus sign (+), and then enter the country code followed by the phone number. |
Action: Send SMS
This action send an SMS to a number.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
From Number | Enter the Twilio number to use. For example: "+1xxxxxxxxxx" | Text | Required | Enter a plus sign (+), and then enter the country code followed by the phone number. |
To Number | Enter the number to send the message to. For example: "+1xxxxxxxxxx" | Text | Required | Enter a plus sign (+), and then enter the country code followed by the phone number. |
Body | Enter the body of the message. Example: "Hi, You have a new incident. Please view details." | Text | Required | |
Extra Params | Enter any extra params to pass with the request body. | Key Value | Optional | Supported Keys:
|
Example Request
[
{
"body": "Hi, You have a new incident. Please view details.",
"to_number": "+1xxxxxxxxxx",
"from_number": "+1xxxxxxxxxx"
}
]Action: Get SMS Details
This action retrieves the details of a particular SMS.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
SMS ID | Enter the SMS SID to get the details. Example: "CA612e3d042c591721087fa05aca0419b1" | Text | Required |
Example Request
[
{
"sms_id": "SM78a66b5ebae74f6ea7e1a6967877f1c7"
}
]Action: List All SMS
This action is used to list all the SMS in your account.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
Page Size | Enter the page size to list all the SMS. Example: 20 | Integer | Required | Default value: 10 |
Extra params | Enter any extra params to pass with the request URL. | Key Value | Optional | Supported Keys:
|
Example Request
[
{
"page_size": 20
}
]Action: Redact SMS
This action redacts the body of an SMS.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
SMS ID | Enter the SMS SID to redact the body. Example: "SMb8eba85358af430aac77315f9e346f10" | Text | Required | |
Message | Enter the message you want to send. Example: "Hi, You have a new incident. Please view details" | Text | Optional |
Example
[
{
"sms_id": "SMb8eba85358af430aac77315f9e346f10"
}
]Action: Make a Call
This action makes a phone call via the Twilio API
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
From Number | Enter the Twilio number to make the call from. Example: “+1xxxxxxxxxx” | Text | Required | Enter a plus sign (+), and then enter the country code followed by the phone number. |
To Number | Enter the number to call. Example: “+1xxxxxxxxxx” | Text | Required | Enter a plus sign (+), and then enter the country code followed by the phone number. |
Message | Enter the message to respond once the call is initiated. This should be in the Twilio voice format. Example: "Hi, You have a new incident. Please view details" | Text | Required | |
Extra Params | Enter any extra params to pass with the request body. | Key Value | Optional | Supported values:
|
Example Request
[
{
"message": "Hi, You have a new incident. Please view details",
"to_number": "+1xxxxxxxxxx",
"from_number": "+1xxxxxxxxxx"
}
]Action: Get Call Details
This action retrieves call details via the call SID
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
Call SID | Enter the call SID to get call details. Example: "CA612e3d042c591721087fa05aca0419b1" | Text | Required |
Example Request
[
{
"call_sid": "CA612e3d042c591721087fa05aca0419b1"
}
]