ClickSend SMS
ClickSend for business SMS that gets delivered; alerts, notifications, invites, marketing messages and more. ClickSend is business communications software enabling companies of all shapes and sizes to easily send and receive SMS, Email, Voice and even post worldwide via web app or API. ClickSend has SMS at its core and powers billions of messages worldwide via direct routes but has expanded to offer a full suite of products providing choice and context to your business communications.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | ClickSend SMS Support |
| URL | https://www.clicksend.com/au/help |
| Support@clicksend.com |
| Connector Metadata | |
|---|---|
| Publisher | ClickSend SMS |
| Website | https://www.clicksend.com |
| Privacy policy | https://www.clicksend.com/us/legal/privacy-policy |
| Categories | Communication;Marketing |
With ClickSend SMS connector, users can have the ability to send business messages, notifications, alerts and invites through SMS, MMS, Voice, Fax and Posts worldwide when a connector trigger takes place. Also we have an Inbound SMS Trigger that users can connect to other hundreds of unique connector actions. ClickSend SMS connector can work too with Built-in actions and triggers.
Prerequisites
You will need a ClickSend account to be able to use ClickSend SMS connector and build workflows with it. They will need to sign up first on ClickSend website: https://clicksend.com/signup And then we�ll give them test credits for testing purposes. Once these credits run out, they can purchase a credit package here under Billing section of their account: https://dashboard.clicksend.com/#/account/billing-recharge/top-up-account so they can continue sending messages. ClickSend is a free integration and we only charge users for their sent messages.
How to get credentials?
They will need to create a ClickSend account. They can sign up here: https://clicksend.com/signup When an account is created, API credentials are generated for them. The API credentials are found inside the account under �API Credentials� page: https://dashboard.clicksend.com/#/account/subaccount
Help article on where to get credentials and how to connect the ClickSend is found here: https://help.clicksend.com/article/zasfmfisot-how-to-connect-click-send-account-to-microsoft-power-automate
Known issues and limitations
Restrictions:
- Send SMS - can only send up to 1,224 characters.
- Send SMS, MMS,Fax and Voice are sent from our Numbers. Cannot modify the Sender number at the moment
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Username | securestring | The Username for this api | True |
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Convert Media File Format |
Convert Media File Format |
| Create New Contact |
Create New Contact |
| Create New Contact List |
Create New Contact List |
| Delete a Contact |
Delete a Contact |
| Delete List |
Delete a specific contact list |
| Get Contact Lists |
Get all contact lists unless specified in the advance options |
| Get Contacts in a List |
Get all Contacts in a List |
| Search Contact Lists |
Get list of searched contact list |
| Send Fax |
Send Fax |
| Send Letter |
Send Letter |
| Send MMS |
Send MMS |
| Send Postcard |
Send one or more postcards |
| Send SMS |
Each 160 characters = 1 SMS. Can send up to 1,224 standard characters. |
| Send Voice Message |
Each 300 characters = 1 voice message. Can send up to 1,200 standard characters |
Convert Media File Format
Convert Media File Format
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Select action the file is needed for
|
convert | True | string |
Select action the file is needed for |
|
File
|
content | True | byte |
File Content (base64) |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
Upload ID
|
data.upload_id | integer |
Upload ID |
|
File Name
|
data.file_name | string |
File Name |
|
Date Added
|
data.date_added | integer |
Date Added |
|
Date Delete
|
data.date_delete | integer |
Date Delete |
|
User ID
|
data.user_id | integer |
User ID |
|
Url
|
data._url | string |
Url |
Create New Contact
Create New Contact
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List ID
|
list_id | True | integer |
You may use the Search Contact List action OR Get Contact List action to get the List ID |
|
First Name
|
first_name | True | string |
Contact's first name. |
|
Last Name
|
last_name | True | string |
Contact's last name. |
|
Phone Number
|
phone_number | True | string |
The contact phone in local or international format e.g. +61411111111. |
|
Email
|
string |
Contact's email address. |
||
|
Fax Number
|
fax_number | string |
Contact's fax number. |
|
|
Organization Name
|
organization_name | string |
Contact's organization name. |
|
|
Country
|
address_country | string |
The contact's country. |
|
|
State
|
address_state | string |
State |
|
|
City
|
address_city | string |
Address City |
|
|
Custom 1
|
custom_1 | string |
Custom 1 |
|
|
Custom 3
|
custom_3 | string |
Custom 3 |
|
|
Postal Code
|
address_postal_code | string | ||
|
Custom 2
|
custom_2 | string |
Custom 2 |
|
|
Custom 4
|
custom_4 | string |
Custom 4 |
|
|
Address Line 1
|
address_line_1 | string |
Address Line 1 |
|
|
Address Line 2
|
address_line_2 | string |
Address Line 2 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
Contact ID
|
data.contact_id | integer |
Contact ID |
|
List ID
|
data.list_id | integer |
List ID |
|
Phone Number
|
data.phone_number | string |
Phone Number |
|
First Name
|
data.first_name | string |
First Name |
|
Last Name
|
data.last_name | string |
Last Name |
|
Custom 1
|
data.custom_1 | string |
Custom 1 |
|
Custom 2
|
data.custom_2 | string |
Custom 2 |
|
Custom 3
|
data.custom_3 | string |
Custom 3 |
|
Custom 4
|
data.custom_4 | string |
Custom 4 |
|
Date Added
|
data.date_added | integer |
Date Added |
|
Fax Number
|
data.fax_number | string |
Fax Number |
|
Organization Name
|
data.organization_name | string |
Organization Name |
|
Email
|
data.email | string |
|
|
Address Line 1
|
data.address_line_1 | string |
Address Line 1 |
|
Address Line 2
|
data.address_line_2 | string |
Address Line 2 |
|
Address City
|
data.address_city | string |
Address City |
|
Address State
|
data.address_state | string |
Address State |
|
Address Postal Code
|
data.address_postal_code | string |
Address Postal Code |
|
Address Country
|
data.address_country | string |
Address Country |
|
List Name
|
data._list_name | string |
List Name |
Create New Contact List
Create New Contact List
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Name
|
list_name | True | string |
Your contact list name |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
List ID
|
data.list_id | integer |
List ID |
|
List Name
|
data.list_name | string |
List Name |
|
List Email ID
|
data.list_email_id | string |
List Email ID |
|
Contacts Count
|
data._contacts_count | integer |
Contacts Count |
Delete a Contact
Delete a Contact
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List ID
|
list_id | True | integer |
You may use the Search Contact List action OR Get Contact List action to get the List ID |
|
Contact ID
|
contact_id | True | integer |
Contact ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
Delete List
Delete a specific contact list
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List ID
|
list_id | True | integer |
You may use the Search Contact List action OR Get Contact List action to get the List ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
Get Contact Lists
Get all contact lists unless specified in the advance options
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Page number
|
page | integer |
Page number |
|
|
Number of records per page
|
limit | integer |
Number of records per page |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
Total
|
data.total | integer |
Total |
|
Per Page
|
data.per_page | integer |
Per Page |
|
Current Page
|
data.current_page | integer |
Current Page |
|
Last Page
|
data.last_page | integer |
Last Page |
|
Next Page Url
|
data.next_page_url | string |
Next Page Url |
|
Prev Page Url
|
data.prev_page_url | string |
Prev Page Url |
|
From
|
data.from | integer |
From |
|
To
|
data.to | integer |
to |
|
data
|
data.data | array of object |
data |
|
List ID
|
data.data.list_id | integer |
List ID |
|
List Name
|
data.data.list_name | string |
List Name |
|
List Email ID
|
data.data.list_email_id | string |
List Email ID |
|
Contact Count
|
data.data._contacts_count | integer |
Contacts Count |
|
Import Inprogress
|
data.data._import_in_progress | integer |
Import Inprogress |
|
OptOut Inprogress
|
data.data._optout_in_progress | integer |
OptOut Inprogress |
Get Contacts in a List
Get all Contacts in a List
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List ID
|
list_id | True | integer |
You may use the Search Contact List action OR Get Contact List action to get the List ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
Total
|
data.total | integer |
Total |
|
Per Page
|
data.per_page | integer |
Per Page |
|
Current Page
|
data.current_page | integer |
Current Page |
|
Last Page
|
data.last_page | integer |
Last Page |
|
Next Page Url
|
data.next_page_url | string |
Next Page Url |
|
Prev Page Url
|
data.prev_page_url | string |
Prev Page Url |
|
From
|
data.from | integer |
From |
|
To
|
data.to | integer |
To |
|
data
|
data.data | array of object |
data |
|
Contact ID
|
data.data.contact_id | integer |
Contact ID |
|
List ID
|
data.data.list_id | integer |
List ID |
|
Phone Number
|
data.data.phone_number | string |
Phone Number |
|
First Name
|
data.data.first_name | string |
First Name |
|
Last Name
|
data.data.last_name | string |
Last Name |
|
Custom 1
|
data.data.custom_1 | string |
Custom 1 |
|
Custom 2
|
data.data.custom_2 | string |
Custom 2 |
|
Custom 3
|
data.data.custom_3 | string |
Custom 3 |
|
Custom 4
|
data.data.custom_4 | string |
Custom 4 |
|
date_added
|
data.data.date_added | integer |
Date Added |
|
Date Updated
|
data.data.date_updated | integer |
Date Updated |
|
Fax Number
|
data.data.fax_number | string |
Fax Number |
|
Organization Name
|
data.data.organization_name | string |
Organization Name |
|
Email
|
data.data.email | string |
|
|
Address Line 1
|
data.data.address_line_1 | string |
Address Line 1 |
|
Address Line 2
|
data.data.address_line_2 | string |
Address Line 2 |
|
Address City
|
data.data.address_city | string |
Address City |
|
Address State
|
data.data.address_state | string |
Address State |
|
Address Postal Code
|
data.data.address_postal_code | string |
Address Postal Code |
|
Address Country
|
data.data.address_country | string |
Address Country |
|
List Name
|
data.data._list_name | string |
List Name |
Search Contact Lists
Get list of searched contact list
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Name
|
q | True | string |
Search for |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
Total
|
data.total | integer |
Total |
|
Per Page
|
data.per_page | integer |
Per Page |
|
Current Page
|
data.current_page | integer |
Current Page |
|
Last Page
|
data.last_page | integer |
Last Page |
|
Next Page Url
|
data.next_page_url | string |
Next Page Url |
|
Prev Page Url
|
data.prev_page_url | string |
Prev Page Url |
|
From
|
data.from | integer |
From |
|
To
|
data.to | integer |
To |
|
data
|
data.data | array of object |
data |
|
Id
|
data.data.id | integer |
Id |
|
Name
|
data.data.name | string |
Name |
|
Contact
|
data.data.contact | string |
Contact |
|
Type
|
data.data.type | string |
Type |
|
Contacts Count
|
data.data.contacts_count | integer |
Contacts Count |
Send Fax
Send Fax
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
To
|
to | True | string |
Phone number in E.164 format. Eg. +61261111111. |
|
Custom String
|
custom_string | string |
This is your reference. It will show on all reports and will be passed back with any replies. |
|
|
PDF File URL
|
file_url | True | string |
Maximum file size is 4 MB. All pages should be in portrait. Chat with ClickSend Support for complete specifications |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
Total Price
|
data.total_price | float |
Total Price |
|
Total Count
|
data.total_count | integer |
Total Count |
|
Queued Count
|
data.queued_count | integer |
Queued Count |
|
messages
|
data.messages | array of object |
messages |
|
User ID
|
data.messages.user_id | integer |
User ID |
|
Subaccount ID
|
data.messages.subaccount_id | integer |
Subaccount ID |
|
List ID
|
data.messages.list_id | string |
List ID |
|
Message ID
|
data.messages.message_id | string |
Message ID |
|
To
|
data.messages.to | string |
To |
|
From
|
data.messages.from | string |
From |
|
Carrier
|
data.messages.carrier | string |
Carrier |
|
Country
|
data.messages.country | string |
Country |
|
Custom String
|
data.messages.custom_string | string |
Custom String |
|
Message Pages
|
data.messages.message_pages | integer |
Message Pages |
|
Message Price
|
data.messages.message_price | string |
Message Price |
|
Status Code
|
data.messages.status_code | string |
Status Code |
|
Status Text
|
data.messages.status_text | string |
Status Text |
|
Date Added
|
data.messages.date_added | integer |
Date Added |
|
From Email
|
data.messages.from_email | string |
From Email |
|
File Url
|
data.messages._file_url | string |
File Url |
|
Status
|
data.messages.status | string |
Status |
|
Currency Name Short
|
data._currency.currency_name_short | string |
Currency Name Short |
|
Currency Prefix D
|
data._currency.currency_prefix_d | string |
Currency Prefix D |
|
Currency Prefix C
|
data._currency.currency_prefix_c | string |
Currency Prefix C |
|
Currency Name Long
|
data._currency.currency_name_long | string |
Currency Name Long |
Send Letter
Send Letter
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PDF File URL
|
file_url | True | string |
Maximum file size is 10 MB. All pages should be in portrait. Chat with ClickSend Support for complete specifications. |
|
Template Used
|
template_used | integer |
Whether using letter template. Flag value must be 1 for yes or 0 for no. |
|
|
Colour
|
colour | True | integer |
Choose to use colour or B&W printing. (Black & White = 0, Colour = 1) |
|
Duplex
|
duplex | True | integer |
Choose to use Duplex = 1 (double-sided) or Simplex = 0(single sided) printing. |
|
Priority Post
|
priority_post | integer |
Whether letter is priority, Flag value must be 1 for yes or 0 for no. |
|
|
Name
|
address_name | True | string |
Name of address |
|
City
|
address_city | True | string |
City |
|
State
|
address_state | True | string |
State |
|
Postal Code
|
address_postal_code | True | string |
Postal Code |
|
Country
|
address_country | True | string |
Country |
|
Select Return Address
|
return_address_id | True | integer |
Return address ID to use |
|
Address Line 1
|
address_line_1 | True | string |
First line of address |
|
Address Line 2
|
address_line_2 | string |
Second line of address |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
Total Price
|
data.total_price | float |
Total Price |
|
Total Count
|
data.total_count | integer |
Total Count |
|
Queued Count
|
data.queued_count | integer |
Queued Count |
|
recipients
|
data.recipients | array of object |
item |
|
User ID
|
data.recipients.user_id | integer |
User ID |
|
Subaccount ID
|
data.recipients.subaccount_id | integer |
Subaccount ID |
|
Message ID
|
data.recipients.message_id | string |
Message ID |
|
Address Name
|
data.recipients.address_name | string |
Address Name |
|
Address Line 1
|
data.recipients.address_line_1 | string |
Address Line 1 |
|
Address Line 2
|
data.recipients.address_line_2 | string |
Address Line 2 |
|
Address City
|
data.recipients.address_city | string |
Address City |
|
Address State
|
data.recipients.address_state | string |
Address State |
|
Address Postal Code
|
data.recipients.address_postal_code | string |
Address Postal Code |
|
Address Country
|
data.recipients.address_country | string |
Address Country |
|
Return Address ID
|
data.recipients.return_address_id | integer |
Return Address ID |
|
Custom String
|
data.recipients.custom_string | string |
Custom String |
|
Source
|
data.recipients.source | string |
Source |
|
Colour
|
data.recipients.colour | integer |
Colour |
|
Duplex
|
data.recipients.duplex | integer |
Duplex |
|
Post Pages
|
data.recipients.post_pages | integer |
Post Pages |
|
Post Price
|
data.recipients.post_price | string |
Post Price |
|
Priority Post
|
data.recipients.priority_post | integer |
Priority Post |
|
Date Added
|
data.recipients.date_added | integer |
Date Added |
|
Status
|
data.recipients.status | string |
Status |
|
File Url
|
data.recipients._file_url | string |
File Url |
|
Return Address ID
|
data.recipients._return_address.return_address_id | integer |
Return Address ID |
|
User ID
|
data.recipients._return_address.user_id | integer |
User ID |
|
Address Name
|
data.recipients._return_address.address_name | string |
Address Name |
|
Address Line 1
|
data.recipients._return_address.address_line_1 | string |
Address Line 1 |
|
Address Line 2
|
data.recipients._return_address.address_line_2 | string |
Address Line 2 |
|
Address City
|
data.recipients._return_address.address_city | string |
Address City |
|
Address State
|
data.recipients._return_address.address_state | string |
Address State |
|
Address Postal Code
|
data.recipients._return_address.address_postal_code | string |
Address Postal Code |
|
Address Country
|
data.recipients._return_address.address_country | string |
Address Country |
|
API Username
|
data.recipients._api_username | string |
API Username |
|
Currency Name Short
|
data._currency.currency_name_short | string |
Currency Name Short |
|
Currency Prefix D
|
data._currency.currency_prefix_d | string |
Currency Prefix D |
|
Currency Prefix C
|
data._currency.currency_prefix_c | string |
Currency Prefix C |
|
Currency Name Long
|
data._currency.currency_name_long | string |
Currency Name Long |
Send MMS
Send MMS
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
to
|
to | True | string |
Mobile phone number. Can be in local or international format. Must be in international (E.164) format if sending to another country. e.g +61411111111. |
|
subject
|
subject | True | string |
Subject line. Maximum 20 characters. |
|
message
|
body | True | string |
Message body. Up to 1500 characters or 500 Unicode characters |
|
Custom String
|
custom_string | string |
This is your reference. It will show on all reports and will be passed back with any replies. |
|
|
Media URL
|
media_file | True | string |
Supports maximum file size of 250kB, Gif can only be supported if it below 100 kB file size |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
Total Price
|
data.total_price | float |
Total Price |
|
Total Count
|
data.total_count | integer |
Total Count |
|
Queued Count
|
data.queued_count | integer |
Queued Count |
|
messages
|
data.messages | array of object |
Msg |
|
List ID
|
data.messages.list_id | integer |
List ID |
|
Contact ID
|
data.messages.contact_id | integer |
Contact ID |
|
Message ID
|
data.messages.message_id | string |
Message ID |
|
To
|
data.messages.to | string |
To |
|
Subject
|
data.messages.subject | string |
Subject |
|
From
|
data.messages.from | string |
From |
|
Body
|
data.messages.body | string |
Body |
|
Country
|
data.messages.country | string |
Country |
|
Custom String
|
data.messages.custom_string | string |
Custom String |
|
Message Parts
|
data.messages.message_parts | integer |
Message Parts |
|
Message Price
|
data.messages.message_price | string |
Message Price |
|
Media File Url
|
data.messages._media_file_url | string |
Media File Url |
|
Status
|
data.messages.status | string |
Status |
Send Postcard
Send one or more postcards
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
address_name | True | string |
Address Name |
|
City
|
address_city | True | string |
City |
|
State
|
address_state | True | string |
State |
|
Postal Code
|
address_postal_code | True | string |
Postal Code |
|
Country
|
address_country | True | string |
Country |
|
Return Address ID
|
return_address_id | True | integer |
Return address ID to use |
|
Address Line 1
|
address_line_1 | True | string |
First line of address |
|
Address Line 2
|
address_line_2 | string |
Second line of address |
|
|
file_urls
|
file_urls | True | array of string |
PDF File URL |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
Total Price
|
data.total_price | double |
Total Price |
|
Total Count
|
data.total_count | integer |
Total Count |
|
Queued Count
|
data.queued_count | integer |
Queued Count |
|
recipients
|
data.recipients | array of object |
Recipient |
|
User ID
|
data.recipients.user_id | integer |
User ID |
|
Subaccount ID
|
data.recipients.subaccount_id | integer |
Subaccount ID |
|
Message ID
|
data.recipients.message_id | string |
Message ID |
|
Address Name
|
data.recipients.address_name | string |
Address Name |
|
Address Line 1
|
data.recipients.address_line_1 | string |
Address Line 1 |
|
Address Line 2
|
data.recipients.address_line_2 | string |
Address Line 2 |
|
Address City
|
data.recipients.address_city | string |
Address City |
|
Address State
|
data.recipients.address_state | string |
Address State |
|
Address Postal Code
|
data.recipients.address_postal_code | string |
Address Postal Code |
|
Address Country
|
data.recipients.address_country | string |
Address Country |
|
Return Address ID
|
data.recipients.return_address_id | integer |
Return Address ID |
|
Schedule
|
data.recipients.schedule | integer |
Schedule |
|
Post Price
|
data.recipients.post_price | string |
Post Price |
|
Status
|
data.recipients.status | string |
Status |
|
Date Added
|
data.recipients.date_added | integer |
Date Added |
|
File Url
|
data.recipients._file_url | string |
File Url |
|
Return Address ID
|
data.recipients._return_address.return_address_id | integer |
Return Address ID |
|
User ID
|
data.recipients._return_address.user_id | integer |
User ID |
|
Address Name
|
data.recipients._return_address.address_name | string |
Address Name |
|
Address Line 1
|
data.recipients._return_address.address_line_1 | string |
Address Line 1 |
|
Address Line 2
|
data.recipients._return_address.address_line_2 | string |
Address Line 2 |
|
Address City
|
data.recipients._return_address.address_city | string |
Address City |
|
Address State
|
data.recipients._return_address.address_state | string |
Address State |
|
Address Postal Code
|
data.recipients._return_address.address_postal_code | string |
Address Postal Code |
|
Address Country
|
data.recipients._return_address.address_country | string |
Address Country |
|
Api Username
|
data.recipients._api_username | string |
Api Username |
|
Currency Name Short
|
data._currency.currency_name_short | string |
Currency Name Short |
|
Currency Prefix D
|
data._currency.currency_prefix_d | string |
Currency Prefix D |
|
Currency Prefix C
|
data._currency.currency_prefix_c | string |
Currency Prefix C |
|
Currency Name Long
|
data._currency.currency_name_long | string |
Currency Name Long |
Send SMS
Each 160 characters = 1 SMS. Can send up to 1,224 standard characters.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
To
|
to | True | string |
Mobile phone number. Can be in local or international format. Must be in international (E.164) format if sending to another country. e.g +61411111111. |
|
Body
|
body | True | string |
160 characters is 1 SMS. Can send up to 1,224 standard characters. |
|
Custom String
|
custom_string | string |
This is your reference. It will show on all reports and will be passed back with any replies. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Msg
|
response_msg | string |
Response Msg |
|
Total Price
|
data.total_price | float |
Total Price |
|
Total Count
|
data.total_count | integer |
Total Count |
|
Queued Count
|
data.queued_count | integer |
Queued Count |
|
messages
|
data.messages | array of object |
Message |
|
Direction
|
data.messages.direction | string |
Direction |
|
Date
|
data.messages.date | integer |
Date |
|
To
|
data.messages.to | string |
To |
|
Body
|
data.messages.body | string |
Body |
|
From
|
data.messages.from | string |
From |
|
Message Id
|
data.messages.message_id | string |
Message Id |
|
Message Parts
|
data.messages.message_parts | integer |
Message Parts |
|
Message Price
|
data.messages.message_price | string |
Message Price |
|
From Email
|
data.messages.from_email | string |
From Email |
|
List Id
|
data.messages.list_id | string |
List Id |
|
Custom String
|
data.messages.custom_string | string |
Custom String |
|
Contact Id
|
data.messages.contact_id | string |
Contact Id |
|
User Id
|
data.messages.user_id | integer |
User Id |
|
Subaccount Id
|
data.messages.subaccount_id | integer |
Subaccount Id |
|
Country
|
data.messages.country | string |
Country |
|
Carrier
|
data.messages.carrier | string |
Carrier |
|
Status
|
data.messages.status | string |
Status |
|
Currency Name Short
|
data._currency.currency_name_short | string |
Currency Name Short |
|
Currency Prefix D
|
data._currency.currency_prefix_d | string |
Currency Prefix D |
|
Currency Prefix C
|
data._currency.currency_prefix_c | string |
Currency Prefix C |
|
Currency Name Long
|
data._currency.currency_name_long | string |
Currency Name Long |
Send Voice Message
Each 300 characters = 1 voice message. Can send up to 1,200 standard characters
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
To
|
to | True | string |
Mobile or landline phone number in local or international format. Must be in international format (E.164) if sending to a different country.e.g. +61411111111. |
|
Body
|
body | True | string |
Message body to be read out. |
|
Language
|
lang | True | string |
Choose which language you want to use. |
|
Voice
|
voice | True | string |
Choose the message to be read out in a Male of Female voice. |
|
Custom String
|
custom_string | string |
This is your reference. It will show on all reports and will be passed back with any replies. |
|
|
Require Input
|
require_input | integer |
Receive a keypress from the recipient. Flag value must be 1 for yes or 0 for no. |
|
|
Machine Detection
|
machine_detection | integer |
Detect answering machine or voicemail and leave a message. Flag value must be 1 for yes or 0 for no. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Response Code
|
response_code | string |
Response Code |
|
Response Message
|
response_msg | string |
Response Message |
|
Total Price
|
data.total_price | float |
Total Price |
|
Total Count
|
data.total_count | integer |
Total Count |
|
Queued Count
|
data.queued_count | integer |
Queued Count |
|
messages
|
data.messages | array of object |
messages |
|
User ID
|
data.messages.user_id | integer |
User ID |
|
Subaccount ID
|
data.messages.subaccount_id | integer |
Subaccount ID |
|
Message ID
|
data.messages.message_id | string |
Message ID |
|
To
|
data.messages.to | string |
To |
|
To Type
|
data.messages.to_type | string |
To Type |
|
From
|
data.messages.from | string |
From |
|
Voice
|
data.messages.voice | string |
Voice |
|
Language
|
data.messages.lang | string |
Language |
|
Body
|
data.messages.body | string |
Bddy |
|
Carrier
|
data.messages.carrier | string |
Carrier |
|
Country
|
data.messages.country | string |
Country |
|
Custom String
|
data.messages.custom_string | string |
Custom String |
|
Schedule
|
data.messages.schedule | integer |
Schedule |
|
Message Parts
|
data.messages.message_parts | integer |
Message Parts |
|
Message Price
|
data.messages.message_price | string |
Message Price |
|
Date Added
|
data.messages.date_added | integer |
Date Added |
|
Require Input
|
data.messages.require_input | integer |
Require Input |
|
Machine Detection
|
data.messages.machine_detection | integer |
Machine Detection |
|
Status
|
data.messages.status | string |
Status |
|
Currency Name Short
|
data._currency.currency_name_short | string |
Currency Name Short |
|
Currency Prefix D
|
data._currency.currency_prefix_d | string |
Currency Prefix D |
|
Currency Prefix C
|
data._currency.currency_prefix_c | string |
Currency Prefix C |
|
Currency Name Long
|
data._currency.currency_name_long | string |
Currency Name Long |
Triggers
| SMS Inbound Automation |
Create new inbound SMS automation |
SMS Inbound Automation
Create new inbound SMS automation
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Body
|
body | string |
body |
|
To
|
to | string |
Recipient phone number |
|
From
|
from | string |
Sender Id |
|
Custom String
|
custom_string | string |
custom_string |
|
Original Message Id
|
original_message_id | string |
original_message_id |
|
Original Body
|
original_body | string |
Original Body |
|
User Id
|
user_id | integer |
The user ID of the user who sent the message. |
|
Subaccount Id
|
subaccount_id | integer |
The subaccount ID of the user who sent the message. |
|
Timestamp
|
timestamp | string |
Timestamp in UNIX format |
|
Message Id
|
message_id | string |
The Message ID for the inbound message |