SMS API

Send an SMS to any MTN, Telecel, or AirtelTigo number in Ghana with a single POST request, then list and inspect messages to track their delivery status.

POST/sms/

Send SMS

Send a text message to one or more recipients. The message is queued immediately and returns 202 Accepted; track its delivery with the Get a message endpoint.

Body Parameters

fromstringrequired

Your registered sender ID. Must be set up in the dashboard before use.

tostring[]required

Array of destination phone numbers. Local (e.g. 0201234567) and E.164 (e.g. +233201234567) formats are accepted.

bodystringrequired

The text content of the message.

Request Body

{
          "from": "Sail",
          "to": ["0201234567"],
          "body": "Hello from Sail!"
        }

202 AcceptedAccepted

{
          "id": "58cf292d-417e-4f61-9687-662b845574cf",
          "to": ["0201234567"],
          "sender": "Sail",
          "body": "Hello from Sail!",
          "quantity": 1,
          "status": "queued",
          "delivery_status": "",
          "created_at": "2026-04-03T00:59:45.600037Z"
        }

GET/sms/

List messages

Retrieve a paginated list of SMS messages sent from this project, most recent first.

Query Parameters

limitinteger

Maximum number of messages to return. Defaults to 20.

offsetinteger

Number of messages to skip. Defaults to 0.

200 OKResponse

{
          "count": 3,
          "next": null,
          "previous": null,
          "results": [
            {
              "id": "58cf292d-417e-4f61-9687-662b845574cf",
              "to": ["0201234567"],
              "sender": "Sail",
              "body": "Hello from Sail!",
              "quantity": 1,
              "status": "dispatched",
              "delivery_status": "",
              "created_at": "2026-04-03T00:59:45.600037Z"
            }
          ]
        }

GET/sms/{message_id}/

Get a message

Retrieve a single SMS message by its ID, including its current delivery status.

Path Parameters

message_idstringrequired

The UUID of the message.

200 OKResponse

{
          "id": "58cf292d-417e-4f61-9687-662b845574cf",
          "to": ["0201234567"],
          "sender": "Sail",
          "body": "Hello from Sail!",
          "quantity": 1,
          "status": "dispatched",
          "delivery_status": "",
          "created_at": "2026-04-03T00:59:45.600037Z"
        }