Developers
API Documentation
Send your first SMS in minutes. Here are the essentials — the full documentation is online.
Quickstart
Base URL
https://route.kyasms.com/api/v3Authentication
HTTP header: APIKEY: your_keySend an SMS
curl -X POST https://route.kyasms.com/api/v3/sms/send \
-H "Content-Type: application/json" \
-H "APIKEY: kyasms*******" \
-d '{
"from": "KYA SMS",
"to": ["2290166000000", "2349134000000"],
"type": "text",
"message": "Votre code : 4821",
"ref_custom": "cmd-1042"
}'Response 200 OK
{
"reason": "success",
"from": "KYA SMS",
"wallet": "23f918d0-d3f7-448d-a6ce-xxxxx",
"data": [
{
"messageId": "GSM01...",
"status": "ACT",
"to": "2290166000000",
"route": "BJ_MTN",
"price": 8
},
{
"messageId": "GSM02...",
"status": "ACT",
"to": "2349134000000",
"route": "NG_MTN",
"price": 3
},
]
}What the API covers
🔑
Authentication
API key sent in the APIKEY header.
✉️
Sending SMS
One or many recipients in a single request (up to 100,000).
🔐
OTP & Verification
Generate and verify one-time codes.
📢
Campaigns
Bulk sending and scheduling.
🏷️
Sender ID
Customize the sender (alphanumeric).
🔔
Webhooks (DLR)
Real-time delivery receipts, in JSON.
🛒
E-commerce
Shopify, WooCommerce and generic webhook.
🧩
SDK & SMPP
Node.js and PHP SDKs, SMPP connection.
Everything is detailed (parameters, error codes, examples) at docs.kyasms.com
