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.
GET
/api/v1/sms/messagesList SMS Message History
Retrieve paginated SMS delivery history with status, cost, and delivery metadata.
Request Headers
Header
Value
Authorization
Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type
application/json
X-Channel
api
Query Parameters
Parameter
Type
Description
page
integer
Page number (default: 1)
page_size
integer
Items per page (max: 100)
status
string
'sent', 'delivered', 'failed', 'pending'
Code Execution Playground
Request Snippet (CURL)
curl -X GET "https://backend.cbivas.com/api/v1/sms/messages?status=delivered" \ -H "Authorization: Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx"
Success Response (200 OK)
{
"items": [
{
"id": "msg_78123891",
"phone": "+2348012345678",
"sender_id": "CBISUITE",
"message": "Your OTP is 492019.",
"status": "delivered",
"units": 1,
"cost": "4.50",
"gateway_message_id": "gtw_2910239",
"created_at": "2026-08-26T12:00:00Z"
}
],
"total": 1,
"page": 1,
"page_size": 20
}