Skip to main content
POST

Body

application/json
command
enum<string>
required

Session phase: initiate (first dial), continue (ongoing), or terminate (close session).

Available options:
initiate,
continue,
terminate
msisdn
string
required

Subscriber mobile number.

operator
string
required

Mobile network operator, e.g. vodacom, tigo, airtel, halotel, ttcl.

session_id
string
required

Unique session identifier for the USSD transaction.

payload
object
required

Response

200 - application/json

Return the next USSD menu or session termination prompt

msisdn
string
required

Echo the subscriber mobile number.

operator
string
required

Echo the operator.

session_id
string
required

Echo the session ID.

command
enum<string>
required

Next session command Beem should apply.

Available options:
initiate,
continue,
terminate
payload
object
required