How Can I View Message Details via API?

If you need to retrieve the full status and metadata of a previously sent SMS message, Cequens provides a dedicated API endpoint to query message details using the message_id.

This is especially useful for:

  • Verifying delivery status

  • Troubleshooting message failures

  • Integrating reporting into your internal dashboards

Prerequisites

Before calling the API, ensure that:

  • You have a valid access token generated via the OAuth2 authentication flow

  • You have the message_id returned from the original POST /api/sms/v1/messages response

API Endpoint

http
CopyEdit
GET https://developer.cequens.com/api/sms/v1/messages/{message_id}

Replace {message_id} with the unique ID you received when the message was submitted.

Required Headers

http
CopyEdit
Authorization: Bearer YOUR_ACCESS_TOKEN Content-Type: application/json

Sample Request

bash
CopyEdit
curl -X GET https://developer.cequens.com/api/sms/v1/messages/f0cabc4d-ec3c-42e5-a683-123456789abc \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -H "Content-Type: application/json"

✅ Sample Success Response

json
CopyEdit
{  "message_id": "f0cabc4d-ec3c-42e5-a683-123456789abc",  "recipient": "201234567890",  "sender": "CEQUENS",  "message": "Hello from Cequens!",  "status": "DELIVRD",  "submitted_at": "2025-08-04T10:15:00Z",  "delivered_at": "2025-08-04T10:15:04Z",  "route": "Etisalat-EGY",  "dlr_status": "DELIVRD"
}

? Field Descriptions

FieldDescription
message_idUnique identifier for the message
recipientThe recipient's phone number (E.164 format)
senderSender ID used to send the message
messageThe original message content
statusOverall message status (DELIVRD, FAILED, EXPIRED, etc.)
submitted_atTime when the message was submitted
delivered_atTime when message was confirmed delivered (if applicable)
routeCarrier/operator used for message routing
dlr_statusFinal delivery report result

Official Documentation

For full details and optional query parameters, visit:
Get SMS Details – Cequens Developer Hub