SMS API

Send an SMS to any MTN, Telecel, or AirtelTigo number in Ghana with one POST request, then look messages up to see whether they were delivered.

POST/sms/

Send SMS

Send a text message to one or more recipients. Each recipient becomes its own message, and the 202 Accepted response lists them all with what the request cost in credits. Use Get a message to find out whether one was delivered.

Body Parameters

fromstringrequired

A sender ID registered on this project. Register it in the dashboard before you send from it.

tostring[]required

The numbers to send to. Local numbers such as 0201234567 and E.164 numbers such as +233201234567 both work.

bodystringrequired

The message text.

Request Body
{
  "from": "Sail",
  "to": ["0201234567"],
  "body": "Hello from Sail!"
}
202 AcceptedAccepted
{
  "count": 1,
  "total_quantity": 1,
  "messages": [
    {
      "id": "58cf292d-417e-4f61-9687-662b845574cf",
      "to": ["0201234567"],
      "sender": "Sail",
      "body": "Hello from Sail!",
      "quantity": 1,
      "status": "queued",
      "delivery_status": "pending",
      "created_at": "2026-04-03T00:59:45.600037Z"
    }
  ]
}
GET/sms/

List messages

List the SMS messages this project has sent, newest first.

Query Parameters

pageinteger

Page number to return. Defaults to 1.

page_sizeinteger

Number of messages per page. Defaults to 30, maximum 1000.

Response Fields

delivery_statusstring

Whether the message reached the recipient. One of pending, delivered, failed, expired or rejected. It starts as pending and changes when the carrier reports back. This is the field to check for delivery.

statusstringdeprecated

Sailup's internal dispatch state: pending_balance, queued, dispatched or failed. Still returned for backwards compatibility, but build new integrations against delivery_status instead. A status of failed means Sailup never dispatched the message, for example because the balance ran out. That is not the same as the carrier failing to deliver it.

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": "delivered",
      "created_at": "2026-04-03T00:59:45.600037Z"
    }
  ]
}
GET/sms/{message_id}/

Get a message

Get one SMS message by its ID, with its current delivery status.

Path Parameters

message_idstringrequired

The UUID of the message.

Response Fields

delivery_statusstring

Whether the message reached the recipient. One of pending, delivered, failed, expired or rejected. It starts as pending and changes when the carrier reports back. This is the field to check for delivery.

statusstringdeprecated

Sailup's internal dispatch state: pending_balance, queued, dispatched or failed. Still returned for backwards compatibility, but build new integrations against delivery_status instead. A status of failed means Sailup never dispatched the message, for example because the balance ran out. That is not the same as the carrier failing to deliver it.

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