API Reference
Complete endpoint documentation for all eSMS services.
eSMS Mail API
Base URL: https://send.esmsafrica.io
The eSMS Mail API is a RESTful API for sending emails, managing domains, contacts, webhooks, and more. Authentication via API key (esms_k_ prefix) or JWT token.
| Endpoint group | Description |
|---|---|
POST /v1/emails/ | Send emails |
GET /v1/emails/ | List and search emails |
POST /v1/domains/ | Domain management |
POST /v1/contacts/ | Contact lists and bulk send |
POST /v1/webhooks/ | Webhook management |
POST /v1/forwards/ | Email forwarding |
GET /v1/analytics/ | Analytics and metrics |
GET /v1/billing/ | Usage and plan information |
POST /v1/api-keys/ | API key management |
POST /v1/smtp-credentials/ | SMTP credential management |
POST /v1/sender-addresses/ | Sender address management |
Interactive API docs (Swagger UI) are available at send.esmsafrica.io/docs.
SMS Platform API
Base URL: https://sms.esmsafrica.io
The SMS API provides endpoints for sending SMS, phone verification (OTP), and checking delivery status. Authenticate with Authorization: Bearer <api_key> using a key from Developers → API Keys (esms_live_ / esms_test_).
Explore and try every endpoint interactively in the API explorer (Swagger UI), or import the machine-readable spec from /openapi.json.
Send SMS
POST /api/messages/send
Verify (OTP)
POST /api/verify/start · /api/verify/check
Message Status
GET /api/messages/{id}
Routes & countries
GET /api/routes
Pricing
GET /api/pricing
Two-Way SMS
Short code services, inbound messages and replies
eSMS Links API
Base URL: https://links.esmsafrica.io
The Links API creates and tracks short links and QR codes. Authentication via API key (esms_l_ prefix) or JWT token.
Links
POST/GET/PUT/DELETE /v1/links
QR Codes
POST/GET/DELETE /v1/qr
Branded Domains
POST/GET/DELETE /v1/domains
API Keys
POST/GET/DELETE /v1/keys
Analytics
GET /v1/analytics/{id}
Account
GET /v1/account
Auth API
Base URL: https://auth.esmsafrica.io
The Auth API handles user registration, login, password reset, email verification, and subscription management.
Interactive API docs are available at auth.esmsafrica.io/docs.