ClickSend
- Jonas Gonzalez
ClickSend is a cloud-based service that lets you send and receive SMS, Email, Voice, Fax, and Letters worldwide.
Connect ClickSend with Devo SOAR
Navigate to Automations > Integrations.
Search for ClickSend.
Click Details, then the + icon. Enter the required information in the following fields.
Label: Enter a connection name.
Reference Values: Define variables here to templatize integration connections and actions. For example, you can use https://www.{{hostname}}.com where, hostname is a variable defined in this input. For more information on how to add data, see 'Add Data' Input Type for Integrations.
Verify SSL: Select option to verify connecting server's SSL certificate (Default is Verify SSL Certificate).
Remote Agent: Run this integration using the Devo SOAR Remote Agent.
Username: Username for ClickSend.
API Key: The API key to connect to the ClickSend.
After you've entered all the details, click Connect.
Actions for ClickSend
Send SMS
Send SMS lets you send SMSs.
Input Field
Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.
Input Name | Description | Required |
|---|---|---|
Sender ID Column Name | Sender ID. | Required |
Body Column Name | The body of your message. | Required |
Recipient | Column name containing Recipient phone number in E.164 format. | Â |
Example: +14155552671. Alternatively, use 'List ID' input field to provide a List ID if sending to a whole list. | Optional | Â |
Source Column Name | Your method of sending. Leaving it blank will use 'Devo SOAR'. | Optional |
Schedule Column Name | Leave blank for immediate delivery. Your schedule time in unix format. | Optional |
Reference Column Name | Your reference. Will be passed back with all replies and delivery reports. | Optional |
List ID | Column name containing list ID if sending to a whole list. Can be used instead of 'Recipient' input field. | Optional |
Country Column Name | Recipient country. | Optional |
Return Address Column Name | An email address where the reply should be emailed to. If omitted, the reply will be emailed back to the user who sent the outgoing SMS. | Optional |
Output
A JSON object that displays the SMS delivery and status.
``` {json}{ "response_code": "SUCCESS", "data": { "total_count": 1, "_currency": { "currency_prefix_d": "$", "currency_name_long": "US Dollars", "currency_name_short": "USD", "currency_prefix_c": "¢" }, "total_price": 0, "messages": [ { "body": "", "status": "INVALID_RECIPIENT", "from": "", "schedule": "", "list_id": "", "message_id": "4C20DBBD-8FFA-4DF0-AC0E-1C69728DF11A" } ], "queued_count": 0 }, "http_code": 200, "response_msg": "Messages queued for delivery." }
## Send Email
Send Email sends transactional emails.
### Input Field
Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.
| Input Name | Description | Required |
| :------------------------------------ | :------------------------------------------------------------------------------------------------- | :------- |
| Recipients Column Name | The recipients of the email, either a single address or a JSON array of addresses. | |
| CC Column Name | The cc of the email. Follows the same structure as the recipients. | Optional |
| BCC Column Name | The bcc of the email. Follows the same structure as the recipients. | Optional |
| Sender's Email Address ID Column Name | The sender's email address ID. | |
| Sender's Name Column Name | The sender's name. | |
| Subject Column Name | The subject of the email. | |
| Body Column Name | The content of the email. | |
| Attachments Column Name | The attachments of the email (will be a JSON array of attachments, see clicksend's documentation). | Optional |
| Schedule Column Name | The schedule time for delivery. Leave blank for immediate delivery. | Optional |
### Output
A JSON object containing multiple rows of result:
- result: All required fields for email must be provided.
``` {json}{
"response_code": "BAD_REQUEST",
"data": {
"from.email_address_id": [
"The from.email address id field is required."
],
"to": [
"The to field is required."
],
"from.name": [
"The from.name field is required."
],
"body": [
"The body field is required."
],
"subject": [
"The subject field is required."
]
},
"http_code": 400,
"response_msg": "Invalid inputs."
}Release Notes
v2.0.0- Updated architecture to support IO via filesystemv1.0.9- Added documentation link in the automation library.