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
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
_____________________________________
...
Swagger
(Apache 2.0 or RAND)
...
API User Guide / Specification
(RAND)
...
Conformance Profile
(RAND)
...
Sample Implementation Code
...
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
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
Change Management API
The Change Management API provides the standard integration capabilities between external applications and Change Management Application
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
Customer360 API
An API to give a consolidated Customer overview. This is a view-only API, based on the various underlying involved TM Forum Open APIs. This API provides references where one can find detailed information for: Account, Agreement, Appointment, CustomerBill, InteractionItem, LoyaltyBalance, ProductOrder, ProductValue, Promotion, Quote, ServiceProblem, TroubleTicket, UsageSpecification
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
Document Management API
TMF667 Document API describes the meta-data of a Document, such as the name, creationDate and lifecycle status. The (typically binary) body of this document (such as a Word.doc, PDF, Video clip, or Image) will be held in the associated Attachment(s) either by Ref or Value. If by value - the binary content is held in the Attachment.content. If by reference, the Attachment.url might point to a (file:) or remote (http:) pointer to the Document media. A Document may be associated with a DocumentSpecification, which will detail the characteristics of that type of Document (an Image may have a width, height and format; a Video may have a length and format). A Document has a collection of RelatedParty's, for roles such as author, reviewer, publisher, and a lifecycle status to take the document through a simple set of production stages.
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
Entity Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory.
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
Geographic Location Management API
Provides the information of a geographic region of the entity (customer, equipment, address).
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
Metadata Catalog Management API
Metadata Catalog
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
Process Flow Management API
The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
Service Test Management API
Service Test Description
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
| special | @authenticated |
|---|
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
Shipment Management API
Shipment Management
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
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 |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
...
Work Order Management API
The Work Order API performs the following operations on a workOrder resource:
...
| special | @authenticated |
|---|---|
| group | tmforum-members |
| Trackinglink | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Show If | ||
|---|---|---|
| ||
...
...
Note: Reference/Sample implementation is not an architecture direction but a sample in a sandbox