Developer Platform & REST APIs v1.0

API & Developer Documentation

Integrate high-speed Bill Payments, Airtime, Data Bundles, Electricity Tokens, Bulk SMS, USSD Menus, and Statements directly into your software.

Generate API Keys
Production:https://backend.cbivas.com/api/v1
Messaging

Bulk SMS & Messaging API

Send single OTPs, transactional SMS, and mass marketing campaigns with instant delivery callbacks (DLR) and automatic multi-telco failover.

Architecture & Integration Guidelines:
  • Units: Each SMS unit is 160 characters. Messages longer than 160 chars are split and billed per unit.
  • DLR Webhooks: Configure your webhook URL to receive real-time delivery status updates (sms.delivery_status events).
  • Sender IDs: Custom alphanumeric Sender IDs must be pre-registered and approved before use.
DocsBulk SMS & Messaging APIRegister Custom Sender ID
POST/api/v1/sms/sender-ids

Register Custom Sender ID

Submit custom 11-character Sender ID for network operator compliance and regulatory approval.

Request Headers
Header
Value
Authorization
Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type
application/json
X-Channel
api
Request Body
{
  "name": "MYBRAND",
  "use_case": "Transactional OTPs and account security updates",
  "sample_message": "Your account balance has been credited with NGN 50,000.00"
}
Code Execution Playground
Request Snippet (CURL)
curl -X POST "https://backend.cbivas.com/api/v1/sms/sender-ids" \
  -H "Authorization: Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"name":"MYBRAND","use_case":"Transactional OTPs","sample_message":"Your code is 123456"}'
Success Response (200 OK)
{
  "id": "sid_891238",
  "name": "MYBRAND",
  "status": "pending_review",
  "created_at": "2026-08-26T12:00:00Z"
}