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.
To login with your TM Forum account please click on the Login button below
| Button Hyperlink | ||||||
|---|---|---|---|---|---|---|
|
Don't have an account? You can register by clicking here:
...
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 .
...
| special | @authenticated |
|---|
...
| title | To access the API table links below you will need to be logged in |
|---|
page has moved to https://www.tmforum.org/
...
| id | login-required |
|---|---|
| title | Login Required |
...
| Panel | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
To access the API documentation you need to be logged in to your TM Forum account
Don't have an account? You can register by clicking here:
|
...
| id | members-only |
|---|---|
| title | For TM Forum Members |
...
| Panel | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
TM Forum Open APIs
Pre-Production (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)
...
Reference Implementation Code
...
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.
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
Communication API
Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users.
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
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.
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.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 |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.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 |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
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?”
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
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.
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(4.0.0)
...
Pre-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.
...
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(4.0.0)
...
Pre-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.
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
|
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(4.0.0)
...
Pre-production
...
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 |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.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 |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
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.
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
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
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
Resource Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
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.
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
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.
...
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
User Roles & Permissions API
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.
...
| special | @authenticated |
|---|---|
| match | all |
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Show If | ||
|---|---|---|
| ||
...
19.5.0
(v4.0.0)
...
...