/clicksend-voice | Type: Application | PCID required: Yes
Tools
clicksend_voice_cancel_all_put
Update all voice messages as cancelledclicksend_voice_cancel_by_message_id_put
Update voice message status as cancelled Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
message_id | string | Yes | — | Your voice message id |
clicksend_voice_delivery_receipt_automation_delete
Delete voice delivery receipt automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_rule_id | integer | Yes | — | Receipt rule id |
clicksend_voice_delivery_receipt_automation_get
Get specific voice delivery receipt automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_rule_id | integer | Yes | — | Receipt rule id |
clicksend_voice_delivery_receipt_automation_post
Create voice 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_voice_delivery_receipt_automation_put
Update voice 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_voice_delivery_receipt_automations_get
Get all voice 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_voice_history_export_get
Export voice history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filename | string | Yes | — | Filename to export to |
clicksend_voice_history_get
Get all voice history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_from | integer | No | — | Timestamp (from) used to show records by date. |
date_to | integer | No | — | Timestamp (to) used to show records by date |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_voice_lang_get
Get all voice languagesclicksend_voice_mms_campaign_by_mms_campaign_id_get
Get specific mms campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mms_campaign_id | integer | Yes | — | ID of MMS campaign to retrieve |
clicksend_voice_mms_campaigns_by_mms_campaign_id_put
Update mms campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mms_campaign_id | integer | Yes | — | ID of MMS 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. |
media_file | string | Yes | — | URL pointing to media file. |
name | string | Yes | — | Your campaign name. |
schedule | integer | No | — | Your schedule timestamp. |
subject | string | Yes | — | Subject of MMS campaign. |
clicksend_voice_mms_campaigns_cancel_by_mms_campaign_id_put
Cancel mms campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mms_campaign_id | integer | Yes | — | ID of MMS Campaign to cancel |
clicksend_voice_mms_campaigns_get
Get list of mms campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_voice_mms_campaigns_price_post
Calculate price for mms 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. |
media_file | string | Yes | — | URL pointing to media file. |
name | string | Yes | — | Your campaign name. |
schedule | integer | No | — | Your schedule timestamp. |
subject | string | Yes | — | Subject of MMS campaign. |
clicksend_voice_mms_campaigns_send_post
Create mms 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. |
media_file | string | Yes | — | URL pointing to media file. |
name | string | Yes | — | Your campaign name. |
schedule | integer | No | — | Your schedule timestamp. |
subject | string | Yes | — | Subject of MMS campaign. |
clicksend_voice_mms_history_export_get
Export all mms history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filename | string | Yes | — | Filename to download history as |
clicksend_voice_mms_history_get
Get all mms 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_voice_mms_price_post
Get Price for MMS sent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
media_file | string | Yes | — | Media file you want to send |
messages | object[] | Yes | — | Array of MmsMessage models |
clicksend_voice_mms_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_voice_mms_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_voice_mms_send_post
Send MMS Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
media_file | string | Yes | — | Media file you want to send |
messages | object[] | Yes | — | Array of MmsMessage models |
clicksend_voice_price_post
Calculate voice price Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messages | object[] | Yes | — | Array of VoiceMessage items |
clicksend_voice_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_voice_receipts_post
Add a delivery receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | Yes | — | Your url. |
clicksend_voice_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_voice_send_post
Send voice message(s) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messages | object[] | Yes | — | Array of VoiceMessage items |

