SMS API DOCUMENTATION
SMS · Introduction
What is an SMS API?
An API (Application Programming Interface) acts as an interface between the code you write and your SMS Gateway.
This document provides a reference for all features available to you via the HTTP interface for sending SMS.
It is quick to get started (copy and paste a URL directly in your web browser to send a message!) and there is no need to understand the additional or advanced features unless you want to use them.
What is an SMS API?
An API (Application Programming Interface) acts as an interface between the code you write and your SMS Gateway.
This document provides a reference for all features available to you via the HTTP interface for sending SMS.
It is quick to get started (copy and paste a URL directly in your web browser to send a message!) and there is no need to understand the additional or advanced features unless you want to use them.
SMS · Authentication
SMS Authentication
Authenticate every request with your assigned API key and secret pair.
Send credentials over HTTPS and rotate keys regularly to protect your messaging workflows.
Use separate credentials for sandbox and production environments to keep testing isolated.
SMS · API
SMS API Endpoints
The SMS API exposes endpoints for outbound messages, delivery status, and callback integration.
Each endpoint returns structured JSON so your backend can parse outcomes and retries reliably.
Start with the basic send endpoint, then add callbacks and batching as your traffic grows.
SMS · Rate limit
SMS Rate Limits
Rate limits help protect platform reliability and fair usage across all integrations.
When limits are reached, queue or retry requests with exponential backoff.
Plan for burst traffic by monitoring response codes and pacing outbound requests.
SMS · Parameters
Request Parameters
Core parameters include sender ID, destination MSISDN, and message payload.
Validate each field before dispatch to avoid avoidable request failures.
Parameter validation in your app reduces retries and improves delivery reliability.
SMS · Readme
SMS Readme
Use this guide as your quick start reference for integrating the SMS API.
It outlines setup flow, endpoint usage, and response handling at a practical level.
You can ship a working integration quickly, then extend into advanced features when needed.
Example Request
RECEIVING MOBILE REQU...
http
⇆ ⧉
POST / HTTP/1.1
Host: {{USSDBaseURL}}/{{endPoint}}
Content-Length: 123
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXX",
"USERDATA": "3",
"MSGTYPE": false,
"NETWORK": "MTN"
}Example Response
Body
Headers (12)
200 OK
json
⇆ ⧉
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXXX",
"USERDATA": "3",
"MSG": "Welcome 233XXXXXXXXXX.\nThis is NALOTest USSD\nHow are you today\n1. Not bad",
"MSGTYPE": true
}View More
Example Request
RECEIVING MOBILE REQU...
http
⇆ ⧉
POST / HTTP/1.1
Host: {{USSDBaseURL}}/{{endPoint}}
Content-Length: 123
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXX",
"USERDATA": "3",
"MSGTYPE": false,
"NETWORK": "MTN"
}Example Response
Body
Headers (12)
200 OK
json
⇆ ⧉
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXXX",
"USERDATA": "3",
"MSG": "Welcome 233XXXXXXXXXX.\nThis is NALOTest USSD\nHow are you today\n1. Not bad",
"MSGTYPE": true
}View More
EMAIL API DOCUMENTATION
Email · Introduction
Email Introduction
The Email API supports programmatic sending for transactional and campaign workflows.
Configure sender identity, template data, and recipient metadata per request.
Use authenticated requests and webhook feedback for delivery tracking and retries.
Email · Authentication
Email Authentication
The Email API supports programmatic sending for transactional and campaign workflows.
Configure sender identity, template data, and recipient metadata per request.
Use authenticated requests and webhook feedback for delivery tracking and retries.
Example Request
RECEIVING MOBILE REQU...
http
⇆ ⧉
POST / HTTP/1.1
Host: {{USSDBaseURL}}/{{endPoint}}
Content-Length: 123
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXX",
"USERDATA": "3",
"MSGTYPE": false,
"NETWORK": "MTN"
}Example Response
Body
Headers (12)
200 OK
json
⇆ ⧉
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXXX",
"USERDATA": "3",
"MSG": "Welcome 233XXXXXXXXXX.\nThis is NALOTest USSD\nHow are you today\n1. Not bad",
"MSGTYPE": true
}View More
Example Request
RECEIVING MOBILE REQU...
http
⇆ ⧉
POST / HTTP/1.1
Host: {{USSDBaseURL}}/{{endPoint}}
Content-Length: 123
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXX",
"USERDATA": "3",
"MSGTYPE": false,
"NETWORK": "MTN"
}Example Response
Body
Headers (12)
200 OK
json
⇆ ⧉
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXXX",
"USERDATA": "3",
"MSG": "Welcome 233XXXXXXXXXX.\nThis is NALOTest USSD\nHow are you today\n1. Not bad",
"MSGTYPE": true
}View More
USSD API DOCUMENTATION
USSD · Introduction
USSD Introduction
USSD endpoints process menu sessions and return user-facing prompts in real time.
Session payloads include user input, network identifiers, and continuation state.
Keep response logic fast and deterministic to maintain smooth session progression.
USSD · Authentication
USSD Authentication
USSD endpoints process menu sessions and return user-facing prompts in real time.
Session payloads include user input, network identifiers, and continuation state.
Keep response logic fast and deterministic to maintain smooth session progression.
Example Request
RECEIVING MOBILE REQU...
http
⇆ ⧉
POST / HTTP/1.1
Host: {{USSDBaseURL}}/{{endPoint}}
Content-Length: 123
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXX",
"USERDATA": "3",
"MSGTYPE": false,
"NETWORK": "MTN"
}Example Response
Body
Headers (12)
200 OK
json
⇆ ⧉
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXXX",
"USERDATA": "3",
"MSG": "Welcome 233XXXXXXXXXX.\nThis is NALOTest USSD\nHow are you today\n1. Not bad",
"MSGTYPE": true
}View More
Example Request
RECEIVING MOBILE REQU...
http
⇆ ⧉
POST / HTTP/1.1
Host: {{USSDBaseURL}}/{{endPoint}}
Content-Length: 123
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXX",
"USERDATA": "3",
"MSGTYPE": false,
"NETWORK": "MTN"
}Example Response
Body
Headers (12)
200 OK
json
⇆ ⧉
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXXX",
"USERDATA": "3",
"MSG": "Welcome 233XXXXXXXXXX.\nThis is NALOTest USSD\nHow are you today\n1. Not bad",
"MSGTYPE": true
}View More
EMAIL TEMPLATE DOCUMENTATION
Email Template · Introduction
Email Template Introduction
Template resources let you create reusable message layouts with dynamic placeholders.
Version templates safely and validate merge variables before publishing.
Template automation helps teams ship consistent messaging across products.
Email Template · Authentication
Email Template Authentication
Template resources let you create reusable message layouts with dynamic placeholders.
Version templates safely and validate merge variables before publishing.
Template automation helps teams ship consistent messaging across products.
Example Request
RECEIVING MOBILE REQU...
http
⇆ ⧉
POST / HTTP/1.1
Host: {{USSDBaseURL}}/{{endPoint}}
Content-Length: 123
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXX",
"USERDATA": "3",
"MSGTYPE": false,
"NETWORK": "MTN"
}Example Response
Body
Headers (12)
200 OK
json
⇆ ⧉
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXXX",
"USERDATA": "3",
"MSG": "Welcome 233XXXXXXXXXX.\nThis is NALOTest USSD\nHow are you today\n1. Not bad",
"MSGTYPE": true
}View More
Example Request
RECEIVING MOBILE REQU...
http
⇆ ⧉
POST / HTTP/1.1
Host: {{USSDBaseURL}}/{{endPoint}}
Content-Length: 123
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXX",
"USERDATA": "3",
"MSGTYPE": false,
"NETWORK": "MTN"
}Example Response
Body
Headers (12)
200 OK
json
⇆ ⧉
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXXX",
"USERDATA": "3",
"MSG": "Welcome 233XXXXXXXXXX.\nThis is NALOTest USSD\nHow are you today\n1. Not bad",
"MSGTYPE": true
}View More
SMS API DOCUMENTATION
What is an SMS API?
An API (Application Programming Interface) acts as an interface between the code you write and your SMS Gateway.
This document provides a reference for all features available to you via the HTTP interface for sending SMS.
It is quick to get started (copy and paste a URL directly in your web browser to send a message!) and there is no need to understand the additional or advanced features unless you want to use them.
What is an SMS API?
An API (Application Programming Interface) acts as an interface between the code you write and your SMS Gateway.
This document provides a reference for all features available to you via the HTTP interface for sending SMS.
It is quick to get started (copy and paste a URL directly in your web browser to send a message!) and there is no need to understand the additional or advanced features unless you want to use them.
Example Request
RECEIVING MOBILE REQU...
http
⇆ ⧉
POST / HTTP/1.1
Host: {{USSDBaseURL}}/{{endPoint}}
Content-Length: 123
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXX",
"USERDATA": "3",
"MSGTYPE": false,
"NETWORK": "MTN"
}Example Response
Body
Headers (12)
200 OK
json
⇆ ⧉
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXXX",
"USERDATA": "3",
"MSG": "Welcome 233XXXXXXXXXX.\nThis is NALOTest USSD\nHow are you today\n1. Not bad",
"MSGTYPE": true
}View More
Example Request
RECEIVING MOBILE REQU...
http
⇆ ⧉
POST / HTTP/1.1
Host: {{USSDBaseURL}}/{{endPoint}}
Content-Length: 123
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXX",
"USERDATA": "3",
"MSGTYPE": false,
"NETWORK": "MTN"
}Example Response
Body
Headers (12)
200 OK
json
⇆ ⧉
{
"USERID": "NALOTest",
"MSISDN": "233XXXXXXXXXX",
"USERDATA": "3",
"MSG": "Welcome 233XXXXXXXXXX.\nThis is NALOTest USSD\nHow are you today\n1. Not bad",
"MSGTYPE": true
}View More
...Making it happen