Getting Started

Register a USSD code with us and submit a callback URL that we will call whenever we get a request from a user coming into our system from telecommunications network.

We will trigger a http GET request to the url provided. You will need to reply with a string to display to the user. A text/plain content type is expected.

Sessions

USSD is session driven and every request will contain a session_id that will be maintained until the session is completed.

You will need to let the Mobile Service Providers know whether the session is complete or ongoing. If the session is ongoing, begin your response with CON example CON Enter your ID number . If this is the last response for that session, begin your response with END. E.g END Thank you for reaching us.

The menus should not contain special characters as the telcos are unable to render such characters and will lead to service disruptions.

Parameters

Parameter	Type	Description
session_id	string	Network generated session identifier.
msisdn	string	Mobile number for the user
network_code	number	Network identifier for the mobile network in use.
ussd_string	string	User input. Its empty in te first notification.After it, it concatenates the inputs with a *until the session ends.
service_code	string	USSD code dialed.

Example Request

Example ussd request pushed to the URL is:

{{callback_url}}?network_code=2541&msisdn=2547XXXXXXX&service_code=123&session_id=70381&ussd_string=1*2