Stop message
Overview
This command will attempt to stop the delivery of a particular message. This command can only stop messages that have been scheduled for delivery in the future or may be queued within our router. It cannot stop messages that have already been delivered to an SMSC.
DELETE https: //api.clickatell.com/rest/message/[message ID] |
Note: the REST API may respond with various HTTP status codes. See the full list here.
JSON
Request
DELETE /rest/message/360586640fe9846954897dffe6c13dfc HTTP/ 1.1 HOST: api.clickatell.com X-Version: 1 Authorization: Bearer [Your Authorization Token] Accept: application/json |
Response
HTTP/ 1.1 200 OK Content-Type: application/json { "data" : { "messageStatus" : "006" , "description" : "User cancelled message delivery" , "apiMessageId" : "360586640fe9846954897dffe6c13dfc" } } |
XML
Request
1 |
|
Response
1 |
|
Sample code
cURL
msgId= "" authToken= "" curl -X DELETE \ -H "X-Version: 1" \ -H "Accept: application/json" \ -H "Authorization: Bearer $authToken" \ https: //api.clickatell.com/rest/message/$msgId |
Python
1 |
|
PHP
1 |
|
Submit a Comment
Other Resources
Ask the Community
Visit Stack Overflow to join our community of developers and find the answer you need
Contact Support
Contact our support team and one of our agents will be in touch with you to answer any questions you have