Skip to main content
POST
USSD simulator
Your callback URL must be publicly reachable over HTTPS. The simulator forwards each request to your endpoint via https://ussdsim.beem.africa/.

How to use

1

Set the three body fields

Enter operator, msisdn, and callbackUrl, then click Try it.
2

Verify your handler

Confirm your callback returns the next menu prompt with HTTP 200.

Body

application/json
operator
enum<string>
required

Mobile network operator to simulate.

Available options:
tigotz
Example:

"tigotz"

msisdn
string
required

Subscriber phone number (12 digits, e.g. 255712444555).

Example:

"255712444555"

callbackUrl
string<uri>
required

Your publicly accessible USSD callback endpoint (HTTPS).

Example:

"https://your-app.example.com/ussd/callback"

Response

200 - application/json

Response from your callback handler

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