Messages

Cancel a message

Cancel a message that has not been sent yet (status 0, Created): scheduled or queued. It then reports status 3 and its webhook gets a CANCELLED event. A message a bot is already sending may still go out. The JSON body is served with Content-Type: text/html; parse it as JSON whatever the header says.

post/cancel_msg/

Request

  • Base URL: https://wbiztool.com/api/v1
  • URL: https://wbiztool.com/api/v1/cancel_msg/
  • Auth: none required

Request body

client_idinteger required

Your API Client ID from Settings → API keys.

api_keystring required

One of your API keys from the same page. Keep it secret.

msg_idinteger required

The msg_id returned when the message was sent or scheduled.

Example request

{
  "client_id": 12345,
  "api_key": "YOUR_API_KEY",
  "msg_id": 9817263
}

Response

Cancelled (status: 1, message: Cancelled) or not (status: 0). Failure messages: Msg has been Sent, Msg has been Failed, Msg has been Cancelled, Msg has been Expired, No msg found for given msg_id, Msg_id cant be null, Auth Error, Invalid JSON format: …; a JSON body sent with another method than POST returns {}.

status0 | 1 required

1 success, 0 failure.

messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.