/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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sms_campaign_id": {
"type": "integer",
"description": "ID of SMS campaign to retrieve"
}
},
"required": [
"PCID",
"sms_campaign_id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sms_campaign_id": {
"type": "integer",
"description": "ID of SMS campaign to update"
},
"body": {
"type": "string",
"description": "Your campaign message."
},
"from": {
"type": "string",
"description": "Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids."
},
"list_id": {
"type": "integer",
"description": "Your list id."
},
"name": {
"type": "string",
"description": "Your campaign name."
},
"schedule": {
"type": "integer",
"description": "Your schedule timestamp."
},
"url_to_shorten": {
"type": "string",
"description": "url to be shortened add http://smsg.io/xxxxx` to the body as a placeholder."
}
},
"required": [
"PCID",
"sms_campaign_id",
"body",
"list_id",
"name"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sms_campaign_id": {
"type": "integer",
"description": "ID of SMS Campaign to cancel"
}
},
"required": [
"PCID",
"sms_campaign_id"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
}
},
"required": [
"PCID"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "string",
"description": "Your campaign message."
},
"from": {
"type": "string",
"description": "Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids."
},
"list_id": {
"type": "integer",
"description": "Your list id."
},
"name": {
"type": "string",
"description": "Your campaign name."
},
"schedule": {
"type": "integer",
"description": "Your schedule timestamp."
},
"url_to_shorten": {
"type": "string",
"description": "url to be shortened add http://smsg.io/xxxxx` to the body as a placeholder."
}
},
"required": [
"PCID",
"body",
"list_id",
"name"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "string",
"description": "Your campaign message."
},
"from": {
"type": "string",
"description": "Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids."
},
"list_id": {
"type": "integer",
"description": "Your list id."
},
"name": {
"type": "string",
"description": "Your campaign name."
},
"schedule": {
"type": "integer",
"description": "Your schedule timestamp."
},
"url_to_shorten": {
"type": "string",
"description": "url to be shortened add http://smsg.io/xxxxx` to the body as a placeholder."
}
},
"required": [
"PCID",
"body",
"list_id",
"name"
]
}
clicksend_sms_cancel_all_put
Update all scheduled message as cancelledShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
clicksend_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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"message_id": {
"type": "string",
"description": "The message ID you want to cancel"
}
},
"required": [
"PCID",
"message_id"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"receipt_rule_id": {
"type": "integer",
"description": "Receipt rule id"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"receipt_rule_id": {
"type": "integer",
"description": "Receipt rule id"
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"action": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Action address."
},
"enabled": {
"type": "number",
"description": "Enabled: Disabled=0 or Enabled=1."
},
"match_type": {
"type": "number",
"description": "Match Type. 0=All reports."
},
"rule_name": {
"type": "string",
"description": "Rule Name."
}
},
"required": [
"PCID",
"action",
"action_address",
"enabled",
"match_type",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"receipt_rule_id": {
"type": "integer",
"description": "Receipt rule id"
},
"action": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Action address."
},
"enabled": {
"type": "number",
"description": "Enabled: Disabled=0 or Enabled=1."
},
"match_type": {
"type": "number",
"description": "Match Type. 0=All reports."
},
"rule_name": {
"type": "string",
"description": "Rule Name."
}
},
"required": [
"PCID",
"receipt_rule_id",
"action",
"action_address",
"enabled",
"match_type",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q": {
"type": "string",
"description": "Your keyword or query."
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email_address": {
"type": "string",
"description": "Your email address"
},
"from": {
"type": "string",
"description": "Your sender id"
},
"subaccount_id": {
"type": "string",
"description": "Your subaccount id"
}
},
"required": [
"PCID",
"email_address",
"from"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"rule_id": {
"type": "integer",
"description": "Your rule id"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"rule_id": {
"type": "integer",
"description": "Your rule id"
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"strip_string": {
"type": "string",
"description": "String to be."
}
},
"required": [
"PCID",
"strip_string"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"rule_id": {
"type": "integer",
"description": "Your rule id"
},
"strip_string": {
"type": "string",
"description": "String to be."
}
},
"required": [
"PCID",
"rule_id",
"strip_string"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
}
},
"required": [
"PCID"
]
}
clicksend_sms_history_export_get
Export all sms history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filename | string | Yes | — | Filename to download history as |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filename": {
"type": "string",
"description": "Filename to download history as"
}
},
"required": [
"PCID",
"filename"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q": {
"type": "string",
"description": "Custom query Example: from:{number},status_code:201."
},
"date_from": {
"type": "integer",
"description": "Start date"
},
"date_to": {
"type": "integer",
"description": "End date"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
}
},
"required": [
"PCID"
]
}
clicksend_sms_inbound_automation_delete
Delete inbound sms automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inbound_rule_id | integer | Yes | — | Inbound rule id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"inbound_rule_id": {
"type": "integer",
"description": "Inbound rule id"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"inbound_rule_id": {
"type": "integer",
"description": "Inbound rule id"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"action": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Action address."
},
"dedicated_number": {
"type": "string",
"description": "Dedicated Number. Can be '*' to apply to all numbers."
},
"enabled": {
"type": "number",
"description": "Enabled: Disabled=0 or Enabled=1."
},
"message_search_term": {
"type": "string",
"description": "Message search term."
},
"message_search_type": {
"type": "number",
"description": "Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain."
},
"rule_name": {
"type": "string",
"description": "Rule Name."
},
"webhook_type": {
"type": "string",
"description": "post, get, or json. post by default"
}
},
"required": [
"PCID",
"action",
"action_address",
"dedicated_number",
"enabled",
"message_search_term",
"message_search_type",
"rule_name"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"inbound_rule_id": {
"type": "integer",
"description": "Inbound rule id"
},
"action": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Action address."
},
"dedicated_number": {
"type": "string",
"description": "Dedicated Number. Can be '*' to apply to all numbers."
},
"enabled": {
"type": "number",
"description": "Enabled: Disabled=0 or Enabled=1."
},
"message_search_term": {
"type": "string",
"description": "Message search term."
},
"message_search_type": {
"type": "number",
"description": "Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain."
},
"rule_name": {
"type": "string",
"description": "Rule Name."
},
"webhook_type": {
"type": "string",
"description": "post, get, or json. post by default"
}
},
"required": [
"PCID",
"inbound_rule_id",
"action",
"action_address",
"dedicated_number",
"enabled",
"message_search_term",
"message_search_type",
"rule_name"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q": {
"type": "string",
"description": "Your keyword or query."
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q": {
"type": "string",
"description": "Your keyword or query."
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
}
},
"required": [
"PCID"
]
}
clicksend_sms_inbound_post
Create inbound sms Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | Yes | — | Your url. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"url": {
"type": "string",
"description": "Your url."
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"message_id": {
"type": "string",
"description": "Message ID"
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"date_before": {
"type": "number",
"description": "An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read."
}
},
"required": [
"PCID"
]
}
clicksend_sms_list_countries_get
List of countriesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
clicksend_sms_price_post
Calculate sms price Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messages | object[] | Yes | — | Array of SmsMessage items |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "string",
"description": "Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids."
},
"body": {
"type": "string",
"description": "Your message."
},
"to": {
"type": "string",
"description": "Recipient phone number in E.164 format."
},
"source": {
"type": "string",
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'."
},
"schedule": {
"type": "integer",
"format": "int32",
"description": "Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp"
},
"custom_string": {
"type": "string",
"description": "Your reference. Will be passed back with all replies and delivery reports."
},
"list_id": {
"type": "integer",
"format": "int32",
"description": "Your list ID if sending to a whole list. Can be used instead of 'to'."
},
"country": {
"type": "string",
"description": "Recipient country."
},
"from_email": {
"type": "string",
"description": "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."
}
},
"required": [
"body"
]
},
"description": "Array of SmsMessage items"
}
},
"required": [
"PCID",
"messages"
]
}
clicksend_sms_receipts_by_message_id_get
Get a Specific Delivery Receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
message_id | string | Yes | — | Message ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"message_id": {
"type": "string",
"description": "Message ID"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
}
},
"required": [
"PCID"
]
}
clicksend_sms_receipts_post
Add a delivery receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | Yes | — | Your url. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"url": {
"type": "string",
"description": "Your url."
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"date_before": {
"type": "number",
"description": "An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read."
}
},
"required": [
"PCID"
]
}
clicksend_sms_send_post
Send sms message(s) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messages | object[] | Yes | — | Array of SmsMessage items |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "string",
"description": "Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids."
},
"body": {
"type": "string",
"description": "Your message."
},
"to": {
"type": "string",
"description": "Recipient phone number in E.164 format."
},
"source": {
"type": "string",
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'."
},
"schedule": {
"type": "integer",
"format": "int32",
"description": "Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp"
},
"custom_string": {
"type": "string",
"description": "Your reference. Will be passed back with all replies and delivery reports."
},
"list_id": {
"type": "integer",
"format": "int32",
"description": "Your list ID if sending to a whole list. Can be used instead of 'to'."
},
"country": {
"type": "string",
"description": "Recipient country."
},
"from_email": {
"type": "string",
"description": "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."
}
},
"required": [
"body"
]
},
"description": "Array of SmsMessage items"
}
},
"required": [
"PCID",
"messages"
]
}
clicksend_sms_templates_by_template_id_delete
Delete sms template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | integer | Yes | — | Template id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"template_id": {
"type": "integer",
"description": "Template id"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"template_id": {
"type": "integer",
"description": "Template id"
},
"body": {
"type": "string",
"description": "Body of template"
},
"template_name": {
"type": "string",
"description": "Name of template"
}
},
"required": [
"PCID",
"template_id",
"body",
"template_name"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "string",
"description": "Body of template"
},
"template_name": {
"type": "string",
"description": "Name of template"
}
},
"required": [
"PCID",
"body",
"template_name"
]
}
clicksend_sms_user_countries_agree_post
Agree to rules and regulationShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
clicksend_sms_user_countries_get
Get Countries for Global SendingShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
clicksend_sms_user_countries_post
Select Countries for Global Sending Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
country_list_ids | integer[] | Yes | — | Array of country ids |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"country_list_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Array of country ids"
}
},
"required": [
"PCID",
"country_list_ids"
]
}

