...
This Universal Extension allows to send SMS/WhatsApp/Voice message to a list of recipients.
Version Information
| Template Name | Extension Name | Extension Version |
|---|---|---|
| Twilio | ue-twilio | 1.0.0 |
Refer to Changelog for version history information.
...
The input fields for this Universal Extension are described below.
| Field | Input type | Default value | Type | Description |
|---|---|---|---|---|
| Action | Required | Send SMS Message | Choice | Αction performed upon the task execution. Available actions are listed below.
|
| Twilio Credentials | Required | - | Credentials | The Credentials definition should be as follows.
|
| Sender | Required | - | Text | Senders identifier (phone number) in E.164 format. |
| Recipient List | Required | - | Large Text | A list of message Recipient identifiers (phone numbers) , separated by comma. E.164 format. Max characters: 4000 |
| Message | Required | - | Large Text | Body of the message.
|
| Answer Timeout | Optional | 30 | Integer | Max wait time until a call is answered in seconds.
On average 3-5 seconds are consumed until the phone starts ringing. So estimate respectively. Required when Action = "Send Voice Message". |
| Call Max Duration | Optional | 60 | Integer | Maximum talk time per call in seconds.
Required when Action = "Send Voice Message". |
| Proxy Type | Optional | -- None-- | Choice | Type of proxy connection to be used. Available options listed below.
|
| Proxy | Optional | - | Text | Proxy server in the following format: http://proxyip:port or https://proxyip:port. Required when Proxy Type is not "-- None --". |
| Proxy CA Bundle File | Optional | - | Text | The path to a custom certificate bundle to use when establishing SSL/TLS connections with proxy. The Bundle needs to include certificates for both proxy and Twilio sites. Used when Proxy Type is configured for "HTTPS" or "HTTPS With Credentials". |
| Proxy Credentials | Optional | - | Credentials | The Credentials definition should be as follows.
|
Task Examples
Send SMS Message to one recipient
Send WhatsApp Message to a list of recipients with HTTPS Proxy
Send Voice Message with HTTPS With Credentials Proxy
Task Output
Exit Codes
The exit codes for this Universal Extension are described below.
| Exit Code | Status Classification Code | Status Classification Description | Status Description |
|---|---|---|---|
| 0 | SUCCESS | Successful Execution | SUCCESS: Task executed successfully. |
| 1 | FAIL | Failed Execution | FAIL: < Error Description >. |
| 2 | AUTHENTICATION_ERROR | Bad credentials | AUTHENTICATION_ERROR: Account cannot be authenticated. < Error Details >. |
| 3 | AUTHORIZATION_ERROR | Insufficient Permissions | AUTHORIZATION_ERROR: Account is not authorized to perform the requested action. < Error Details >. |
| 10 | CONNECTION_ERROR | Bad connection data or connection timed out | CONNECTION_ERROR: < Error Description >. |
| 20 | DATA_VALIDATION_ERROR | Input fields validation error | DATA_VALIDATION_ERROR: < Error Description >. |
| 21 | FAIL | Not all messages were queued | FAIL: Some messages were not possible to be queued. Check STDERR for more information. |
Extension Output
In the context of a workflow, subsequent tasks can rely on the information provided by this integration as Extension Output.
...
result section includes the following attributes:
| Attribute | Type | Description |
|---|---|---|
| stats | object | Object with the statistics of the queued messages to Twilio with "Success" or "Failure". |
| msg_queued_count | number | Number of messages successfully queued to Twilio. Part of stats array. |
| msg_failed_count | number | Number of messages failed to queue to Twilio Part of stats array. |
Extension Output on "Cancel" command execution, is supported for Universal Agent 7.3 and above.
...
This document references the following documents.
| Document Link | Description |
|---|---|
| Universal Templates | User documentation for creating, working with and understanding Universal Templates and Integrations. |
| Universal Tasks | User documentation for creating Universal Tasks in the Universal Controller user interface. |
| Credentials | User documentation for creating and working with credentials. |
| Resolvable Credentials Permitted Property | User documentation for Resolvable Credentials Permitted Property. |
Changelog
ue-twilio-1.0.0 (YYYY-MM-DD)
...