USSD

Shared USSD

mNotify’s USSD service can be integrated in two modes:

<p class="alert-primary"><i class="las la-info-circle" style="font-size:24px"></i> With the shared USSD service, applications can be hosted on a common short code without the extra cost and time of acquiring a dedicated one. It's quick to setup, affordable, and efficient to launch USSD-based solutions.</p> <h3>HTTP Request</h3>
  POST https://your-server.com/callback-url

<p>This explains how mNotify sends USSD session responses from USSD users to your provided callback URL (<code>your-callback-url</code>).</p> <h3>Expected Response Format</h3>

Your application should respond with a JSON object containing:

  • msisdn 📞 Phone number provided in the request
  • sequenceID 🆔 Sequence ID provided in the request
  • message 💬 Response message for the user’s handset. Use <code>\r\n</code> for line breaks.
  • timestamp 📅 Date and time of the response
  • continueFlag 🔃 Whether the session continues (0) or ends (1).
post/your-server.com/your-callback-url

Request body

msisdnstring required

End user's phone number

sequenceIDstring required

A unique identifier that distinguishes each USSD transaction

datastring required

The request body submitted by the user

timestampstring required

Date and time of the request

Response

Success - Return USSD response

msisdnstring required
sequenceIDstring required
messagestring required
timestampstring required
continueFlag0 | 1 required

Changes

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