Skip to content

Message status API (1.0.0)

API for querying SMS statistics and message details

Languages
Servers
Production environment

https://sms-apistatus.namirialtsp.com/api/

Pre-release staging environment

https://sms-apistatus.preprod.namirialtsp.com/api/

Development and testing environment

https://sms-apistatus.test.namirialtsp.com/api/

MessageStatus

Retrieve delivery status and statistics for SMS messages.

Authentication: API Key required (X-Api-Key header)

Operations

Request

Retrieves the delivery status of the latest messages sent to a given phone number.

Security
ApiKeyAuth
Path
phonenumberstringrequired

Phone number in E.164 format (e.g., +1234567890).

Example: +1234567890
Query
sendDatestring(date-time)

Filter messages sent before this timestamp (ISO 8601 format, e.g. 2026-12-31T23:59:59Z). Defaults to current time if not specified.

countinteger(int64)[ 1 .. 100 ]

Maximum number of records to return (max 100)

Default 50
curl -i -X GET \
  'https://sms-apistatus.namirialtsp.com/api/messagestatus/phonenumber/+1234567890?sendDate=2019-08-24T14%3A15%3A22Z&count=50' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

SMS list for phone number

Bodyapplication/json
messagesArray of objects(MessageStatusWrapper)

List of SMS message statuses.

Response
application/json
{ "messages": [ {} ] }

Request

Retrieves the delivery status of the latest messages associated with the external key specified in the reference.key parameter of the send API.

Security
ApiKeyAuth
Path
referencekeystringrequired

External key specified in the reference.key parameter of the send request.

Example: ref-12345
Query
sendDatestring(date-time)

Filter messages sent before this timestamp (ISO 8601 format, e.g. 2026-12-31T23:59:59Z). Defaults to current time if not specified.

countinteger(int64)[ 1 .. 100 ]

Maximum number of records to return (max 100)

Default 50
curl -i -X GET \
  'https://sms-apistatus.namirialtsp.com/api/messagestatus/reference/ref-12345?sendDate=2019-08-24T14%3A15%3A22Z&count=50' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

SMS list for reference key

Bodyapplication/json
messagesArray of objects(MessageStatusWrapper)

List of SMS message statuses.

Response
application/json
{ "messages": [ {} ] }

Request

Retrieves the delivery status for a specific message.

Security
ApiKeyAuth
Path
messageidstring(uuid)required

Message ID to query

Example: 54149766-7f65-4d02-b29d-406a42ca7a88
curl -i -X GET \
  https://sms-apistatus.namirialtsp.com/api/messagestatus/54149766-7f65-4d02-b29d-406a42ca7a88 \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

Message status details.

Bodyapplication/json
messageobject(MessageStatus)

SMS message status

Response
application/json
{ "message": { "id": "30307af0-6d8b-4fbf-b4f3-b0e1fc32381c", "reference": {}, "channel": "SMS", "status": "DELIVERED", "providerAcceptanceAt": "2026-02-27T09:06:58Z", "statusChangedAt": "2026-02-27T09:07:08Z", "provider": {}, "sms": {} } }