comment-checkCheck Delivery Status

Learn how to view the Delivery Status of outbound messages

There are two ways to check the delivery status of your message sends with Mobile Text Alerts:

Call the List Deliveries API endpoint

With the GET /deliveries endpoint of the Mobile Text Alerts API, you can list all messages sent to subscribers, or use query parameters to filter results. The message status shows the most recent status for each message.

Example request to filter the delivery status

See below how to filter messages that have delivery status of delivered :

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

Note: the [] brackets are escaped characters

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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
chevron-right
200

Success

application/json
get
/deliveries

Configure the delivery-status webhook

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

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

Also see the Delivery Status payload to learn which fields are sent as part of this webhook.

Last updated

Was this helpful?