Telco Gateway
USSD Gateway & Interactive Menus
Provision dedicated or shared USSD codes (e.g. *123*111#), manage interactive menu applications, and handle telco session webhooks.
Architecture & Integration Guidelines:
- Protocol: When a subscriber dials your USSD code, CBI Gateway sends an HTTP POST to your configured callback_url.
- Response Format: Return plain text starting with CON (prompt user for input) or END (terminate session).
- Session timeout is configurable per application (default: 60 seconds). Sessions are identified by unique session_id.
GET
/api/v1/ussd/base-codesList Base USSD Codes
Retrieve available base codes (e.g. *123#) and check next available 3-digit extensions.
Request Headers
Header
Value
Authorization
Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type
application/json
X-Channel
api
Code Execution Playground
Request Snippet (CURL)
curl -X GET "https://backend.cbivas.com/api/v1/ussd/base-codes" \ -H "Authorization: Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx"
Success Response (200 OK)
[
{
"id": "code_1",
"code": "*123#",
"name": "CBI Public Gateway",
"code_type": "shared",
"network_provider": "All Networks (MTN, Airtel, GLO, 9mobile)",
"cost_per_month": "0.00",
"status": "active"
}
]