Messages

Get message status

Current state of one message. Here status is the message's own status code (0 Created, 1 Sent, 2 Failed, 3 Cancelled, 4 Expired), not a success flag; an unknown ID also returns 0, so check message first. A non-numeric ID returns an HTML 404 page, a non-POST request {}. Messages untouched for about 90 days are purged. The JSON body is served with Content-Type: text/html; parse it as JSON whatever the header says.

post/message/status/{msg_id}/

Request

  • Base URL: https://wbiztool.com/api/v1
  • URL: https://wbiztool.com/api/v1/message/status/{msg_id}/
  • Auth: none required

Path parameters

msg_idinteger required

The msg_id returned when the message was sent or scheduled.

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.

Example request

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

Response

The message state, an unknown ID, or Auth Error ({"message": "Auth Error", "status": 0}; also for an invalid JSON body).

OR

Changes

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