/clicksend-sms | Type: Application | PCID required: Yes
Tools
clicksend_sms_campaign_by_sms_campaign_id_get
Get specific sms campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sms_campaign_id | integer | Yes | — | ID of SMS campaign to retrieve |
clicksend_sms_campaigns_by_sms_campaign_id_put
Update sms campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sms_campaign_id | integer | Yes | — | ID of SMS campaign to update |
body | string | Yes | — | Your campaign message. |
from | string | No | — | Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids. |
list_id | integer | Yes | — | Your list id. |
name | string | Yes | — | Your campaign name. |
schedule | integer | No | — | Your schedule timestamp. |
url_to_shorten | string | No | — | url to be shortened add http://smsg.io/xxxxx` to the body as a placeholder. |
clicksend_sms_campaigns_cancel_by_sms_campaign_id_put
Cancel sms campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sms_campaign_id | integer | Yes | — | ID of SMS Campaign to cancel |
clicksend_sms_campaigns_get
Get list of sms campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_sms_campaigns_price_post
Calculate price for sms campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string | Yes | — | Your campaign message. |
from | string | No | — | Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids. |
list_id | integer | Yes | — | Your list id. |
name | string | Yes | — | Your campaign name. |
schedule | integer | No | — | Your schedule timestamp. |
url_to_shorten | string | No | — | url to be shortened add http://smsg.io/xxxxx` to the body as a placeholder. |
clicksend_sms_campaigns_send_post
Create sms campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string | Yes | — | Your campaign message. |
from | string | No | — | Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids. |
list_id | integer | Yes | — | Your list id. |
name | string | Yes | — | Your campaign name. |
schedule | integer | No | — | Your schedule timestamp. |
url_to_shorten | string | No | — | url to be shortened add http://smsg.io/xxxxx` to the body as a placeholder. |
clicksend_sms_cancel_all_put
Update all scheduled message as cancelledclicksend_sms_cancel_by_message_id_put
Update scheduled message as cancelled Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
message_id | string | Yes | — | The message ID you want to cancel |
clicksend_sms_delivery_receipt_automation_delete
Delete sms delivery receipt automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_rule_id | integer | Yes | — | Receipt rule id |
clicksend_sms_delivery_receipt_automation_get
Get specific sms delivery receipt automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_rule_id | integer | Yes | — | Receipt rule id |
clicksend_sms_delivery_receipt_automation_post
Create sms delivery receipt automations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
action | string | Yes | — | 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). |
action_address | string | Yes | — | Action address. |
enabled | number | Yes | — | Enabled: Disabled=0 or Enabled=1. |
match_type | number | Yes | — | Match Type. 0=All reports. |
rule_name | string | Yes | — | Rule Name. |
clicksend_sms_delivery_receipt_automation_put
Update sms delivery receipt automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_rule_id | integer | Yes | — | Receipt rule id |
action | string | Yes | — | 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). |
action_address | string | Yes | — | Action address. |
enabled | number | Yes | — | Enabled: Disabled=0 or Enabled=1. |
match_type | number | Yes | — | Match Type. 0=All reports. |
rule_name | string | Yes | — | Rule Name. |
clicksend_sms_delivery_receipt_automations_get
Get all sms delivery receipt automations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | No | — | Your keyword or query. |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_sms_email_sms_get
Get list of email to sms allowed addresses Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_sms_email_sms_post
Create email to sms allowed address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_address | string | Yes | — | Your email address |
from | string | Yes | — | Your sender id |
subaccount_id | string | No | — | Your subaccount id |
clicksend_sms_email_sms_stripped_string_delete
Delete email to sms stripped string rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rule_id | integer | Yes | — | Your rule id |
clicksend_sms_email_sms_stripped_string_get
Get email to sms stripped string rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rule_id | integer | Yes | — | Your rule id |
clicksend_sms_email_sms_stripped_string_post
Create email to sms stripped string rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
strip_string | string | Yes | — | String to be. |
clicksend_sms_email_sms_stripped_string_put
Update email to sms stripped string rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rule_id | integer | Yes | — | Your rule id |
strip_string | string | Yes | — | String to be. |
clicksend_sms_email_sms_stripped_strings_get
Get list of email to sms stripped string rules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_sms_history_export_get
Export all sms history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filename | string | Yes | — | Filename to download history as |
clicksend_sms_history_get
Get all sms history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | No | — | Custom query Example: from:{number},status_code:201. |
date_from | integer | No | — | Start date |
date_to | integer | No | — | End date |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_sms_inbound_automation_delete
Delete inbound sms automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inbound_rule_id | integer | Yes | — | Inbound rule id |
clicksend_sms_inbound_automation_get
Get specific inbound sms automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inbound_rule_id | integer | Yes | — | Inbound rule id |
clicksend_sms_inbound_automation_post
Create new inbound sms automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
action | string | Yes | — | 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). |
action_address | string | Yes | — | Action address. |
dedicated_number | string | Yes | — | Dedicated Number. Can be ’*’ to apply to all numbers. |
enabled | number | Yes | — | Enabled: Disabled=0 or Enabled=1. |
message_search_term | string | Yes | — | Message search term. |
message_search_type | number | Yes | — | Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain. |
rule_name | string | Yes | — | Rule Name. |
webhook_type | string | No | — | post, get, or json. post by default |
clicksend_sms_inbound_automation_put
Update inbound sms automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inbound_rule_id | integer | Yes | — | Inbound rule id |
action | string | Yes | — | 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). |
action_address | string | Yes | — | Action address. |
dedicated_number | string | Yes | — | Dedicated Number. Can be ’*’ to apply to all numbers. |
enabled | number | Yes | — | Enabled: Disabled=0 or Enabled=1. |
message_search_term | string | Yes | — | Message search term. |
message_search_type | number | Yes | — | Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain. |
rule_name | string | Yes | — | Rule Name. |
webhook_type | string | No | — | post, get, or json. post by default |
clicksend_sms_inbound_automations_get
Get all inbound sms automations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | No | — | Your keyword or query. |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_sms_inbound_get
Get all inbound sms Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | No | — | Your keyword or query. |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_sms_inbound_post
Create inbound sms Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | Yes | — | Your url. |
clicksend_sms_inbound_read_by_message_id_put
Mark inbound SMS as read Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
message_id | string | Yes | — | Message ID |
clicksend_sms_inbound_read_put
Mark inbound SMS as read Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_before | number | No | — | An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read. |
clicksend_sms_list_countries_get
List of countriesclicksend_sms_price_post
Calculate sms price Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messages | object[] | Yes | — | Array of SmsMessage items |
clicksend_sms_receipts_by_message_id_get
Get a Specific Delivery Receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
message_id | string | Yes | — | Message ID |
clicksend_sms_receipts_get
Get all delivery receipts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_sms_receipts_post
Add a delivery receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | Yes | — | Your url. |
clicksend_sms_receipts_read_put
Mark delivery receipts as read Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_before | number | No | — | An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read. |
clicksend_sms_send_post
Send sms message(s) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messages | object[] | Yes | — | Array of SmsMessage items |
clicksend_sms_templates_by_template_id_delete
Delete sms template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | integer | Yes | — | Template id |
clicksend_sms_templates_by_template_id_put
Update sms template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | integer | Yes | — | Template id |
body | string | Yes | — | Body of template |
template_name | string | Yes | — | Name of template |
clicksend_sms_templates_get
Get lists of all sms templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_sms_templates_post
Create sms template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string | Yes | — | Body of template |
template_name | string | Yes | — | Name of template |
clicksend_sms_user_countries_agree_post
Agree to rules and regulationclicksend_sms_user_countries_get
Get Countries for Global Sendingclicksend_sms_user_countries_post
Select Countries for Global Sending Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
country_list_ids | integer[] | Yes | — | Array of country ids |

