USSD/Ussd
Start a USSD session
Start a customer-facing USSD journey through the public API.
/api/v1/channels/ussd/sessionBody Params
| Name | Type | Required | Description |
|---|---|---|---|
| phoneNumber | string | Required | No description provided. |
| ussdCode | string | Required | No description provided. |
| shortCode | string | Optional | No description provided. |
| menuText | string | Optional | No description provided. |
| callbackUrl | string | Optional | Optional callback URL for downstream USSD engine/webhook notifications. |
| initialMenu | string | Optional | Optional initial menu identifier/text to seed the session. |
| sessionData | object | Optional | Optional session data to persist and forward to the downstream engine. |
| category | string | Optional | USSD use-case category (mobile, admin, onboarding, core_banking, marketing, other). |
| deviceType | string | Optional | Device type initiating the session (feature_phone or smartphone). |
| codeType | string | Optional | Dedicated or shared USSD code. |
| country | string | Required | No description provided. |
Response
201CreatedStructured JSON response
Successful requests return JSON matching the structure shown in the response example. Use the example response to validate field names, status handling, and downstream parsing.