Check Delivery Status

Learn how to view the Delivery Status of outbound messages

You can check the delivery status of your message sends with Mobile Text Alerts two different ways:

• Call the List Deliveries API endpoint

  • This is best for reporting/analytics of settled message data. This only includes the most recent status for a message.

• Configure the delivery-status webhook

  • This is best for real time status updates, with this webhook you can receive the full status history from the moment of send to the final result status (delivered, rejected etc.).

Call the List Deliveries API endpoint

With the GET /deliveries endpoint of the Mobile Text Alerts API you can see a list of all messages sent to all subscribers or you can use query parameters to filter the results. The message status will show the most recent status of a message.

Example query

Filter messages with a delivered delivery status: (note the [] brackets are escaped characters in the cURL request)

curl --location 'https://mobile-text-alerts.com/v3/deliveries??filters%5Bstatus%5D=delivered'\ ’ \
  --header 'Authorization: Bearer 89fa747a-e01b-5940-99c2-4e96fa996258'

Query Parameters

Name	Type	Description
page	number	Specific page number to retrieve.
pageSize	number	Number of results per page.
sortBy	date	Field to sort results by date.
sortDirection	ASC|DESC	Direction to sort results by, choose either ASC for ascending or DESC for descending.
query	string	The query string will return all subscribers with this value in either firstName, lastName, number, or email.
filters[startDate]	date in format: YYYY-MM-DD	Filter results to only show results after a specified start date.
filters[endDate]	date in format: YYYY-MM-DD	Filter results to only show results before a specified end date.
filters[type]	string enum:sms|mms|tts	Filter results by message type, choose one of the following type codes: sms|mms|tts.
filters[status]	string enum:sent|delivered|undelivered|undeliverable|unknown|rejected	Filter results by delivery status, choose one of the following status codes: sent|delivered|undelivered|undeliverable|unknown|rejected.

List Deliveries

get

List all subscribers and query for subscribers. Includes all subscribers with query value in either first name, last name, number, email, or custom subscriber fields and with filters values in respective categories.

undefined

Authorizations

bearerAuth

Query parameters

Responses

200

Success

application/json

Responseall of

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

get

/deliveries

HTTPcURLJavaScriptPython

GET /v3/deliveries HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "rows": [
      {
        "messageId": 1,
        "externalId": "text",
        "message": "text",
        "attachment": "text",
        "status": "sent",
        "date": "text",
        "carrier": "text",
        "to": "text",
        "from": "text",
        "type": "sms"
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Configure the delivery-status webhook

A delivery-status webhook event is triggered when MTA receives an updated delivery status code from a provider regarding a sent message. This is best for real time status updates as you can receive the full status history from the moment of send to the final result status (delivered, rejected etc.).

If you haven't configured webhooks for your account see: Setting up your first webhook

Also view the Delivery Status payload, to learn what fields are sent as part of this webhook.