logo

Historic Open API table

This table contains Historic versions of the Open APIs. For Production APIs please click here. For APIs in early adoption or still in development please click here.

If you have any questions regarding the content of the Open API table please post them as discussion topics on the Open API Community Forum.

TM Forum Open APIssorted ascendingODA domainDocument numberVersionPublication dateNotes

Account Management API

[Historic]

Provides standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts

Business Partner, CustomerTMF666v2.0.001-Feb-18

No notes

Agreement Management API

[Historic]

The Agreement API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners.

Business PartnerTMF651v2.0.001-Feb-18

No notes

Alarm Management API

[Historic]

The Alarm Management API applies lessons that were learned in previous generations of similar APIs that were implemented in the Telecommunication industry, starting from ITU recommendations, TM Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment initiative between 3GPP and TM Forum interfaces, and the more recent ETSI work on requirements for NFV interfaces.

ResourceTMF642v1.0.001-Feb-17

No notes

Appointment Management API

[Historic]

The appointment API provides a standardized mechanism to book an appointment with all the necessary appointment characteristics. The API allows searching of free slots based on parameters, as for example a party, then creating the appointment. The appointment has characteristics such as nature of appointment, place of appointment.

CustomerTMF646v3.0.001-Feb-18

No notes

Change Management API

[Historic]

The Change Management API provides standard integration capabilities between external applications and Change Management Application. The API consists of a simple set of operations that interact with a Change Request in a consistent manner.

CommonTMF655v3.0.001-Aug-16

No notes

Change Management API

[Historic]

The Change Management API provides standard integration capabilities between external applications and Change Management Application. The API consists of a simple set of operations that interact with a Change Request in a consistent manner.

CommonTMF655v2.0.001-Feb-18

No notes

Communication Management API

[Historic]

Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users.

CommonTMF681v3.0.001-Feb-18

No notes

Customer Bill Management API

[Historic]

This API allows operations to find and retrieve one or several customer bills (also called invoices) produced for a customer also allows operations to find and retrieve the details of applied customer billing rates presented on a customer bill.

CustomerTMF678v3.0.001-Aug-17

No notes

Customer Management API

[Historic]

Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.

CustomerTMF629v3.0.001-Feb-18

No notes

Document Management API

[Historic]

Provides the operations to synchronize documents and document versions across systems. It also provides operations for uploading documents by Users as well as for viewing of documents online

CommonTMF667v2.0.001-Feb-17

No notes

Entity Catalog Management API

[Historic]

The entity catalog is intended to provide any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. The API provides management of the entity specifications and their associations through CRUD operations.

CommonTMF662v3.0.001-Feb-17

No notes

Federated ID Management API

[Historic]

The management of principals of any kind (persons, objects, …) and their access to resources in an open environment which can span across different enterprise boundaries. It relies on authentication, authorization and consent mechanisms to protect privacy with a simple and easy user experience. Different parties can provide identity services (operators, social networks, GSMA, …).

CommonTMF691v3.0.001-Feb-18

No notes

Geographic Address Management API

[Historic]

Provides a standardized client interface to an Address management system. It allows looking for worldwide addresses. It can also be used to validate geographic address data, to be sure that it corresponds to a real geographic address. Finally, it can be used to look for a geographic address by: searching an area as a start (city, town ...), then zooming on the streets of this area, and finally listing all the street segments (numbers) in a street.

CommonTMF673v3.0.001-Aug-17

No notes

Geographic Location Management API

[Historic]

Provides the information of a geographic region of the entity (customer, equipment, address).

CommonTMF675v1.0.001-Aug-17

No notes

Geographic Site Management API

[Historic]

Covers the operations to manage (create, read, delete) sites that can be associated with a customer, account, service delivery or other entities. This API defines a Site as a convenience class that allows easy reference to places important to other entities, where a geographic place is an entity that can answer the question “where?”

CommonTMF674v3.0.001-Aug-17

No notes

Loyalty Management API

[Historic]

Supports the management of loyalty program specifications, loyalty program members, their associated products and loyalty accounts with loyalty balances

ProductTMF658v3.0.001-Feb-17

No notes

Network as a Service Management API

[Historic]

The API Component Suite supports of a set of Operational Domains exposing and managing “Network” Services. These services are referred to as Network as a Service (NaaS) and include all services offered from a service provider including connectivity, end points, media services, etc.

Common, Product, ServiceTMF909v3.0.001-Aug-18

No notes

Partnership Type Management API

[Historic]

Standardized mechanisms for creating partnership types. It is one of the APIs involved in an onboarding process. Identifies a type of partnership between parties, including the list of role types that are permitted (i.e. Buyer, Seller, Developer). Role types may refer to agreement specifications to be signed by parties playing the role. The API allows the retrieval, creation, update, and deletion of partnership type and its owned sub-resources.

Business PartnerTMF668v3.0.001-Feb-18

No notes

Party Interaction Management API

[Historic]

A User Interaction captures information about past interactions in order to re-use it in future ones. This allows agents to serve users better by knowing the steps they went through. It also allows customers to see better the actions they have performed and how they interacted with us.

Business PartnerTMF683v4.0.001-Feb-18

No notes

Party Management API

[Historic]

Provides a standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events.Party can be an individual or an organization that has any kind of relationship with the enterprise.

Business PartnerTMF632v2.0.001-Aug-14

No notes

Party Role Management API

[Historic]

A standardized mechanism for general party roles and includes operations such as creation, update, retrieval, deletion and notification of events. Notice that for the management of customers there is a specific Customer Management API.Party Role management API manages the following data resources: PartyRole

Business PartnerTMF669v3.0.001-Feb-18

No notes

Payment Management API

[Historic]

The Payments API provides the standardized client interface to Payment Systems for notifying about performed payments or refunds. Examples of Payment API originators (clients) include Web servers, mobile app servers, Contact center dashboards or retail store systems. 

CustomerTMF676v1.0.001-Feb-18

No notes

Payment Method Management API

[Historic]

This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer.

CustomerTMF670v3.0.001-Aug-17

No notes

Payment Method Management API

[Historic]

This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer.

CustomerTMF670v2.0.001-Feb-17

No notes

Performance Thresholding Management API

[Historic]

Provides a standardized mechanism for performance management such as creation, partial or full update and retrieval of the resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It allows also notification of events related to performance

TMF649v3.0.001-Feb-17

No notes

Prepay Balance Management API

[Historic]

REST API for Balance Management. It includes the model definition as well as all available operations for prepay balance management. Prepaid subscribers pay fees before using services. Therefore, the subscribers must have sufficient balances. Operators can provide multiple recharge channels for subscribers. Subscribers can pass credit between different subscriptions, therefore transferring the balance from one account to another.

CustomerTMF654v3.0.001-Feb-17

No notes

Product Catalog Management API

[Historic]

Provides a standardized solution for rapidly adding partners’ products to an existing Catalog. It brings the capability for Service Providers to directly feed partners systems with the technical description of the products they propose to them. 

ProductTMF620v3.0.001-Aug-17

No notes

Product Inventory Management API

[Historic]

Provides standardized mechanism for product inventory management such as creation, partial or full update and retrieval of the representation of a product in the inventory. It also allows the notification of events related to product lifecycle.

ProductTMF637v3.0.001-Feb-18

No notes

Product Offering Qualification Management API

[Historic]

Product Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility.

ProductTMF679v2.0.001-Aug-17

No notes

Product Ordering Management API

[Historic]

Provides a standardized mechanism for placing a product order with all the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order negotiation systems in a consistent manner. A product order is created based on a product offering that is defined in a catalog. The product offering identifies the product or set of products that are available to a customer and includes characteristics such as pricing, product options and market.

Customer, ProductTMF622v2.0.001-Aug-17

No notes

Promotion Management API

[Historic]

Used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit

ProductTMF671v3.0.001-Feb-17

No notes

Promotion Management API

[Historic]

Used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit

ProductTMF671v2.0.001-Feb-18

No notes

Quote Management API

[Historic]

The Quote API is one of the Pre-Ordering Management APIs. The customer Quote API provides a standardized mechanism for placing a customer quote with all the necessary quote parameters.

CustomerTMF648v2.0.001-Aug-17

No notes

Recommendation Management API

[Historic]

Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omnichannel.

CustomerTMF680v2.0.001-Aug-17

No notes

Resource Catalog Management API

[Historic]

The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering process.

ResourceTMF634v3.0.001-Feb-17

No notes

Resource Function Activation Management API

[Historic]

This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function

Resource, CommonTMF664v3.0.001-Aug-17

No notes

Resource Function Activation Management API

[Historic]

This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function

Resource, CommonTMF664v2.0.001-Feb-17

No notes

Resource Inventory Management API

[Historic]

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.

ResourceTMF639v2.0.001-Feb-17

No notes

Resource Order Management API

[Historic]

The REST API for Resource Order Management. It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Resource Orders (including filtering). A Resource Order API provides a standard mechanism for placing a Resource Order with all necessary order parameters.

ResourceTMF652v2.0.001-Aug-16

No notes

Resource Pool Management API

[Historic]

Resource Pool management API provides a feature of resource reservation at pre-order phase. In order to reserve a physical product, logical product, and virtual product, the API uses the idea of a resource pool.

CommonTMF685v3.0.001-Feb-18

No notes

SLA Management API

[Historic]

Provides a standardized interface for Service Level Agreement (SLA) life-cycle Management (SLA Negotiation, SLA configuration SLA Activation/enforcement, SLA Operations, SLA violation / consequence handling, SLA reporting) between a Customer and a Service Provider which provides offers (product with attached SLA in its catalogue) the customer can discover, browse, trigger and order.

Business PartnerTMF623v2.0.001-Aug-14

No notes

Self Care Management API

[Historic]

The Self Care API component suite covers the operations required to be exposed in order to provide the functionality required by a SelfCare application used by a Service Provider to allow its customers to manage the services it has subscribed to.

TMF910v1.0.001-Feb-18

No notes

Service Activation Management API

[Historic]

The REST API for Activation and Configuration allows the user to retrieve, create, update, delete services and retrieve the monitor resource used to monitor the execution of asynchronous requests on a specific resource. Although all the examples given in the API specification are relative to Services, the same API can be used to Activate and Configure Services or Resources.

Common, ServiceTMF640v3.0.001-Aug-18

No notes

Service Catalog Management API

[Historic]

The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.

ServiceTMF633v3.0.001-Aug-17

No notes

Service Inventory Management API

[Historic]

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.

ServiceTMF638v3.0.001-Aug-18

No notes

Service Ordering Management API

[Historic]

The REST API for Service Order Management provides a standardized mechanism for placing a service order with all the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications.

ServiceTMF641v3.0.001-Aug-18

No notes

Service Qualification Management API

[Historic]

Service Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location.

ServiceTMF645v3.0.001-Aug-18

No notes

Service Quality Management Management API

[Historic]

Through this API, any Enterprise is able to access a Service Quality Management application and extract Service Level Specifications and associated Service Level Objectives (SLO) and their thresholds.

ServiceTMF657v1.0.001-Feb-18

No notes

Service Test Management API

[Historic]

The Service Test API provides a standardized mechanism for placing a service test with all the necessary test parameters. The API consists of a simple set of operations that interact with CRM/Service Management systems in a consistent manner. A service test is a procedure intended to check the quality, performance, or reliability of a service.

ServiceTMF653v3.0.001-Aug-18

No notes

Shipment Tracking Management API

[Historic]

Shipment Tracking captures information about the current status of the shipment, the past checkpoints and the estimated arrival date. Via this API, tracking information can be retrieved by providing an order ID or the shipping company’s tracking id.

TMF684v1.0.001-Feb-18

No notes

Shopping Cart Management API

[Historic]

A standardized mechanism for the management of shopping carts. Including creation, update, retrieval, deletion and notification of an event. Shopping Cart entity is used for the temporary selection and reservation of product offerings in e-commerce and retail purchase.

CustomerTMF663v2.0.001-Feb-18

No notes

Trouble Ticket Management API

[Historic]

Provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets among partners as a result of an issue or problem identified by a customer or another system. Examples of Trouble Ticket API clients include CRM applications, network management or fault management systems, or other trouble ticket management systems (e.g. B2B).

CommonTMF621v2.0.001-Feb-18

No notes

Usage Consumption Management API

[Historic]

This API provides the real-time value within buckets (SMS, Voice, Data, TV for example) that a customer consumes with each of their devices, related to subscribed communication products without having to wait for the bill cycle. A usage report retrieves the data related to these balances.

ProductTMF677v3.0.001-Aug-17

No notes

Usage Management API

[Historic]

Provides standardized mechanism for usage management such as creation, update, retrieval, import and export of a collection of usages. The API manages both rated and non-rated usage. For example, it allows a service provider to 1) retrieve usage generated by a partner service platform in order to rate it and 2) to provide rated usage to a partner for consumption follow-up purposes.

ProductTMF635v3.0.001-Aug-14

No notes

User Role Permission Management API

[Historic]

A user role is defined as the entity that defines a set of privileges covering various functions and/or manageable assets. When a user is assigned a given role then it is actually allocated all the privileges defined for that role type and the corresponding permissions are created for that user.

CommonTMF672v2.0.001-Feb-17

No notes