We are now collecting input for the latest update to our Open API Adoption Assessment Report.Please click here for further information | click here for the vendor survey | click here for the CSP survey |
To access the API table links below you will need to be logged in
TM Forum Open APIs
Production Versions
TM Forum Open APIs _____________________________________ |
Document Number | Swagger (Apache 2.0 or RAND) |
API User Guide / Specification (RAND) |
Conformance Profile (RAND) |
CTK | Sample Implementation Code |
Postman Collection | Release | Version | 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 |
19.0.1
|
v4.0.0
|
Production | ||||||
Agreement Management API The Agreement API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners. |
TMF651 |
19.0.1
|
v4.0.0
|
Production | ||||||
AI Management API Component Suite The API Component Suite for AI Management defines the set of operations that should be offered in order that a Service Provider can govern Artificial Intelligence systems deployed at scale. Effective governance and management of AI must span the lifecycle from design through deployment and eventual withdrawal from service. However, the initial focus of the AI Management API is restricted to the in-life aspects of AI and in particular on the management of ‘model contracts’. |
TMF915 |
20.5.0
|
v4.0.0
|
Production | ||||||
Alarm Management API 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. |
TMF642 |
21.5.0
|
4.0.0
|
Production | ||||||
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 |
19.0.1
|
v4.0.0
|
Production | ||||||
Communication API Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. |
TMF681 |
20.5.0
|
v4.0.0
|
Production | ||||||
Customer Bill Management API 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. |
TMF678 |
20.5.0
|
v4.0.0
|
Production | ||||||
Customer Management API Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events. |
TMF629 |
19.0.1
|
v4.0.0
|
Production | ||||||
General Test Artifact Management API This API provides a standardized mechanism for the management of test artifacts that do not fall into the categories managed by TMF704, TMF705, TMF706, TMF707, or TMF709, such as binaries, jars, etc. |
TMF704 |
21.0.0
|
v4.0.0
|
Production | ||||||
General Test Artifact Management API This API provides a standardized mechanism for the management of test artifacts that do not fall into the categories managed by TMF704, TMF705, TMF706, TMF707, or TMF709, such as binaries, jars, etc. |
TMF710 |
21.0.0
|
v4.0.0
|
Production | ||||||
Geographic Site Management API 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?” |
TMF674 |
20.5.0
|
v4.0.0
|
Production | ||||||
Party Interaction Management API 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. |
TMF683 |
20.5.0
|
v4.0.0
|
Production | ||||||
Party Management API Provides a standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events. |
TMF632 |
19.0.1
|
v4.0.0
|
Production | ||||||
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 |
19.0.1
|
v4.0.0
|
Production | ||||||
Payment Management API 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. |
TMF676 |
20.5.0
|
v4.0.0
|
Production | ||||||
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 |
20.5.0
|
v4.0.0
|
Production | ||||||
Privacy Management API The Privacy management API provides a standardized mechanism for privacy profile types, privacy profiles and privacy agreements such as creation, update, retrieval, deletion and notification of events |
TMF644 |
20.5.0
|
v4.0.0
|
Production | ||||||
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 |
21.0.0
|
v4.1.0
|
Production | ||||||
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 |
19.0.1
|
v4.0.0
|
Production | ||||||
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 |
19.0.1
|
v4.0.0
|
Production | ||||||
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 |
19.0.1
|
v4.0.0
|
Production | ||||||
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 |
19.0.1
|
v4.0.0
|
Production | ||||||
Resource Catalog Management API 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. |
TMF634 |
21.0.0
|
4.1.0
|
Production | ||||||
Resource Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory. |
TMF639 |
20.5.0
|
v4.0.0
|
Production | ||||||
Resource Ordering Management API 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. |
TMF652 |
21.0.0
|
v4.0.0
|
Production | ||||||
Sales Management API The Sales Management API provides interfaces for Sales Lead, Sales Opportunity, Sales Quote and the other management capabilities to support the sales activities to build relationship with the prospect customer who could be a person or organization that has an interest in the goods and/or services and possibly become the actual customers with one or more subscriptions. |
TMF699 |
19.0.1
|
v4.0.0
|
Production | ||||||
Service 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 |
20.5.0
|
v4.0.0
|
Production | ||||||
Service Catalog API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. |
TMF633 |
21.0.0
|
4.0.0
|
Production | ||||||
Service Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory. |
TMF638 |
20.5.0
|
v4.0.0
|
Production | ||||||
Service Problem Management The SPM API is used to manage service problems. Service problems are generated based on the information declared by a partner or the event information notified from infrastructure providers. The event information includes alarm information, performance anomaly information, trouble ticket information, SLA violation, maintenance information, and prediction information. |
TMF656 | Not currently certifiable - there is a new version in development, please refer to the Pre-production table |
18.5.1
|
|
Production | |||||
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 |
20.5.0
|
v4.0.0
|
Production | ||||||
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 |
20.5.0
|
v4.1.0
|
Production | ||||||
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 |
19.0.1
|
v4.0.0
|
Production | ||||||
Stock Management API The Stock Management API provides standardized mechanism for product stock management such as creation, update and retrieval of the representation of a product stock, reserve product stock, check or query product stock or adjust product stock. It also allows the notification of events related to them. |
TMF687 |
21.0.0
|
v4.0.0
|
Production | ||||||
Test Data Management API This API provides a standardized mechanism for the management of test data artifacts used for test case parameterization. These include Test Data Schemas and Test Data Instances. |
TMF706 |
21.0.0
|
v4.0.0
|
Production | ||||||
Test Environment Management API This API provides a standardized mechanism for the management of test artifacts related to test environment specification. These include Abstract Test Environments, Concrete Environment Metamodels used to map abstract environments to concrete test resources, Environment Provisioning Artifacts, and Test Resource APIs exposed to test cases. |
TMF705 |
21.0.0
|
v4.0.0
|
Production | ||||||
Test Execution Management API This API provides a standardized mechanism for test case, test suite, and non-functional test model execution. This also includes allocation and provisioning of test environments for test execution. |
TMF708 |
21.0.0
|
v4.0.0
|
Production | ||||||
Test Result Management API This API provides a standardized mechanism for the management of test results. These include Test Case Results, Test Suite Results, and Non-functional Test Results.pro |
TMF707 |
21.0.0
|
v4.0.0
|
Production | ||||||
Test Scenario Management API This API provides a standardized mechanism for the management of test scenarios. Test scenarios provide a full specification of required test elements, e. g. Test Case T parameterized with test data instance D running on abstract test environment E provisioned with a set of provisioning artifacts P. |
TMF709 |
21.0.0
|
v4.0.0
|
Production | ||||||
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 |
19.0.1
|
v4.0.0
|
Production | ||||||
Usage Consumption Management API 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. |
TMF677 | Not currently certifiable - there is a new version in development, please refer to the Pre-production table |
18.5.1
|
|
Production | |||||
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 |
20.5.0
|
v4.0.0
|
Production |
Note: Reference/Sample implementation is not an architecture direction but a sample in a sandbox