How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MTN USSD interface

Provides a RESTful API to expose USSD capability.

MTN USSD interface is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Messaging, Benin, Congo, Côte d’Ivoire, and Cameroon. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 4 operations across 4 paths, organized into 2 resource areas, and defines 8 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://api.mtn.com/v1/.

4 operations 4 paths 8 schemas 1 DELETE3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://api.mtn.com/v1/
Authentication
API Key
Resource Areas
2

Authentication & Security 1

MTN USSD interface declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth).

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 DELETE, 3 POST. They span 2 resource areas: Accessible to 3PP, Accessible to USSD Gateway. Each is listed below with its method, path, parameters, and response codes.

Accessible to 3PP 3

Accessible to Client APP (3PP) - ApiKeyAuth, to subscribe (MO/MT), unsubscribe and push/send message.

POST
/messages/ussd/subscription
The 3PP subscribes/registers to receive USSD MO-generated messages via MADAPI
ussdNotificationStart 1 param → 201400401403404415500501
DELETE
/messages/ussd/subscription/{subscriptionId}
The 3PP unsubscribes/de-registers from receiving/sending USSD MO/MT messages via MADAPI
1 param → 200400401403404415500501
POST
/messages/ussd/outbound
The 3PP sends USSD MT Message to mobile subscriber through MADAPI
sendUSSDRequest 1 param → 201400401403404415500501
Accessible to USSD Gateway 1

Used by USSDGW - using ApiKeyAuth, to send MO generated messages to 3PP through MADAPI.

POST
/messages/ussd/inbound
The USSDGW sends USSD MO-generated message to 3PP through MADAPI
inbound 1 param → 200400401403404415500501

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are InboundRequest (8 properties), Error (7 properties), SubscriptionResponse (5 properties), OutboundResponse (5 properties). Each schema is shown below with its type and property counts.

SubscriptionRequest
object
3 properties 3 required
SubscriptionResponse
object
5 properties 5 required
OutboundRequest
object
5 properties 5 required
InboundRequest
object
8 properties 5 required
InboundResponse
object
5 properties 5 required
OutboundResponse
object
5 properties 5 required
Error
object
7 properties 3 required
Links
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-ussd.yml Raw ↑

Other APIs MTN Group publishes across the network.

MTN Account Decisioning
MTN TMF Customer Bill Management - TMF678
MTN Loans
MTN Subscriber Details
MTN Subscriber Type
MTN Provisioning
MTN Unified Balance V1
MTN TMF Resource Inventory Management - TMF639
MTN Sales Lead
MTN Service Activation and Configuration
MTN Service Ordering
MTN BSS TT OAuth V1
Where this information came from

This is an independent, third-party profile of MTN USSD interface, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.