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 Beta versions of the Open APIs which are available to TM Forum members or API Project Members only.
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 .
...
| Note |
|---|
| title | To access the API table links below you will need to be logged in |
|---|
|
To login with your TM Forum account please click on the Login button below | Button Hyperlink |
|---|
| title | Login |
|---|
| type | primary |
|---|
| url | https://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable |
|---|
|
Don't have an account? You can register by clicking here: | Button Hyperlink |
|---|
| title | Register |
|---|
| type | primary |
|---|
| url | https://www.tmforum.org/user-registration/ |
|---|
| target | true |
|---|
|
|
...
| id | login-required |
|---|
| title | Login Required |
|---|
...
| Panel |
|---|
|
To access the API documentation you need to be logged in to your TM Forum account | Button Hyperlink |
|---|
| title | Login |
|---|
| type | primary |
|---|
| url | https://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable |
|---|
|
Don't have an account? You can register by clicking here: | Button Hyperlink |
|---|
| title | Register |
|---|
| type | primary |
|---|
| url | https://www.tmforum.org/user-registration/ |
|---|
| target | true |
|---|
|
|
...
| id | members-only |
|---|
| title | For TM Forum Members |
|---|
...
| Panel |
|---|
|
 Image RemovedThank you for your interest in this Early Adopter API.
We're sorry but the documentation is available to members only.
As a non-member, you are welcome to browse ourReleased TM Forum Open API documentation
| Button Hyperlink |
|---|
| title | Browse Released APIs |
|---|
| type | primary |
|---|
| url | https://projects.tmforum.org/wiki/display/API/Open+API+Table#OpenAPITable-ReleasedTMForumOpenAPIs |
|---|
|
| Button Hyperlink |
|---|
| title | Find out more about Membership |
|---|
| type | standard |
|---|
| url | https://www.tmforum.org/membership/benefits/ |
|---|
| target | true |
|---|
|
|
TM Forum Open APIs
Early Adoption (Beta) Versions
...
| sparkName | Sparkline |
|---|
| datepattern | yy-mm-dd |
|---|
| id | 1583007004662_405528633 |
|---|
| sort | Released TM Forum Open APIs (Asc) |
|---|
| isOR | AND |
|---|
| separator | Point (.) |
|---|
...
TM Forum Open APIs
Pre-Production
_____________________________________
...
Swagger
(Apache 2.0)
...
API User Guide
(RAND)
...
Conformance Profile
(RAND)
...
Sample Implementation Code
...
Digital Identity Management API
Provides the ability to manage a digital identity. This digital identity allows identification of an individual, a resource, or a partyRole (a specific role - or set of roles - for a given individual). A digital identity is associated with credential / authentification method. These credential / authentification methods should be extensible to describe all types of authentification method such as login/password, biometric, token, etc.. A contact medium is also associated with digital identity (or directly at credential level) to manage credential recovery UCs.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF720_DigitalIdentity |
|---|
| Name | Digital Identity Management API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
 Image Removed
|
Not Yet Available
Not Yet Available
Not Yet Available
Not Yet Available
Not Yet Available
...
21.5.0
...
Entity Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory.
The Entity Inventory API can be used to query the Entity and Association instances.
The Entity Inventory API can be called by an order management system to create new Entity/Association instances or update existing Entity/Association instances in the Entity Inventory.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF703_EntityInventory |
|---|
| Name | Entity Inventory Management API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
Event Management API
The Event Management API provides a standardized client interface to the enterprise event management system for creating, managing and receiving service related events to (indicatively) drive automation workflows, notify other service providers for service outages and SLA violations, trigger Trouble Ticket creation, and enable more complex orchestration scenarios between management systems. The Event Management API can also be used to convey business level Events in support of other processes.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF688-Event |
|---|
| Name | Event management API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/162957555/TMF688_Event_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Event Management API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
 Image Removed
|
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/172125911/TMF688B_Event_API_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Event Management API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
 Image Removed
|
...
21.5.0
...
Federated Identity API
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, …).
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF691_FederatedIdentity |
|---|
| Name | Federated Identity API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792909/TMF691_Federated_ID_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Federated Identity API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
Geographic Location Management API
Provides the information of a geographic region of the entity (customer, equipment, address).
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF675_GeographicLocation |
|---|
| Name | Geographic Location Management API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
IoT Device Management API Component Suite
In addition to including established TM Forum Open APIs, such as alarm management, resource management and activation APIs, the IoT Device Management API Component Suite also includes an IoT Data Access Endpoint API. This API allows for IoT data access using different types of protocols (MQTT IoT, CoAP, etc.). It encapsulates the protocols and allows devices to be easily integrated into solutions that support a host of IoT initiatives, including smart cities, smart factories and other vertical markets.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF908_IoTAgentAndDeviceComponentSuite |
|---|
| Name | Iot Agent and Device API Suite |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/123085401/TMF908_IoT_Agent_and_Device_Component_Suite_REST_Specification_v1.0.1.pdf?version=1&modificationDate=1592864314038&api=v2 |
|---|
| Name | Iot Agent and Device API Suite |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
IoT Service Management API Component Suite
The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF914_IoTServiceComponentSuite |
|---|
| Name | IoT Service Management API Suite |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143531023/TMF914_IOT_Service_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | IoT Service Management API Suite |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
Payment Method 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.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF670_PaymentMethods |
|---|
| Name | Payment Methods API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/176327026/TMF670_Payment_Method_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Payment Methods API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
Performance Management API
Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF628_Performance |
|---|
| Name | Performance Management API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
Process Flow Management API
The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:
- A ProcessFlow will describe an orchestration of TaskFlow
- In event-based architecture the processFlow are triggered as consequence of event
- TaskFlow could be completed automatically (rules, event triggered, process delegation) or requiring manual action
- Operations on taskFlow allow to update taskFlow
...
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF701_ProcessFlow |
|---|
| Name | Process Flow Management API |
|---|
...
...
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/128869433/TMF701_Process_Flow_Management_API_REST_Specification_R19.0.1.pdf?version=1&modificationDate=1585949431000&api=v2 |
|---|
| Name | Process Flow Management API |
|---|
...
...
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/128869433/TMF701B_Process_Flow_Management_Conformance_Profile_R19.0.1.pdf?version=1&modificationDate=1585949500000&api=v2 |
|---|
| Name | Process Flow Management API |
|---|
...
19.0.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
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF671_Promotion |
|---|
| Name | Promotion API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
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.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF680_Recommendation |
|---|
| Name | Recommendation API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134777000/TMF680_Recommendation_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Recommendation API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146293804/TMF680B_Recommendation_Conformance_Profile_v4.0.0.pdf?api=v2 |
|---|
| Name | Recommendation API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
Resource Activation and Configuration API
The Resource Activation and Configuration API can be used to query resource instances to acquire the resource activation states and attributes, and it can be used to create/update, configure and activate the resource instances.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF702-ResourceActivationConfiguration |
|---|
| Name | Resource Activation and Configuration API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134792913/TMF702_Resource_Activation_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Activation and Configuration API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/162957536/TMF702-ResourceActivation-v4-Postman.zip?api=v2 |
|---|
| Name | Resource Activation and Configuration API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
 Image Removed
|
...
21.5.0
...
Shipping Order Management API
Provides the necessary functionality to create, update and query Shipping Orders. A Shipping Order is a document used by a business to specify what items are to be transferred from a storage location or warehouse to which person and to which new location. A ShippingOrder typically is sent along with a shipment of goods so that the person receiving them can verify that the document correctly reflects the items that they actually received.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF700_ShippingOrder |
|---|
| Name | Shipping Order Management API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
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.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF677_UsageConsumption |
|---|
| Name | Usage Consumption API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
...
21.5.0
...
Work Order Management API
The Work Order API performs the following operations on a workOrder resource:
- Retrieval of a workOrder or a collection of workOrder depending on filter criteria
- Partial update of a workOrder (including updating rules)
- Creation of a workOrder (including default values and creation rules)
- Deletion of a workOrder (for administration purposes)
- Notification of events on a workOrder.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
...
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF697_Work_Order |
|---|
| Name | Work Order Management API |
|---|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
|
Image Removed |
Note: Reference/Sample implementation is not an architecture direction but a sample in a sandbox
page has moved to https://www.tmforum.org/oda/open-apis/table/pre-production