API Documentation

Official guide for integrating SMS functionality, checking balances, and retrieving delivery reports via the SMSurWay gateway.

Base URL: https://smsurway.com.ng/portal

2. Authentication

All requests require valid user credentials. Requests without valid credentials will fail.

Parameter	Type	Required	Description
user	String	Yes	SMSurWay account username
pass	String	Yes	SMSurWay account password

POST

3. Send SMS API

Endpoint: /send-sms | URL: https://smsurway.com.ng/portal/send-sms

Request Parameters

Parameter	Type	Required	Description
user	String	Yes	API Username
pass	String	Yes	API Password
from	String	Yes	Sender ID (max 11 chars)
to	String	Yes	Recipient number(s), comma or newline separated
msg	String	Yes	SMS message content
type	String	No	Message type (text default)

Payload Example

POST https://smsurway.com.ng/portal/send-sms
user=smsurway
pass=********
from=SMSurWay
to=2348012345678,2348098765432
msg=Hello, this is a test message
type=text

GET

4. Check Account Balance

https://smsurway.com.ng/portal/check-balance?user=smsurway&pass=********

{
  "status": "SUCCESS",
  "balance": 12500.50,
  "currency": "NGN"
}

GET

5. Delivery Report (DLR)

https://smsurway.com.ng/portal/deliveryreport/{send_id}

DLR Status Values

PENDING

Awaiting Delivery

DELIVERED

Success

FAILED

Failed

EXPIRED

Expired

GET

6. Refresh Delivery Report

Manually refresh delivery status from provider:

https://smsurway.com.ng/portal/deliveryreport/{send_id}/refresh

7. Error Codes

Error Message	Description
Invalid credentials	Wrong username or password
Insufficient balance	Account balance too low
Invalid recipient	Phone number format error