Page History

...

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 .

TM Forum Open APIs

Pre-Production (Beta) Versions

<style>.widget_list {
 margin: 0;
 padding: 0;
}
.widget_list li{
 margin: 0 0 20px;
 padding: 0;
 list-style:none;
}
.widget_list li a{
 display:block;
 color: #000 !important;
 font-weight: 600;
 padding: 10px;
 border:1px solid #ccc;
 background-color:#f6f6f6;
 padding: 25px 25px 25px 80px;
 position:relative;
}
.widget_list li a:hover {
 color: #133595 !important;
 text-decoration: none;
}
.widget_list li a img {
 max-width: 100% !important;
 height: auto !important;
}
.widget_list li a .confluence-embedded-file-wrapper {
 position: absolute;
 width: 50px !important;
 display: block !important;
 left: 10px;
 top: 50%;
 transform: translateY(-50%);
}</style><script src="//app-ab16.marketo.com/js/forms2/js/forms2.min.js"></script><form id="mktoForm_2355" style="display:none"></form><script>MktoForms2.loadForm("//app-ab16.marketo.com", "021-WLD-815", 2355);</script>

TM Forum Open APIs

Early Adoption (Beta) Versions

19.5.0

(v4.0.0)

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’.

20.5.0

(v4.0.0)

Communication API

Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users.

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.

19.5.0

(v4.0.0)

Entity Catalog Management API

The entity catalog is intended to provide any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. The API provides management of the entity specifications and their associations thru CRUD operations.

20.5.0

(v4.0.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.

20.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.

19.5.0

(v4.0.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, …).

20.0.0

(v4.0.0)

Geographic Address Management API

Provides a standardized client interface to an Address management system. It allows looking for worldwide addresses. It can also be used to validate geographic address data, to be sure that it corresponds to a real geographic address. Finally, it can be used to look for a geographic address by: searching an area as a start (city, town ...), then zooming on the streets of this area, and finally listing all the street segments (numbers) in a street.

20.0.0

(v4.0.0)

Geographic Location Management API

Provides the information of a geographic region of the entity (customer, equipment, address).

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?”

Open API Table - Pre-production (Beta)

Open API Table - Pre-production (Beta)

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.

Open API Table - Pre-production (Beta)

Open API Table - Pre-production (Beta)

19.0.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.

Open API Table - Pre-production (Beta)

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. 

19.5.0

(4.0.0)

Pre-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.

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.

Image Removed

Open API Table - Pre-production (Beta)

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.

Open API Table - Pre-production (Beta)

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.

Open API Table - Pre-production (Beta)

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.

Open API Table - Pre-production (Beta)

Open API Table - Pre-production (Beta)

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