Docs
DocumentationExamplesDashboard →

Getting Started

  • Introduction
  • Authentication
  • Base URL

API Reference

  • Sending SMS
  • Scheduled SMS
  • Sender IDs

Resources

  • Error Responses
  • Code Examples

Sending SMS

The Send SMS endpoint is the primary API for sending messages immediately.

⚡

Messages sent through this endpoint are delivered immediately. For delayed delivery, use the Schedule SMS endpoint.

Endpoint

POST /api/send-sms

Request Body

FieldTypeRequiredDescription
senderIdstringYesApproved sender ID (max 11 characters)
phonestringYesA single phone number or comma-separated numbers
messagestringYesMessage content (max 918 characters for long SMS)

The senderId must belong to the same account as the API key and be active. Requests using a sender ID that is not owned by the API key will be rejected.

Request Example

{
  "senderId": "MyBusiness",
  "phone": "233200000000,233201111111,233202222222",
  "message": "Hello from our platform! Your order #12345 has been shipped."
}

Response

Success Response

HTTP/1.1 200 OK
{
  "success": true,
  "messageId": "msg_abc123xyz789",
  "phone": "233200000000,233201111111,233202222222",
  "status": "sent"
}

Response Fields

FieldTypeDescription
successbooleanWhether the request was successful
messageIdstringUnique identifier for tracking
phonestringPhone number(s) submitted
statusstringsent, queued, or failed

Phone Number Format

We support Ghana phone numbers in international format (with or without +) and local format. Numbers are normalized automatically before sending.

FormatValidExample
International (no +)✅233200000000 (Ghana)
With + prefix✅+233200000000
Local format✅0200000000

Message Length

TypeCharactersCredits
Standard SMS1-1601
Long SMS (2 parts)161-3062
Long SMS (3 parts)307-4593
Maximum9186
💡

Tip: Keep messages under 160 characters when possible to minimize credits used.

Next Steps

Schedule SMS
Error Responses