Check SMS Delivery Status

Check the delivery status of a message:
POST /query/deliveryStatus

Query ThingSpace about the delivery status of a message.

Your application should wait at least 5 minutes after sending a message before querying the delivery status.

Contents

See also:
Send an SMS Message

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/messaging/v1/query/deliveryStatus

Resource Path and Query Parameters

None.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization request header.

Request Body

The body contains the destination number, message, and other values.

Parameter Name Data Type Description
messageID
required
string The unique ID of the message, from the response to the POST /sms request.
recipient
required
string The MDN of the recipient device.
senderAddress
required
string The long code that the message was sent from.
transactionID
required
string The unique identifier for the original request.

Example Request Body

{
  "messageID": "EMAG1_3033003",
  "recipient": "8587546063",
  "senderAddress": "1609051527",
  "transactionID": "b149870-1e49cd-123456"
}

Success Responses

Status 200

A success response includes details about the delivery status of the message.

Parameter Name Data Type Description
transactionID string Same as transactionID in request.
statusCode string Status code of the request. See Status Codes for a list of status codes and texts.
statusText string Status text of the request. See Status Codes for a list of status codes and texts.
details string Details of the status.
messageStatus string The delivery status of the message. See Delivery Statuses for a list of possible statuses.
messageStatusText string Details of the status.
messageType string The type of message, currently always SMS.
date string The date and time of the status, in Unix timestamp format (milliseconds since epoch).

Example Success Response

{
    "transactionID":"A1234567890-1",
    "statusCode":"1000",
    "statusText":"Success",
    "date":1473188352000,
    "details":"",
    "messageType":"SMS",
    "messageStatus":"Unrecognised",
    "messageStatusText":"No record found"
}

Failure Responses

Status 400

All error messages are returned in this format:

{
  "error": "The type of error, such as INVALID_REQUEST.",
  "error_description": "Additional error information.",
  "error_url": "Optional URI with more information about the error."
}

The error_url field will not be present if there is no URI for more information.

Error codes and messages are listed on the Status Codes page, along with explanations and suggestions for corrective actions.

Try It Out!