API ReferenceSMS API
Message Status
GET /api/sms/message/{messageId} — Check SMS delivery status.
Endpoint
GET https://app.esmsafrica.io/api/sms/message/{messageId}Authentication
X-Account-ID: your_account_id
X-API-Key: your_api_keyPath parameters
| Parameter | Type | Description |
|---|---|---|
messageId | string | The message ID returned from the send endpoint |
Response
{
"messageId": "msg_abc123",
"phoneNumber": "+254712345678",
"text": "Your OTP is 123456",
"senderId": "MyApp",
"status": "delivered",
"createdAt": "2025-01-15T10:30:00Z",
"updatedAt": "2025-01-15T10:30:05Z"
}Statuses
| Status | Description |
|---|---|
queued | Accepted and queued for sending |
sent | Submitted to carrier network |
delivered | Confirmed delivered to handset |
failed | Delivery failed |
rejected | Rejected before sending |
Example
curl https://app.esmsafrica.io/api/sms/message/msg_abc123 \
-H "X-Account-ID: your_account_id" \
-H "X-API-Key: your_api_key"