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 TMF Party Interaction - TMF683

**TMF API Reference : TMF - 683 Party Interaction** **Release : 19.5 - Oct 2019** The Party Interaction Management API provides a mechanism to manage party interactions. Creation, update and retrieval. Including creation, update, retrieval, deletion and notification of event. A Party Interaction captures information about past...

MTN TMF Party Interaction - TMF683 is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include TM Forum, TMF683, Cameroon, and South Africa. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 15 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

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

1 operations 1 paths 15 schemas 1 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/partyInteraction/v1
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

MTN TMF Party Interaction - TMF683 declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It supports OAuth 2.0 (OAuth2) using the application flow. By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

partyInteraction 1
POST
/partyInteraction
Creates a PartyInteraction
createPartyInteraction 1 param → 201400401403405409500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are PartyInteraction (21 properties), InteractionItem (19 properties), PartyInteraction_Create (18 properties), AttachmentRefOrValue (14 properties). Each schema is shown below with its type and property counts.

Attachment
object
Complements the description of an element (for instance a product) through video, pictures...
13 properties
AttachmentRef
object
Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures
9 properties 1 required
AttachmentRefOrValue
object
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
14 properties
InteractionItem
object
19 properties
InteractionRelationship
object
6 properties
Note
object
Extra information about a given entity
7 properties
PartyInteraction
object
21 properties
PartyInteraction_Create
object
Skipped properties: id,href
18 properties 5 required
PartyInteractionStatusExampleType
string
Possible values for the status of party interaction
Quantity
object
An amount in a given unit
2 properties
RelatedChannel
object
Related channel to another entity. May be online web, mobile app, social ,etc.
8 properties 2 required
RelatedEntityRefOrValue
object
A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to…
8 properties 1 required
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 3 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
10 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-tmf-party-interaction-tmf683.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 TMF Party Interaction - TMF683, 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.