Guide v2.0

Richmo API Guide

Integrate Sri Lanka's most reliable SMS gateway into your workflow with our high-performance REST APIs. Built for speed, scale, and developers.

Infrastructure

Base URL

All API requests must be directed to the following endpoint. We recommend using HTTPS for all requests.

URL https://portal.richmo.lk
Endpoint

Send SMS (Bearer Auth)

The primary method for sending messages using industrial-standard Bearer Token authentication.

GET /api/sms/send/

Request Parameters

Parameter Type Description
dst Required String Recipient phone number in international format (e.g., 9477xxxxxxx).
from Required String Your approved Sender ID (Mask).
msg Required String UTF-8 URL Encoded message content.

Implementation Sample

cURL
PHP
Python
curl --request GET 'https://portal.richmo.lk/api/sms/send/?dst=947xxxxxxxx&from=[mask]&msg=Hello' \
--header 'Authorization: Bearer [API_TOKEN]'
Endpoint

Simple Integration

Authentication token is passed via request parameters for simpler implementations.

GET /api/v1/sms/send/

Query Parameters

Parameter Type Description
key Required String Your unique API Key.
dst Required String Recipient phone number.
cURL
PHP
curl --request GET 'https://portal.richmo.lk/api/v1/sms/send/?dst=947xxxxxxxx&from=[mask]&msg=Hello&key=[API_KEY]'
Account

Check Account Balance

Programmatically check your remaining SMS credits.

GET /api/account/balance/
JSON Response
{
    "status": "success",
    "balance": 1250.50,
    "currency": "LKR",
    "updated_at": "2024-05-03 20:00:00"
}