Operator & Developer API Reference
Empower your development team to build directly across the OmniSMS carrier infrastructure. Connect core banking, ERPs, fintechs, and web/mobile apps with high-throughput JSON endpoints, interactive sandboxes, and carrier-grade SLAs.
Live Operator API Test Sandbox
Simulate real-time requests, test payloads, and examine response latency and headers.
{
"success": true,
"message_id": "MSG_BDI_998124",
"provider": "telecom_direct_burundi",
"operator_route": "Econet Leo (+257)",
"status": "DELIVRD",
"recipient": "+25779123456",
"parts": 1,
"cost": 0.025,
"currency": "USD",
"timestamp": "2026-09-08T10:50:00Z"
}
1. Operator & Telecom Gateway Architecture
OmniSMS operates carrier-grade SMPP v3.4 interconnects and high-capacity HTTP REST adapters directly with telecommunication networks in Burundi (Econet Leo +257 79/71 and Lumitel / Viettel +257 69/68/61) as well as global aggregators (MSG91).
2. Authentication & Headers
Authenticate all REST API requests by including your private API key in the HTTP Authorization header as a Bearer token or using the X-API-KEY header.
Content-Type: application/json
Accept: application/json
/api/v1/sms/send
Dispatches an instant single SMS (OTP, security verification, or notification).
/api/v1/sms/bulk-send
Broadcast up to 1,000 customized SMS messages per API call with per-recipient variable tag mapping.
/api/v1/sms/status/{message_id}
Query real-time delivery status, operator timestamp, and handset delivery receipt.
/api/v1/balance
Check organization floating wallet balance and estimated SMS credits.
7. Real-Time Inbound DLR Webhooks
Configure your webhook endpoint in your Customer Portal. Our gateway will post JSON notifications as carrier handshakes confirm SMS delivery.
8. Multi-Language SDK Snippets
Copy-paste ready implementations for your tech stack.