Skip to main content
Server path: /clicksend-voice | Type: Application | PCID required: Yes

Tools

ToolDescription
clicksend_voice_cancel_all_putUpdate all voice messages as cancelled
clicksend_voice_cancel_by_message_id_putUpdate voice message status as cancelled
clicksend_voice_delivery_receipt_automation_deleteDelete voice delivery receipt automation
clicksend_voice_delivery_receipt_automation_getGet specific voice delivery receipt automation
clicksend_voice_delivery_receipt_automation_postCreate voice delivery receipt automations
clicksend_voice_delivery_receipt_automation_putUpdate voice delivery receipt automation
clicksend_voice_delivery_receipt_automations_getGet all voice delivery receipt automations
clicksend_voice_history_export_getExport voice history
clicksend_voice_history_getGet all voice history
clicksend_voice_lang_getGet all voice languages
clicksend_voice_mms_campaign_by_mms_campaign_id_getGet specific mms campaign
clicksend_voice_mms_campaigns_by_mms_campaign_id_putUpdate mms campaign
clicksend_voice_mms_campaigns_cancel_by_mms_campaign_id_putCancel mms campaign
clicksend_voice_mms_campaigns_getGet list of mms campaigns
clicksend_voice_mms_campaigns_price_postCalculate price for mms campaign
clicksend_voice_mms_campaigns_send_postCreate mms campaign
clicksend_voice_mms_history_export_getExport all mms history
clicksend_voice_mms_history_getGet all mms history
clicksend_voice_mms_price_postGet Price for MMS sent
clicksend_voice_mms_receipts_getGet all delivery receipts
clicksend_voice_mms_receipts_read_putMark delivery receipts as read
clicksend_voice_mms_send_postSend MMS
clicksend_voice_price_postCalculate voice price
clicksend_voice_receipts_getGet all delivery receipts
clicksend_voice_receipts_postAdd a delivery receipt
clicksend_voice_receipts_read_putMark delivery receipts as read
clicksend_voice_send_postSend voice message(s)

clicksend_voice_cancel_all_put

Update all voice messages as cancelled

clicksend_voice_cancel_by_message_id_put

Update voice message status as cancelled Parameters:
ParameterTypeRequiredDefaultDescription
message_idstringYesYour voice message id

clicksend_voice_delivery_receipt_automation_delete

Delete voice delivery receipt automation Parameters:
ParameterTypeRequiredDefaultDescription
receipt_rule_idintegerYesReceipt rule id

clicksend_voice_delivery_receipt_automation_get

Get specific voice delivery receipt automation Parameters:
ParameterTypeRequiredDefaultDescription
receipt_rule_idintegerYesReceipt rule id

clicksend_voice_delivery_receipt_automation_post

Create voice delivery receipt automations Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesAction 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_addressstringYesAction address.
enablednumberYesEnabled: Disabled=0 or Enabled=1.
match_typenumberYesMatch Type. 0=All reports.
rule_namestringYesRule Name.

clicksend_voice_delivery_receipt_automation_put

Update voice delivery receipt automation Parameters:
ParameterTypeRequiredDefaultDescription
receipt_rule_idintegerYesReceipt rule id
actionstringYesAction 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_addressstringYesAction address.
enablednumberYesEnabled: Disabled=0 or Enabled=1.
match_typenumberYesMatch Type. 0=All reports.
rule_namestringYesRule Name.

clicksend_voice_delivery_receipt_automations_get

Get all voice delivery receipt automations Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoYour keyword or query.
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_voice_history_export_get

Export voice history Parameters:
ParameterTypeRequiredDefaultDescription
filenamestringYesFilename to export to

clicksend_voice_history_get

Get all voice history Parameters:
ParameterTypeRequiredDefaultDescription
date_fromintegerNoTimestamp (from) used to show records by date.
date_tointegerNoTimestamp (to) used to show records by date
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_voice_lang_get

Get all voice languages

clicksend_voice_mms_campaign_by_mms_campaign_id_get

Get specific mms campaign Parameters:
ParameterTypeRequiredDefaultDescription
mms_campaign_idintegerYesID of MMS campaign to retrieve

clicksend_voice_mms_campaigns_by_mms_campaign_id_put

Update mms campaign Parameters:
ParameterTypeRequiredDefaultDescription
mms_campaign_idintegerYesID of MMS campaign to update
bodystringYesYour campaign message.
fromstringNoYour sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids.
list_idintegerYesYour list id.
media_filestringYesURL pointing to media file.
namestringYesYour campaign name.
scheduleintegerNoYour schedule timestamp.
subjectstringYesSubject of MMS campaign.

clicksend_voice_mms_campaigns_cancel_by_mms_campaign_id_put

Cancel mms campaign Parameters:
ParameterTypeRequiredDefaultDescription
mms_campaign_idintegerYesID of MMS Campaign to cancel

clicksend_voice_mms_campaigns_get

Get list of mms campaigns Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_voice_mms_campaigns_price_post

Calculate price for mms campaign Parameters:
ParameterTypeRequiredDefaultDescription
bodystringYesYour campaign message.
fromstringNoYour sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids.
list_idintegerYesYour list id.
media_filestringYesURL pointing to media file.
namestringYesYour campaign name.
scheduleintegerNoYour schedule timestamp.
subjectstringYesSubject of MMS campaign.

clicksend_voice_mms_campaigns_send_post

Create mms campaign Parameters:
ParameterTypeRequiredDefaultDescription
bodystringYesYour campaign message.
fromstringNoYour sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids.
list_idintegerYesYour list id.
media_filestringYesURL pointing to media file.
namestringYesYour campaign name.
scheduleintegerNoYour schedule timestamp.
subjectstringYesSubject of MMS campaign.

clicksend_voice_mms_history_export_get

Export all mms history Parameters:
ParameterTypeRequiredDefaultDescription
filenamestringYesFilename to download history as

clicksend_voice_mms_history_get

Get all mms history Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoCustom query Example: from:{number},status_code:201.
date_fromintegerNoStart date
date_tointegerNoEnd date
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_voice_mms_price_post

Get Price for MMS sent Parameters:
ParameterTypeRequiredDefaultDescription
media_filestringYesMedia file you want to send
messagesobject[]YesArray of MmsMessage models

clicksend_voice_mms_receipts_get

Get all delivery receipts Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_voice_mms_receipts_read_put

Mark delivery receipts as read Parameters:
ParameterTypeRequiredDefaultDescription
date_beforenumberNoAn 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:
ParameterTypeRequiredDefaultDescription
media_filestringYesMedia file you want to send
messagesobject[]YesArray of MmsMessage models

clicksend_voice_price_post

Calculate voice price Parameters:
ParameterTypeRequiredDefaultDescription
messagesobject[]YesArray of VoiceMessage items

clicksend_voice_receipts_get

Get all delivery receipts Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_voice_receipts_post

Add a delivery receipt Parameters:
ParameterTypeRequiredDefaultDescription
urlstringYesYour url.

clicksend_voice_receipts_read_put

Mark delivery receipts as read Parameters:
ParameterTypeRequiredDefaultDescription
date_beforenumberNoAn 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:
ParameterTypeRequiredDefaultDescription
messagesobject[]YesArray of VoiceMessage items