---
title: "Shared USSD"
method: POST
path: "/your-server.com/your-callback-url"
tags: ["USSD"]
---

# Shared USSD

`POST /your-server.com/your-callback-url`

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>

```http
  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`).

## Request body

- object
  - `msisdn` string, required — End user's phone number
  - `sequenceID` string, required — A unique identifier that distinguishes each USSD transaction
  - `data` string, required — The request body submitted by the user
  - `timestamp` string, required — Date and time of the request

## Response `200`

Success - Return USSD response

- object
  - `msisdn` string, required
  - `sequenceID` string, required
  - `message` string, required
  - `timestamp` string, required
  - `continueFlag` 0 | 1, required

---

[API](https://skmtc.dev/mnotify/apis/bms-documentation.md) · [All operations](https://skmtc.dev/mnotify/apis/bms-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mnotify/bms-documentation/revisions/c06855f2ed03/schema)
