Connectors Reference
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.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Send SMS |
|
|
get_contact_lists ([advanced][Optional]integer page, [advanced][Optional]integer limit) |
Get Contact Lists |
|
Create New Contact List |
|
|
Get Countries |
|
|
Send Voice Message |
|
|
Get Voice Languages |
|
|
Delete List |
|
|
Get Contacts in a List |
|
|
create_list_contact (integer list_id, create_list_contactParameterBody body) |
Create New Contact |
|
Delete a Contact |
|
|
Send MMS |
|
|
Send Fax |
|
|
upload_media (string convert, upload_mediaParameterBody body) |
Convert Media File Format |
|
Search Contact Lists |
|
|
Send Letter |
|
|
Send Postcard |
|
|
Get Return Addresses |
|
|
Delete inbound SMS automation |
|
Name |
Summary |
|
sms_inbound_automation (sms_inbound_automationParameterBody body) |
SMS Inbound Automation |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Send SMS
Description: Each 160 characters = 1 SMS. Can send up to 1,224 standard characters.
Syntax:
ClickSendSMS.sms_send (sms_sendParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:sms_sendResponse
Summary: Get Contact Lists
Description: Get all contact lists unless specified in the advance options
Syntax:
ClickSendSMS.get_contact_lists ([advanced][Optional]integer page, [advanced][Optional]integer limit)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
page |
integer(int32) (Page number) |
Page number |
False |
|
|
limit |
integer(int32) (Number of records per page) |
Number of records per page |
False |
Returns:
Type:get_contact_listsResponse
Summary: Create New Contact List
Description: Create New Contact List
Syntax:
ClickSendSMS.create_list (create_listParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:create_listResponse
Summary: Get Countries
Description: Get Countries
Syntax:
ClickSendSMS.get_countries ()
Returns:
Summary: Send Voice Message
Description: Each 300 characters = 1 voice message. Can send up to 1,200 standard characters
Syntax:
ClickSendSMS.send_voice (send_voiceParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:send_voiceResponse
Summary: Get Voice Languages
Description:
Syntax:
ClickSendSMS.get_voice_languages ()
Returns:
Type:get_voice_languagesResponse
Summary: Delete List
Description: Delete a specific contact list
Syntax:
ClickSendSMS.delete_list (integer list_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
list_id |
integer(int32) (List ID) |
You may use the Search Contact List action OR Get Contact List action to get the List ID |
True |
Returns:
Type:delete_listResponse
Summary: Get Contacts in a List
Description: Get all Contacts in a List
Syntax:
ClickSendSMS.view_list_contacts (integer list_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
list_id |
integer(int32) (List ID) |
You may use the Search Contact List action OR Get Contact List action to get the List ID |
True |
Returns:
Type:view_list_contactsResponse
Summary: Create New Contact
Description: Create New Contact
Syntax:
ClickSendSMS.create_list_contact (integer list_id, create_list_contactParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
list_id |
integer(int32) (List ID) |
You may use the Search Contact List action OR Get Contact List action to get the List ID |
True |
|
|
body |
create_list_contactParameterBody
|
|
True |
Returns:
Type:create_list_contactResponse
Summary: Delete a Contact
Description: Delete a Contact
Syntax:
ClickSendSMS.delete_list_contact (integer list_id, integer contact_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
list_id |
integer(int32) (List ID) |
You may use the Search Contact List action OR Get Contact List action to get the List ID |
True |
|
|
contact_id |
integer(int32) (Contact ID) |
Contact ID |
True |
Returns:
Type:delete_list_contactResponse
Summary: Send MMS
Description: Send MMS
Syntax:
ClickSendSMS.send_mms (send_mmsParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:send_mmsResponse
Summary: Send Fax
Description: Send Fax
Syntax:
ClickSendSMS.send_fax (send_faxParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:send_faxResponse
Summary: Convert Media File Format
Description: Convert Media File Format
Syntax:
ClickSendSMS.upload_media (string convert, upload_mediaParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
convert |
string (Select action the file is needed for)Values: [fax, mms, csv, post, postcard] |
Select action the file is needed for |
True |
|
|
body |
|
|
True |
Returns:
Type:upload_mediaResponse
Summary: Search Contact Lists
Description: Get list of searched contact list
Syntax:
ClickSendSMS.search_contact_list (string q)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
q |
string (List Name) |
Search for |
True |
Returns:
Type:search_contact_listResponse
Summary: Send Letter
Description: Send Letter
Syntax:
ClickSendSMS.send_letter (send_letterParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:send_letterResponse
Summary: Send Postcard
Description: Send one or more postcards
Syntax:
ClickSendSMS.send_postcard (send_postcardParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: Get Return Addresses
Description: Get list of post return addresses
Syntax:
ClickSendSMS.get_return_addresses ()
Returns:
Type:get_return_addressesResponse
Summary: Delete inbound SMS automation
Description: Delete inbound SMS automation
Syntax:
ClickSendSMS.delete_sms_inbound_automation (integer inbound_rule_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inbound_rule_id |
integer(int32) (Inbound rule id) |
Inbound rule id |
True |
Returns:
Type:delete_sms_inbound_automationResponse
Summary: SMS Inbound Automation
Description: Create new inbound SMS automation
Syntax:
ClickSendSMS.sms_inbound_automation (sms_inbound_automationParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
sms_inbound_automationParameterBody
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
list_name |
string
|
Your contact list name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
list_id |
integer(int32)
|
List ID |
|
list_name |
string
|
List Name |
|
list_email_id |
string
|
List Email ID |
|
_contacts_count |
integer(int32)
|
Contacts Count |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
first_name |
string
|
Contact's first name. |
|
last_name |
string
|
Contact's last name. |
|
phone_number |
string
|
The contact phone in local or international format e.g. +61411111111. |
|
|
string
|
Contact's email address. |
|
fax_number |
string
|
Contact's fax number. |
|
organization_name |
string
|
Contact's organization name. |
|
address_country |
string
|
The contact's country. |
|
address_state |
string
|
State |
|
address_city |
string
|
Address City |
|
custom_1 |
string
|
Custom 1 |
|
custom_3 |
string
|
Custom 3 |
|
address_postal_code |
string
|
|
|
custom_2 |
string
|
Custom 2 |
|
custom_4 |
string
|
Custom 4 |
|
address_line_1 |
string
|
Address Line 1 |
|
address_line_2 |
string
|
Address Line 2 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
contact_id |
integer(int32)
|
Contact ID |
|
list_id |
integer(int32)
|
List ID |
|
phone_number |
string
|
Phone Number |
|
first_name |
string
|
First Name |
|
last_name |
string
|
Last Name |
|
custom_1 |
string
|
Custom 1 |
|
custom_2 |
string
|
Custom 2 |
|
custom_3 |
string
|
Custom 3 |
|
custom_4 |
string
|
Custom 4 |
|
date_added |
integer(int32)
|
Date Added |
|
fax_number |
string
|
Fax Number |
|
organization_name |
string
|
Organization Name |
|
|
string
|
|
|
address_line_1 |
string
|
Address Line 1 |
|
address_line_2 |
string
|
Address Line 2 |
|
address_city |
string
|
Address City |
|
address_state |
string
|
Address State |
|
address_postal_code |
string
|
Address Postal Code |
|
address_country |
string
|
Address Country |
|
_list_name |
string
|
List Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
total |
integer(int32)
|
Total |
|
per_page |
integer(int32)
|
Per Page |
|
current_page |
integer(int32)
|
Current Page |
|
last_page |
integer(int32)
|
Last Page |
|
next_page_url |
string
|
Next Page Url |
|
prev_page_url |
string
|
Prev Page Url |
|
from |
integer(int32)
|
From |
|
to |
integer(int32)
|
to |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
list_id |
integer(int32)
|
List ID |
|
list_name |
string
|
List Name |
|
list_email_id |
string
|
List Email ID |
|
_contacts_count |
integer(int32)
|
Contacts Count |
|
_import_in_progress |
integer(int32)
|
Import Inprogress |
|
_optout_in_progress |
integer(int32)
|
OptOut Inprogress |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
Code |
|
value |
string
|
Value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
return_address_id |
integer(int32)
|
Return Address ID |
|
user_id |
integer(int32)
|
User ID |
|
address_name |
string
|
Address Name |
|
address_line_1 |
string
|
Address Line 1 |
|
address_line_2 |
string
|
Address Line 2 |
|
address_city |
string
|
Address City |
|
address_state |
string
|
Address State |
|
address_postal_code |
string
|
Address Postal Code |
|
address_country |
string
|
Address Country |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
Code |
|
country |
string
|
Country |
|
gender |
array of (string)
|
gender |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
total |
integer(int32)
|
Total |
|
per_page |
integer(int32)
|
Per Page |
|
current_page |
integer(int32)
|
Current Page |
|
last_page |
integer(int32)
|
Last Page |
|
next_page_url |
string
|
Next Page Url |
|
prev_page_url |
string
|
Prev Page Url |
|
from |
integer(int32)
|
From |
|
to |
integer(int32)
|
To |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Id |
|
name |
string
|
Name |
|
contact |
string
|
Contact |
|
type |
string
|
Type |
|
contacts_count |
integer(int32)
|
Contacts Count |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
messages |
array of (MessagesItem)
|
Message |
|
file_url |
string
|
Maximum file size is 4 MB. All pages should be in portrait. Chat with ClickSend Support for complete specifications |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
to |
string
|
Phone number in E.164 format. Eg. +61261111111. |
|
from |
string
|
from |
|
source |
string
|
Source |
|
custom_string |
string
|
This is your reference. It will show on all reports and will be passed back with any replies. |
|
list_id |
integer(int32)
|
List ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
total_price |
number(float)
|
Total Price |
|
total_count |
integer(int32)
|
Total Count |
|
queued_count |
integer(int32)
|
Queued Count |
|
messages |
array of (MessagesItem)
|
messages |
|
_currency |
|
Currency |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
user_id |
integer(int32)
|
User ID |
|
subaccount_id |
integer(int32)
|
Subaccount ID |
|
list_id |
string
|
List ID |
|
message_id |
string
|
Message ID |
|
to |
string
|
To |
|
from |
string
|
From |
|
carrier |
string
|
Carrier |
|
country |
string
|
Country |
|
custom_string |
string
|
Custom String |
|
message_pages |
integer(int32)
|
Message Pages |
|
message_price |
string
|
Message Price |
|
status_code |
string
|
Status Code |
|
status_text |
string
|
Status Text |
|
date_added |
integer(int32)
|
Date Added |
|
from_email |
string
|
From Email |
|
_file_url |
string
|
File Url |
|
status |
string
|
Status |
Summary:
Description: Currency
Properties:
|
Name |
Type |
Summary |
|
currency_name_short |
string
|
Currency Name Short |
|
currency_prefix_d |
string
|
Currency Prefix D |
|
currency_prefix_c |
string
|
Currency Prefix C |
|
currency_name_long |
string
|
Currency Name Long |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
file_url |
string
|
Maximum file size is 10 MB. All pages should be in portrait. Chat with ClickSend Support for complete specifications. |
|
template_used |
integer(int32)
|
Whether using letter template. Flag value must be 1 for yes or 0 for no. Values: [, ] |
|
colour |
integer(int32)
|
Choose to use colour or B&W printing. (Black & White = 0, Colour = 1) Values: [, ] |
|
duplex |
integer(int32)
|
Choose to use Duplex = 1 (double-sided) or Simplex = 0(single sided) printing. Values: [, ] |
|
priority_post |
integer(int32)
|
Whether letter is priority, Flag value must be 1 for yes or 0 for no. Values: [, ] |
|
recipients |
array of (RecipientsItem)
|
Recipient |
|
source |
string
|
Source |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address_name |
string
|
Name of address |
|
address_city |
string
|
City |
|
address_state |
string
|
State |
|
address_postal_code |
string
|
Postal Code |
|
address_country |
string
|
Country |
|
return_address_id |
integer(int32)
|
Return address ID to use |
|
address_line_1 |
string
|
First line of address |
|
address_line_2 |
string
|
Second line of address |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
total_price |
number(float)
|
Total Price |
|
total_count |
integer(int32)
|
Total Count |
|
queued_count |
integer(int32)
|
Queued Count |
|
recipients |
array of (RecipientsItem)
|
item |
|
_currency |
|
_currency |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
user_id |
integer(int32)
|
User ID |
|
subaccount_id |
integer(int32)
|
Subaccount ID |
|
message_id |
string
|
Message ID |
|
address_name |
string
|
Address Name |
|
address_line_1 |
string
|
Address Line 1 |
|
address_line_2 |
string
|
Address Line 2 |
|
address_city |
string
|
Address City |
|
address_state |
string
|
Address State |
|
address_postal_code |
string
|
Address Postal Code |
|
address_country |
string
|
Address Country |
|
return_address_id |
integer(int32)
|
Return Address ID |
|
custom_string |
string
|
Custom String |
|
source |
string
|
Source |
|
colour |
integer(int32)
|
Colour |
|
duplex |
integer(int32)
|
Duplex |
|
post_pages |
integer(int32)
|
Post Pages |
|
post_price |
string
|
Post Price |
|
priority_post |
integer(int32)
|
Priority Post |
|
date_added |
integer(int32)
|
Date Added |
|
status |
string
|
Status |
|
_file_url |
string
|
File Url |
|
_return_address |
|
Return Address |
|
_api_username |
string
|
API Username |
Summary:
Description: Return Address
Properties:
|
Name |
Type |
Summary |
|
return_address_id |
integer(int32)
|
Return Address ID |
|
user_id |
integer(int32)
|
User ID |
|
address_name |
string
|
Address Name |
|
address_line_1 |
string
|
Address Line 1 |
|
address_line_2 |
string
|
Address Line 2 |
|
address_city |
string
|
Address City |
|
address_state |
string
|
Address State |
|
address_postal_code |
string
|
Address Postal Code |
|
address_country |
string
|
Address Country |
Summary:
Description: _currency
Properties:
|
Name |
Type |
Summary |
|
currency_name_short |
string
|
Currency Name Short |
|
currency_prefix_d |
string
|
Currency Prefix D |
|
currency_prefix_c |
string
|
Currency Prefix C |
|
currency_name_long |
string
|
Currency Name Long |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
messages |
array of (MessagesItem)
|
Message |
|
media_file |
string
|
Supports maximum file size of 250kB, Gif can only be supported if it below 100 kB file size |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
to |
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 |
string
|
Subject line. Maximum 20 characters. |
|
body |
string
|
Message body. Up to 1500 characters or 500 Unicode characters |
|
custom_string |
string
|
This is your reference. It will show on all reports and will be passed back with any replies. |
|
list_id |
integer(int32)
|
List ID |
|
from |
string
|
from |
|
source |
string
|
Source |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
total_price |
number(float)
|
Total Price |
|
total_count |
integer(int32)
|
Total Count |
|
queued_count |
integer(int32)
|
Queued Count |
|
messages |
array of (MessagesItem)
|
Msg |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
list_id |
integer(int32)
|
List ID |
|
contact_id |
integer(int32)
|
Contact ID |
|
message_id |
string
|
Message ID |
|
to |
string
|
To |
|
subject |
string
|
Subject |
|
from |
string
|
From |
|
body |
string
|
Body |
|
country |
string
|
Country |
|
custom_string |
string
|
Custom String |
|
message_parts |
integer(int32)
|
Message Parts |
|
message_price |
string
|
Message Price |
|
_media_file_url |
string
|
Media File Url |
|
status |
string
|
Status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipients |
array of (RecipientsItem)
|
item |
|
file_urls |
array of (string)
|
PDF File URL |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address_name |
string
|
Address Name |
|
address_city |
string
|
City |
|
address_state |
string
|
State |
|
address_postal_code |
string
|
Postal Code |
|
address_country |
string
|
Country |
|
return_address_id |
integer(int32)
|
Return address ID to use |
|
address_line_1 |
string
|
First line of address |
|
address_line_2 |
string
|
Second line of address |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
total_price |
number(double)
|
Total Price |
|
total_count |
integer(int32)
|
Total Count |
|
queued_count |
integer(int32)
|
Queued Count |
|
recipients |
array of (RecipientsItem)
|
Recipient |
|
_currency |
|
Currency |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
user_id |
integer(int32)
|
User ID |
|
subaccount_id |
integer(int32)
|
Subaccount ID |
|
message_id |
string
|
Message ID |
|
address_name |
string
|
Address Name |
|
address_line_1 |
string
|
Address Line 1 |
|
address_line_2 |
string
|
Address Line 2 |
|
address_city |
string
|
Address City |
|
address_state |
string
|
Address State |
|
address_postal_code |
string
|
Address Postal Code |
|
address_country |
string
|
Address Country |
|
return_address_id |
integer(int32)
|
Return Address ID |
|
schedule |
integer(int32)
|
Schedule |
|
post_price |
string
|
Post Price |
|
status |
string
|
Status |
|
date_added |
integer(int32)
|
Date Added |
|
_file_url |
string
|
File Url |
|
_return_address |
|
Return Address |
|
_api_username |
string
|
Api Username |
Summary:
Description: Return Address
Properties:
|
Name |
Type |
Summary |
|
return_address_id |
integer(int32)
|
Return Address ID |
|
user_id |
integer(int32)
|
User ID |
|
address_name |
string
|
Address Name |
|
address_line_1 |
string
|
Address Line 1 |
|
address_line_2 |
string
|
Address Line 2 |
|
address_city |
string
|
Address City |
|
address_state |
string
|
Address State |
|
address_postal_code |
string
|
Address Postal Code |
|
address_country |
string
|
Address Country |
Summary:
Description: Currency
Properties:
|
Name |
Type |
Summary |
|
currency_name_short |
string
|
Currency Name Short |
|
currency_prefix_d |
string
|
Currency Prefix D |
|
currency_prefix_c |
string
|
Currency Prefix C |
|
currency_name_long |
string
|
Currency Name Long |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
messages |
array of (MessagesItem)
|
Message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
to |
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 |
string
|
Message body to be read out. |
|
lang |
string
|
Choose which language you want to use. |
|
voice |
string
|
Choose the message to be read out in a Male of Female voice. Values: [male, female] |
|
custom_string |
string
|
This is your reference. It will show on all reports and will be passed back with any replies. |
|
list_id |
integer(int32)
|
List ID |
|
require_input |
integer(int32)
|
Receive a keypress from the recipient. Flag value must be 1 for yes or 0 for no. Values: [, ] |
|
source |
string
|
Source |
|
machine_detection |
integer(int32)
|
Detect answering machine or voicemail and leave a message. Flag value must be 1 for yes or 0 for no. Values: [, ] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
total_price |
number(float)
|
Total Price |
|
total_count |
integer(int32)
|
Total Count |
|
queued_count |
integer(int32)
|
Queued Count |
|
messages |
array of (MessagesItem)
|
messages |
|
_currency |
|
Currency |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
user_id |
integer(int32)
|
User ID |
|
subaccount_id |
integer(int32)
|
Subaccount ID |
|
message_id |
string
|
Message ID |
|
to |
string
|
To |
|
to_type |
string
|
To Type |
|
from |
string
|
From |
|
voice |
string
|
Voice |
|
lang |
string
|
Language |
|
body |
string
|
Bddy |
|
carrier |
string
|
Carrier |
|
country |
string
|
Country |
|
custom_string |
string
|
Custom String |
|
schedule |
integer(int32)
|
Schedule |
|
message_parts |
integer(int32)
|
Message Parts |
|
message_price |
string
|
Message Price |
|
date_added |
integer(int32)
|
Date Added |
|
require_input |
integer(int32)
|
Require Input |
|
machine_detection |
integer(int32)
|
Machine Detection |
|
status |
string
|
Status |
Summary:
Description: Currency
Properties:
|
Name |
Type |
Summary |
|
currency_name_short |
string
|
Currency Name Short |
|
currency_prefix_d |
string
|
Currency Prefix D |
|
currency_prefix_c |
string
|
Currency Prefix C |
|
currency_name_long |
string
|
Currency Name Long |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message_search_type |
integer(int32)
|
Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain. |
|
message_search_term |
string
|
word or phrase in the SMS |
|
action_address |
string
|
Action address |
|
dedicated_number |
string
|
Decicated Number. Can be '*' to apply to all numbers. |
|
rule_name |
string
|
Rule Name |
|
webhook_type |
string
|
Webhook Type |
|
action |
string
|
Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE). |
|
enabled |
integer(int32)
|
enabled |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
messages |
array of (MessagesItem)
|
Message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
to |
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 |
string
|
160 characters is 1 SMS. Can send up to 1,224 standard characters. |
|
custom_string |
string
|
This is your reference. It will show on all reports and will be passed back with any replies. |
|
list_id |
integer(int32)
|
List ID |
|
source |
string
|
Source |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Msg |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
total_price |
number(float)
|
Total Price |
|
total_count |
integer(int32)
|
Total Count |
|
queued_count |
integer(int32)
|
Queued Count |
|
messages |
array of (MessagesItem)
|
Message |
|
_currency |
|
_currency |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
direction |
string
|
Direction |
|
date |
integer(int32)
|
Date |
|
to |
string
|
To |
|
body |
string
|
Body |
|
from |
string
|
From |
|
message_id |
string
|
Message Id |
|
message_parts |
integer(int32)
|
Message Parts |
|
message_price |
string
|
Message Price |
|
from_email |
string
|
From Email |
|
list_id |
string
|
List Id |
|
custom_string |
string
|
Custom String |
|
contact_id |
string
|
Contact Id |
|
user_id |
integer(int32)
|
User Id |
|
subaccount_id |
integer(int32)
|
Subaccount Id |
|
country |
string
|
Country |
|
carrier |
string
|
Carrier |
|
status |
string
|
Status |
Summary:
Description: _currency
Properties:
|
Name |
Type |
Summary |
|
currency_name_short |
string
|
Currency Name Short |
|
currency_prefix_d |
string
|
Currency Prefix D |
|
currency_prefix_c |
string
|
Currency Prefix C |
|
currency_name_long |
string
|
Currency Name Long |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
content |
string(byte)
|
File Content (base64) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
upload_id |
integer(int32)
|
Upload ID |
|
file_name |
string
|
File Name |
|
date_added |
integer(int32)
|
Date Added |
|
date_delete |
integer(int32)
|
Date Delete |
|
user_id |
integer(int32)
|
User ID |
|
_url |
string
|
Url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
http_code |
integer(int32)
|
Http Code |
|
response_code |
string
|
Response Code |
|
response_msg |
string
|
Response Message |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
total |
integer(int32)
|
Total |
|
per_page |
integer(int32)
|
Per Page |
|
current_page |
integer(int32)
|
Current Page |
|
last_page |
integer(int32)
|
Last Page |
|
next_page_url |
string
|
Next Page Url |
|
prev_page_url |
string
|
Prev Page Url |
|
from |
integer(int32)
|
From |
|
to |
integer(int32)
|
To |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contact_id |
integer(int32)
|
Contact ID |
|
list_id |
integer(int32)
|
List ID |
|
phone_number |
string
|
Phone Number |
|
first_name |
string
|
First Name |
|
last_name |
string
|
Last Name |
|
custom_1 |
string
|
Custom 1 |
|
custom_2 |
string
|
Custom 2 |
|
custom_3 |
string
|
Custom 3 |
|
custom_4 |
string
|
Custom 4 |
|
date_added |
integer(int32)
|
Date Added |
|
date_updated |
integer(int32)
|
Date Updated |
|
fax_number |
string
|
Fax Number |
|
organization_name |
string
|
Organization Name |
|
|
string
|
|
|
address_line_1 |
string
|
Address Line 1 |
|
address_line_2 |
string
|
Address Line 2 |
|
address_city |
string
|
Address City |
|
address_state |
string
|
Address State |
|
address_postal_code |
string
|
Address Postal Code |
|
address_country |
string
|
Address Country |
|
_list_name |
string
|
List Name |