ClickSend
App · 25 actions
Send and price SMS, read messages and delivery receipts, and manage contact lists, contacts, and message templates.
Actions
| Action | What it does |
|---|---|
| Cancel scheduled SMS | Cancel scheduled SMS. |
| Copy contact | Copy contact. |
| Create contact | Create contact. |
| Create contact list | Create contact list. |
| Create SMS template | Create SMS template. |
| Delete contact | Delete contact. |
| Delete contact list | Delete contact list. |
| Delete SMS template | Delete SMS template. |
| Estimate SMS price | Estimate SMS price. |
| Get account | Get account. |
| Get contact | Get contact. |
| Get contact list | Get contact list. |
| Get delivery receipt | Get delivery receipt. |
| List contact lists | List contact lists. |
| List contacts | List contacts. |
| List delivery receipts | List delivery receipts. |
| List inbound SMS | List inbound SMS. |
| List SMS history | List SMS history. |
| List SMS templates | List SMS templates. |
| Mark inbound SMS read | Mark inbound SMS read. |
| Send SMS | Send SMS. |
| Transfer contact | Transfer contact. |
| Update contact | Update contact. |
| Update contact list | Update contact list. |
| Update SMS template | Update SMS template. |
Cancel scheduled SMS
Cancel scheduled SMS.
Inputs
- Message ID
message_idtextRequired - Message id
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Copy contact
Copy contact.
Inputs
- From list
from_list_idtextRequired - From list id
- Contact ID
contact_idtextRequired - Contact id
- To list
to_list_idtextRequired - To list id
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Create contact
Create contact.
Inputs
- Contact list
list_idtextRequired - List id
- Phone number
phone_numbertextRequired - Phone number
- First name
first_nametext - First name
- Last name
last_nametext - Last name
- Email
emailtext - Custom 1
custom_1text - Custom 1
- Custom 2
custom_2text - Custom 2
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Create contact list
Create contact list.
Inputs
- List name
list_nametextRequired - List name
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Create SMS template
Create SMS template.
Inputs
- Template name
template_nametextRequired - Template name
- Body
bodytextRequired - Body
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Delete contact
Delete contact.
Inputs
- Contact list
list_idtextRequired - List id
- Contact ID
contact_idtextRequired - Contact id
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Delete contact list
Delete contact list.
Inputs
- Contact list
list_idtextRequired - List id
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Delete SMS template
Delete SMS template.
Inputs
- Template
template_idtextRequired - Template id
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Estimate SMS price
Estimate SMS price.
Inputs
- To
totextRequired - Recipient phone number in international format, including the country code.
- Body
bodytextRequired - The text message to send.
- Sender
sendertext - Your approved sender name or sending number.
- Schedule
scheduledate and time - Send at this time; leave blank to send now.
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Get account
Get account.
Inputs
None.
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Get contact
Get contact.
Inputs
- Contact list
list_idtextRequired - List id
- Contact ID
contact_idtextRequired - Contact id
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Get contact list
Get contact list.
Inputs
- Contact list
list_idtextRequired - List id
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Get delivery receipt
Get delivery receipt.
Inputs
- Message ID
message_idtextRequired - Message id
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}List contact lists
List contact lists.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Limit
limitnumber - LimitFrom 1 to 100. Default:
25.
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}List contacts
List contacts.
Inputs
- Contact list
list_idtextRequired - List id
- Page
pagenumber - PageAt least 1. Default:
1. - Limit
limitnumber - LimitFrom 1 to 100. Default:
25.
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}List delivery receipts
List delivery receipts.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Limit
limitnumber - LimitFrom 1 to 100. Default:
25.
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}List inbound SMS
List inbound SMS.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Limit
limitnumber - LimitFrom 1 to 100. Default:
25.
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}List SMS history
List SMS history.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Limit
limitnumber - LimitFrom 1 to 100. Default:
25.
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}List SMS templates
List SMS templates.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Limit
limitnumber - LimitFrom 1 to 100. Default:
25.
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Mark inbound SMS read
Mark inbound SMS read.
Inputs
- Message ID
message_idtextRequired - Message id
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Send SMS
Send SMS.
Inputs
- To
totextRequired - Recipient phone number in international format, including the country code.
- Body
bodytextRequired - The text message to send.
- Sender
sendertext - Your approved sender name or sending number.
- Schedule
scheduledate and time - Send at this time; leave blank to send now.
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Transfer contact
Transfer contact.
Inputs
- From list
from_list_idtextRequired - From list id
- Contact ID
contact_idtextRequired - Contact id
- To list
to_list_idtextRequired - To list id
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Update contact
Update contact.
Inputs
- Contact list
list_idtextRequired - List id
- Contact ID
contact_idtextRequired - Contact id
- Phone number
phone_numbertext - Phone number
- First name
first_nametext - First name
- Last name
last_nametext - Last name
- Email
emailtext - Custom 1
custom_1text - Custom 1
- Custom 2
custom_2text - Custom 2
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Update contact list
Update contact list.
Inputs
- Contact list
list_idtextRequired - List id
- List name
list_nametextRequired - List name
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}Update SMS template
Update SMS template.
Inputs
- Template
template_idtextRequired - Template id
- Template name
template_nametextRequired - Template name
- Body
bodytextRequired - Body
Outputs
dataobject- The ClickSend result, response status and pagination information.
Example output
{
"data": {
"data": {},
"http_code": 1,
"response_code": "example",
"response_msg": "example"
}
}