eSMS AfricaeSMS Africa
API Reference

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. Authenticate with Authorization: Bearer <api_key> using a live (esms_k_) or test (esms_test_) key, or a dashboard session JWT. Collection paths end in a slash (/v1/emails/); without it the API answers with a 307 redirect.

Endpoint groupDescription
POST /v1/emails/Send emails
GET /v1/emails/, GET /v1/emails/searchList 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/overview, /timeseries, /breakdown, /exportAnalytics and metrics
GET /v1/billing/usage, /plans, /accountUsage and plan information
POST /v1/api-keys/API key management
POST /v1/smtp-credentials/SMTP credential management
POST /v1/sender-addresses/Sender address management
POST /v1/templates/Email templates
GET /v1/suppressions/Suppression list
GET /v1/inboxReceived mail (dashboard inbox)
GET /v1/deliverability/auditDomain authentication audit

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.

Base URL: https://links.esmsafrica.io

The Links API creates and tracks short links and QR codes. Authentication via Authorization: Bearer with an API key (esms_l_ prefix) or an eSMS Africa session JWT.

Auth API

Base URL: https://auth.esmsafrica.io

The Auth API handles user registration, login, password reset, email verification, and subscription management. It powers the eSMS Africa dashboards and is not a public integration API: to send SMS or verify phone numbers, use an API key with the SMS Platform API above. Create and manage your account at auth.esmsafrica.io.

On this page