The increasingly complex multi-partner digital services value chain raises new challenges in terms of ensuring time-to-market, seamless management, cost-effectiveness and revenue sharing.
In order to meet these challenges, TM Forum members including the world’s largest service providers and suppliers, have been working to develop APIs that enable the open digital ecosystem and provide critical management functionality to digital services.
This table contains links to both Release and Beta versions of the Open APIs.
By default, the information in the table is sorted by API title, but can be re-sorted (for example, by Document Number or Release Version) by clicking on the relevant column headings.
Please note that Comments are no longer permitted on this page. 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.
To access the API table links below you will need to be logged in
TM Forum Open APIs
TM Forum Open APIs _____________________________________ | Document Number | Swagger (Apache 2.0 or RAND) | API Specification (RAND) | Conformance Profile (RAND) | CTK | Reference Implementation Code | Postman Collection | Release | Lifecycle Status |
---|---|---|---|---|---|---|---|---|---|
Account Management API 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 | TMF666 | Not available | Not available | Not available | 18.0.1 | Archived N-1 | |||
Activation and Configuration API 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. | TMF640 | 18.5.1 | Archived N-1 | ||||||
Agreement Management API The Agreement API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners. | TMF651 | Not available | Not available | Not available | 18.0.1 | Archived N-1 | |||
Appointment API 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. | TMF646 | Not available | Not available | Not available | 18.0.1 | Archived N-1 | |||
Change Management API The Change Management API provides the standard integration capabilities between external applications and Change Management Application. The API consists of a simple set of operations that interact with Change Request in a consistent manner. A Change Request is an IT service management discipline. | TMF655 | Not available | Not available | Not available | Not available | 16.5.1 | Archived N-1 | ||
Communication API Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. | TMF681 | Not available | Not available | Not available | 17.5.1 | Archived N-1 | |||
Customer Management API Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events. | TMF629 | Not available | Not available | Not available | 18.0.1 | Archived N-1 | |||
Partnership Type Management API Standardized mechanisms for creating partnership types. It is one of the APIs involved in an onboarding process. Identifies a type of a 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. | TMF668 | Not available | Not available | Not available | 18.0.1 | Archived N-1 | |||
Party Management API Provides a standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events. | TMF632 | Not available | Not available | 14.5.1 | Archived N-1 | ||||
Party Role Management API 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. | TMF669 | Not available | Not available | Not available | 18.0.1 | Archived N-1 | |||
Payment Methods API This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer. | TMF670 | Not available | 17.0.1 | Archived N-1 | |||||
Prepay Balance Management API 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. | TMF654 | Not available | Not available | 17.0.1 | Archived N-1 | ||||
Product Catalog Management API 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. | TMF620 | 17.5.1 | Archived N-1 | ||||||
Product Inventory Management API 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. | TMF637 | Not available | Not available | Not available | 18.0.1 | Archived N-1 | |||
Product Offering Qualification API Product Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility. | TMF679 | Not available | Not available | Not available | 17.5.1 | Archived N-1 | |||
Product Ordering API Provides a standardized mechanism for placing a product order with all of 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. | TMF622 | Not available | 17.5.1 | Archived N-1 | |||||
Promotion API 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 | TMF671 | Not available | Not available | Not available | 17.0.1 | Archived N-1 | |||
Quote Management API 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 of the necessary quote parameters. | TMF648 | Not available | 17.5.1 | Archived N-1 | |||||
Recommendation API 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 omni-channel. | TMF680 | Not available | Not available | Not available | Not available | 17.5.1 | Archived N-1 | ||
Resource Function Activation and Configuration API 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 | TMF664 | Not available | Not available | Not available | 17.0.1 | Archived N-1 | |||
Service Catalog API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | TMF633 | Not available | Not available | Not available | 17.5.1 | Archived N-1 | |||
Service Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory. | TMF638 | 18.5.1 | Archived N-1 | ||||||
Service Ordering Management API The REST API for Service Order Management provides a standardized mechanism for placing a service order with all of the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications. | TMF641 | Open API Table - Previous (N-1) Versions | 18.5.1 | Archived N-1 | |||||
Service Qualification API Service Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location. | TMF645 | Not available | Not available | Not available
| 18.0.1 | Archived N-1 | |||
Service Quality Management API 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. | TMF657 | Not available | Not available | Not available | Not available | 16.5.1 | Archived N-1 | ||
Service Test Management API The Service Test API provides a standardized mechanism for placing a service test with all of 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. | TMF653 | 18.5.1 | Archived N-1 | ||||||
Archived N-1 Shopping Cart API 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. | TMF663 | Not available | Not available | Not available | 18.0.1 | Archived N-1 | |||
Trouble Ticket API 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). | TMF621 | Not available
| Not available | Not available
| 18.0.1 | Archived N-1 | |||
Usage Consumption Management API This API should allow viewing in real-time the balance of the various buckets (SMS, Voice, Data for example) that a user consumes with each of his devices and the usages done out of the bucket. A usage report retrieves the data related to these balances. This API should also allow performing a direct top-up on the balance of a prepaid bucket with voucher references or with a given credit value after a payment done by a credit card or with a credit value transfer. | TMF677 | Not available | Not available | Not available | 17.5.1 | Archived N-1 | |||
Usage Management API 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. | TMF635 | Not available | Not available | 14.5.1 | Archived N-1 |