Sign in
USSD

Dedicated USSD

<h3>Dedicated USSD</h3>

When users dial your dedicated shortcode (e.g., *123#), they interact directly with your USSD app.

Dedicated USSD provides full control of the menu, user flow, and branding since the shortcode is not shared.

<p class="alert-primary"><i class="las la-info-circle" style="font-size:24px"></i> mNotify’s Dedicated USSD API allows developers to build custom menus and process user inputs in real-time using HTTP/S requests.</p> <h3>HTTP Request</h3> 
POST https://your-server.com/callback-url
<h3>Expected Response Format</h3>

Respond with a JSON object including:

  • responseExitCode ✅ HTTP response status code (200 = success)
  • shouldClose 🔚 Whether the session ends (true) or continues (false)
  • ussdMenu 📋 The text menu for the user (use \r\n for line breaks)
  • responseMessage ℹ️ Optional info or error message
post/your-server.com/your-callback

Request body

shortCodestring required

The dedicated shortcode assigned

msIsdnstring required

End user's phone number

textstring required

User input during session

sessIdstring required

Unique USSD session ID

ussdGwIdstring required

Operator handling the session (MTN, Vodafone, AirtelTigo)

languagestring

Optional session language

imsistring

IMSI of the SIM card (if available)

optionalstring

Extra parameters from operator

Response

Success - Return USSD response

responseExitCodeinteger
shouldCloseboolean
ussdMenustring
responseMessagestring

Changes

No recorded changes to this endpoint across all 1 revision of this API.