Developer guides

Get from API key to production: quickstarts in four languages, testing, webhooks, errors and SMPP, with links to the full API reference.

SDK quickstarts Testing and sandbox Messaging APIs Webhooks and delivery reports Errors and troubleshooting SMPP Going live

These guides walk through the tasks developers do when they add eSMS Africa to an app or a platform. They show the smallest working example and explain the decisions around it, then link to the API reference at docs.esmsafrica.io for every parameter.

Start here

SDK quickstarts

Send your first message from Node.js, Python, PHP or Go.

SMS API quickstart in Node.js: send your first SMS Install esms-sms from npm, create a test key and send your first SMS from Node.js, then check its status and handle errors by code. 6 min readHow to send SMS in Python with the eSMS SDK pip install esms-sms, create a test key and send your first SMS from Python, then read the delivery timeline and handle errors. 4 min readPHP SMS API quickstart: send SMS with Composer Install the esmsafrica/sms package with Composer, send your first SMS from PHP and handle errors. Explains which version Packagist serves today. 5 min readGolang SMS API quickstart: send SMS from Go go get the official esms-go module, send your first SMS with a context and a test key, then read the delivery timeline and handle errors. 4 min read

Testing and sandbox

Build and test without sending real SMS or spending credit.

Test keys and the sandbox: test the SMS API without sending or paying Create a test key and use the SMS API sandbox to simulate every delivery outcome, webhook and OTP check without sending a real SMS or spending balance. 6 min read

Messaging APIs

OTP verification, bulk and batch sends, and number formatting.

Send and check OTP codes with the eSMS Verify API Create a Verify app, then use two calls, start and check, to send one-time codes by SMS and confirm them. eSMS generates, sends, expires and rate-limits the code. 5 min readBulk and batch SMS sending with the API Choose between send-bulk (one text, many numbers) and the personalised batch endpoint (up to 10,000 recipients with merge fields), then track and cancel batches. 6 min readPhone number formatting (E.164) for the SMS API How to write numbers in E.164 for the SMS API, what the API accepts and corrects for you, what it refuses, and how to validate a list before you send. 5 min read

Webhooks and delivery reports

Receive delivery receipts and replies on your server, and verify signatures.

SMS webhooks: receive and verify delivery reports Add your webhook URLs in Settings, verify the HMAC-SHA256 signature on every event, and process delivery reports, replies and campaign events reliably. 6 min read

Errors and troubleshooting

What every error code means and how your code should react.

SMS API error codes and how to handle them A reference of the SMS API error codes you will meet, with the HTTP status each really returns, what it means, how to fix it and which ones are safe to retry. 7 min read

SMPP

Connect an existing SMS platform over SMPP 3.4.

SMPP connection guide: bind to eSMS Africa over SMPP 3.4 Request a bind in the SMPP portal, get your server IP allowlisted, connect over SMPP 3.4 on port 2775, stay within your throughput and read delivery receipts. 6 min read

Going live

Everything to check before you switch to a live key.

Going live checklist for the SMS API Ten checks to run before you swap your test key for a live one: countries, sender IDs, balance, keys, numbers, webhooks, retries, limits, opt-outs and a real test. 5 min read

Frequently asked questions

Where is the full API reference?

At docs.esmsafrica.io/docs/api-reference. These guides explain tasks and link to the reference for every endpoint and parameter.

Can I test without being charged?

Yes. Create a test key (esms_test_...) on the API keys page. Test sends are simulated: nothing is delivered and nothing is charged, and magic numbers let you force each delivery outcome.

Which languages have an official SDK?

Node.js, Python, PHP and Go. You can also call the HTTPS API directly from any language.

Should I use the HTTP API or SMPP?

Use the HTTPS API for apps and websites. SMPP suits existing SMS platforms and aggregators that already speak SMPP 3.4; it needs an allowlisted IP address.

Also in the Help Center eSMS App Dashboard guides Everything you can do in the eSMS SMS dashboard, explained step by step with real screenshots. No coding needed. Help Center All help articles and FAQs Pricing, sender ID rules and compliance for every African country, plus quick answers.

Still stuck?

Our support team answers in the chat, by email and on WhatsApp +254 114 494147.

Create a free account Contact support