API Guides
SMS API
Send and track SMS messages through the Notify Africa Developer API.
The SMS Developer API sends one message, sends batches, schedules recipient-specific messages, and retrieves delivery status.
Get StartedPrepare Portal setup, configure Bearer authentication, and send the first SMS.Send MessagesChoose single, same-content batch, personalized bulk, or scheduled sends.MCP ServerMCPExpose single, bulk, batch, and status SMS tools to MCP-compatible agents.Official SDKsSMSUse SMS SDKs for Node.js, Python, Go, and PHP.
Integration Flow
Create and fund a Notify Africa account in the Portal.
Request and obtain an approved sender ID in the Portal.
Create an API key with SMS access in the Portal.
Send SMS through the Developer API.
Store the returned message UUID.
Poll the Developer API for delivery status.
Responsibility Boundary
| Notify Africa Portal | Developer API |
|---|---|
| Fund the account and inspect credit balance | Send one SMS |
| Request and manage sender IDs | Send the same SMS to multiple recipients |
| Create, rotate, and revoke API keys | Send recipient-specific or scheduled messages |
| Review message activity | Retrieve one message's status |
Portal operations use an interactive account session. Your application uses an SMS-authorized API key. Portal account-management operations are not part of the Developer API.
Public API Surface
| Method | Path | Purpose |
|---|---|---|
POST | /api/v1/api/messages/send | Send one SMS |
POST | /api/v1/api/messages/batch | Send identical content to multiple recipients |
POST | /api/v1/api/messages/send-bulk | Send recipient-specific content or schedule a batch |
GET | /api/v1/api/messages/status/{messageId} | Retrieve one message's status |
Start Here
Portal SetupComplete credits, sender ID approval, and API-key setup before sending.Content And CreditsUnderstand content length, segment calculation, and debit behavior.API ReferenceReview every SMS Developer API endpoint, validation rule, and response.MCP ServerMCPConfigure @notifyafrica/bulk-sms-mcp-server for agent workflows.
Official SDKs remain available under SDKs. The HTTP contract documented here is authoritative for direct API integrations.