Skip to Content
SMSGet SMS

Get SMS

GET /v1/sms/:id

Retrieves a previously queued SMS, including its current delivery status and event history.

Example

const { data, error } = await retransmit.sms.get("sms_xxxxxxxxxxxx");

Response

{ "id": "sms_xxxxxxxxxxxx", "from": "Acme", "to": ["+237670000000"], "text": "Your verification code is 482913", "country": "CM", "segments": 1, "requested_provider": "sns", "provider": "aws_sns", "status": "delivered", "error": null, "created_at": "2026-09-01T12:00:00.000Z", "last_event_at": "2026-09-01T12:00:03.000Z", "events": [ { "type": "sms.sent", "created_at": "2026-09-01T12:00:01.000Z" }, { "type": "sms.delivered", "created_at": "2026-09-01T12:00:03.000Z" } ] }

requested_provider is the carrier the send was pinned to, or null when routing chose freely. provider is the country operation that actually carried the message, so it is more specific: mtn_cm, orange_cm or aws_sns. It is null until the worker routes the message.

SMS statuses

StatusMeaning
queuedAccepted and waiting for a worker.
sentHanded to the upstream provider.
deliveredThe carrier confirmed delivery.
undeliveredThe carrier could not deliver the message.
expiredThe carrier’s delivery window expired.
rejectedThe carrier rejected the message.
failedSending failed permanently after retries or no route was available.

Errors

StatusCodeMeaning
401unauthorizedThe API key is missing, invalid, or revoked.
404not_foundNo SMS with this ID exists on your account.
500internal_errorThe request failed unexpectedly.
Last updated on