Developer Platform

Build Messaging Apps for Nigeria with Our API

RESTful API with GET and POST support, real-time delivery webhooks, and comprehensive documentation. Integrate NigeriaSMS into your application in minutes.

Get API Key View Documentation

<200ms

API Response Time

99th percentile

Core Endpoints

RESTful API

99.99%

API Uptime

Monthly average

1M+

API Calls/Day

Peak capacity

1Send SMS 2Multiple Recipients 3Delivery Reports 4Campaign Details 5Approved Senders 6Reference Tables

Send SMS via API

Send SMS messages using either GET or POST requests to a single recipient.

Endpointhttps://api2.smsala.com/SendSmsV2

GET Request

GET https://api2.smsala.com/SendSmsV2
  ?apiToken=qyJhKrVLoNCHKl4P
  &messageType=1
  &messageEncoding=1
  &destinationAddress=918744815388
  &sourceAddress=TSTALA
  &messageText=Hello
  &callBackUrl=https://webhook.site/50791112-aea5-406b-a5e5-8a2a6a4eb851
  &userReferenceId=nzwBePCGzXCC6G9rjD31t9kgUIAQ4GRg

Response

[
  {
    "MessageId": 25,
    "OperationCode": 0,
    "Status": "Success",
    "DlrStatus": null,
    "UserReferenceId": "nzwBePCGzXCC6G9rjD31t9kgUIAQ4GRg",
    "DestinationAddress": "918744815388",
    "Remarks": "Message Submitted",
    "CallBackUrl": "https://webhook.site/50791112-aea5-406b-a5e5-8a2a6a4eb851"
  }
]

Request Parameters

Parameter	Type	Required	Description
apiToken	String	Required	API authentication token
messageType	String	Required	Type of message (see values below)
messageEncoding	String	Required	Encoding format (see values below)
destinationAddress	String	Required	Recipient phone number
sourceAddress	String	Required	Sender ID
messageText	String	Required	Message content
callBackUrl	String	Optional	Webhook URL for delivery status
userReferenceId	String	Optional	Unique identifier for tracking

apiToken

StringRequired

API authentication token

messageType

StringRequired

Type of message (see values below)

messageEncoding

StringRequired

Encoding format (see values below)

destinationAddress

StringRequired

Recipient phone number

sourceAddress

StringRequired

Sender ID

messageText

StringRequired

Message content

callBackUrl

StringOptional

Webhook URL for delivery status

userReferenceId

StringOptional

Unique identifier for tracking

Callback (Webhook) Response

Callback Response — Delivered

{
  "messageId": 22,
  "operationCode": 0,
  "status": "Success",
  "dlrStatus": "Delivered",
  "userReferenceId": "nzwBePCGzXCC6G9rjD31t9kgUIAQ4GRg",
  "destinationAddress": 918744815388,
  "remarks": "Dlr Status is : Delivered",
  "callBackUrl": "https://webhook.site/50791112-aea5-406b-a5e5-8a2a6a4eb851"
}

Multiple Recipients

Send the same or different messages to multiple phone numbers in a single API call.

Endpointhttps://api2.smsala.com/SendSmsV2

GET: Separate numbers with a comma in destinationAddress.

POST: Send an array of JSON objects, each with its own destination.

GET — Comma-Separated

GET https://api2.smsala.com/SendSmsV2
  ?apiToken=qyJhKrVLoNCHKl4P
  &messageType=1
  &messageEncoding=1
  &destinationAddress=918744815388,917006129382
  &sourceAddress=TSTALA
  &messageText=Hello
  &callBackUrl=https://webhook.site/50791112-aea5-406b-a5e5-8a2a6a4eb851
  &userReferenceId=nzwBePCGzXCC6G9rjD31t9kgUIAQ4GRg

Response

[
  {
    "MessageId": 3195705,
    "OperationCode": 0,
    "Status": "Success",
    "DlrStatus": null,
    "UserReferenceId": null,
    "DestinationAddress": "918744815388",
    "Remarks": "Message Submitted",
    "CallBackUrl": "https://webhook.site/..."
  },
  {
    "MessageId": 3195706,
    "OperationCode": 0,
    "Status": "Success",
    "DlrStatus": null,
    "UserReferenceId": null,
    "DestinationAddress": "917006129382",
    "Remarks": "Message Submitted",
    "CallBackUrl": "https://webhook.site/..."
  }
]

Delivery Reports (DLR)

Track the delivery status of your messages by querying with a message ID.

Endpointhttps://api2.smsala.com/Dlr/GetDetails

GET Request

GET https://api2.smsala.com/Dlr/GetDetails
  ?apiToken=TrUkkjbzgdshgd
  &messageId=3196185

Response

{
  "IsSuccess": true,
  "ErrorCode": 0,
  "ErrorDescription": "OK",
  "ReturnData": [
    {
      "MessageId": 3196185,
      "DestinationAddress": "917006123394",
      "TextReceived": "Hello",
      "MessageType": "Transactional",
      "MessageLength": 5,
      "MessageParts": 1,
      "CustomerCost": 0.17,
      "DlrStatus": "Delivered",
      "ErrorCode": 1,
      "ErrorDescription": "No Error",
      "SentDateTime": "2025-02-24T06:22:04",
      "Uid": null,
      "SmsId": "db15035c-da41-4f89-aa39-9b89f61d958a"
    }
  ]
}

Campaign Details

Get detailed information about your SMS campaigns including per-recipient delivery status.

Endpointhttps://api2.smsala.com/Dlr/GetCampaignDetail

GET Request

GET https://api2.smsala.com/Dlr/GetCampaignDetail
  ?apiToken=TrUk3bw8fghfdj
  &campaignId=16139
  &startDate=2025-02-24T09:00:00

Response

{
  "IsSuccess": true,
  "ErrorCode": 0,
  "ErrorDescription": "OK",
  "ReturnData": [
    {
      "Id": 16139,
      "Name": "Campaign Name",
      "Submission Date": "2025-02-24T07:15:40",
      "TotalSms": 4,
      "Detail ID": 24876362,
      "Destination Address": "917006123394",
      "DLR Status": null
    },
    {
      "Id": 16139,
      "Name": "Campaign Name",
      "Submission Date": "2025-02-24T07:15:40",
      "TotalSms": 4,
      "Detail ID": 24876363,
      "Destination Address": "917006123397",
      "DLR Status": null
    }
  ]
}

Approved Senders

Retrieve your list of approved Sender IDs and their current status.

Endpointhttps://api2.smsala.com/sender/List

GET Request

GET https://api2.smsala.com/sender/List
  ?apiToken=YOUR_API_TOKEN

Response

{
  "IsSuccess": true,
  "ErrorCode": 0,
  "ErrorDescription": "OK",
  "ReturnData": [
    {
      "CampaignSenderId": 271,
      "SenderId": "INFO",
      "CountryName": "Nigeria",
      "MessageTypeId": 2,
      "MessageTypeName": "Transactional",
      "Details": "Request to whitelist sender",
      "StatusName": "Approved",
      "RequestedBy": "XYZ",
      "RequestedDateTime": "2025-02-24T01:27:47"
    },
    {
      "CampaignSenderId": 270,
      "SenderId": "NigeriaSMS",
      "CountryName": "Nigeria",
      "MessageTypeId": 2,
      "MessageTypeName": "Transactional",
      "Details": "Request to approve sender",
      "StatusName": "Approved",
      "RequestedBy": "XYZ",
      "RequestedDateTime": "2025-02-24T01:27:15"
    }
  ]
}

Reference Tables

Quick reference for message types, encoding values, and delivery status codes.

Message Type Values

Value	Type
1	Promotional
2	Transactional
3	OTP

Encoding Values

Value	Type
1	Default
2	ASCII
3	Octet
4	Latin1
5	Default
6	ASCII
7	Octet
8	Latin1

DLR Status Codes

Code	Status
0	None
1	Enroute
2	Delivered
3	Expired
4	Deleted
5	Undeliverable
6	Accepted
7	Unknown
8	Rejected

Developer Tools

Everything Developers Need

GET & POST Support

All endpoints support both GET and POST methods for maximum flexibility.

Webhook Callbacks

Real-time delivery status updates via configurable callback URLs.

Campaign Analytics

Per-recipient delivery tracking and campaign performance reports.

Sender ID Management

JSON Responses

Clean, structured JSON responses for easy parsing and integration.

Multi-Recipient

Send to multiple numbers in a single API call — comma-separated or array.

Secure Authentication

API token-based authentication for all requests.

DLR Tracking

9 delivery status codes for granular message tracking.

Quick Start

Get Started in 4 Steps

Create Account

Register Sender ID

Submit your Sender ID for approval via the dashboard or API.

Send Test Message

Use the SendSmsV2 endpoint with your API token to send a test message.

Go Live

Start sending production messages and track delivery via DLR endpoints.

Get Free API Key

Customer Stories

What Developers Say About Our API

See what business leaders across Nigeria say about NigeriaSMS reliability and performance.

“The NigeriaSMS API documentation is world-class. Clear, complete, with working code examples. Integrated in 2 hours.”

Seun Runsewe

Senior Engineer

Tech

“RESTful API with predictable responses. NigeriaSMS follows modern API design principles. A pleasure to work with.”

David Ihejirika

Backend Engineer

Fintech

“SDK for Node.js is excellent. Well-maintained, TypeScript support, comprehensive error handling. Production-ready.”

Tobi Amusan

Platform Engineer

Fintech

“Webhook support on NigeriaSMS is reliable and well-designed. Delivery status updates come through instantly.”

Chidi Okeke

Full Stack Engineer

Biotech

“Python SDK saved us weeks of development time. NigeriaSMS client library covers all use cases we needed.”

Ada Obi

API Developer

Health Insurance

“All our portfolio companies integrate NigeriaSMS first. The developer experience is consistently excellent.”

Kola Aina

CTO

“NigeriaSMS API handles concurrent requests beautifully. Rate limiting is fair and well documented.”

Uju Uzo-Ojinnaka

Integration Lead

Fintech

“The sandbox environment is realistic. Testing our integration before going live was smooth and accurate.”

Babatunde Kuku

CTO

Travel Tech

“Campaign analytics API gives us detailed delivery metrics. We built custom dashboards on top of NigeriaSMS data.”

Yemi Kale

Lead Developer

Analytics

“NigeriaSMS API uptime is 99.99%. Our SLA requirements are met. Infrastructure is enterprise-grade.”

Folake Soetan

DevOps Lead

Fintech

“Real-time delivery tracking through NigeriaSMS API helps us keep customers informed about their deliveries.”

Chukwudi Nwosu

Backend Engineer

Logistics

“Integrating NigeriaSMS into our CMS took less than a day. The API is clean and the support team is responsive.”

Ikem Agbasiere

Platform Developer

Media

FAQ

Developer API FAQs

Technical questions answered for developers integrating NigeriaSMS.

NigeriaSMS API uses API Key authentication. Include your API key in the Authorization header as 'Bearer YOUR_API_KEY'. Keys are generated from your dashboard. We recommend rotating keys every 90 days for security best practices.

Nigeria's #1 Business Messaging Platform

Start Building with NigeriaSMS API

Free API key and test messages included. No credit card required.

Start Free Trial Talk to Sales

100 free messages to startNo credit card required24/7 Nigerian support99.9% uptime SLA