Query message status

  • The response will contain status information for any channel relevant to the message.

  • The timestamp field indicates the time of the last status change.

  • If the message is in an unknown state (message not found), the format is different (since there is no channel) and the timestamp should be set to the current time as it is unknown at the time of the request.

Query status of a message

get
  • Response will contain status information for any channel relevant to the message.

  • The timestamp field indicates the time of the last status change.

  • If the message is in an unknown state (message not found), the format is different (since there is no channel) and the timestamp should be set to the current time as it is presently unknown at the time of the request.

Authorizations
Path parameters
omniMessageIdstringRequired

Omni message id

Responses
200

Success

application/json
get
/v1/message/{omniMessageId}
GET /v1/message/{omniMessageId} HTTP/1.1
Host: platform.clickatell.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "sms": {
    "status": "QUEUED",
    "timestamp": 1506607698000
  }
}

Last updated