Cancel Message

The Cancel Message API cancels a SMS messages(s) that is in a message queue to be sent to users. You can cancel only those SMS messages that are scheduled later.

Note: This API will cancel message for both Text as well as Voice SMS.

URL

The HTTP URL for Cancel Message API is:

/api/v1/messages/sms/{sms_request_id}

Note: You need to fetch SMS request ID to cancel a SMS message. You can view SMS request ID under Settings > Status > SMS Queue > Request ID.

This service implements ‘Gateway Filter for Authentication’ to authenticate access of the service by a user.

Method

DELETE

Header

The payload's request header includes Content-Type as application/json;charset=UTF-8.

Input Parameters

The following fields are input parameters:

Input Parameter	Required	Type	Description
Request ID	Yes	long	The unique ID assigned to a SMS

Sample Response

{
"id" : "",
"message" : "Cancelled 4 message entries of the Message with ID : 4713025406550859686"
}

Response Status

Code	Description
Status 200	Cancelled 4 message entries of the Message with ID : xxxxxxxxx
Status 400	Invalid Request. Request method not allowed
Status 401	Unauthorized request
Status 500	Server failure to process request