Skip to content
Home » Octopush Gateway SMS API » Voice SMS API » Cancel Voice SMS on existing contacts

Cancel Voice SMS on existing contacts

DELETE
https://api.octopush.com/v1/public/voice-campaign-on-list/cancel

Encodage : UTF-8

Authentification

Your “api-key” and “api-login” identifiers must be added in the headers.

Definition

Allows you to cancel a Voice SMS campaign sent to a list or using a tag.

Special parameters

NameTypeDescription
ticket_numberstringThis is the ticket transmitted by Octopush after the call to the creation function.

Curl Example

curl -X DELETE \ 
'https://api.octopush.com/v1/public/voice-campaign-on-list/cancel' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "ticket_number": "voice_5f3fbce61266e"
}'

Command to copy/paste

curl -X DELETE 'https://api.octopush.com/v1/public/voice-campaign-on-list/cancel' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"ticket_number": "voice_5f3fbce61266e"}'

JSON Server Response

Success : 204 NO CONTENT