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

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

Async API Enabled for Trouble Ticket, Async API conpect supporting the event-based architecture

The Change Management API provides the standard integration capabilities between external applications and Change Management Application

Closedloop formally defines a system of “control mechanisms”, “feed forwards”, “feedback” workflows that altogether operates as a framework in which outputs of the system, workflow or process, are circled back (feedback) and used as inputs to improve future outputs. Please refer to IG1219 for the formal TM Forum definition (also check TMF071).

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

Domain Context Specialization of TMF640 for 5G Service Slice, Swagger of Contract is strongly bound to the GSMA Service Definition

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.

No description available yet

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory.

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.

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

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

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

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.

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.

Metadata Catalog

The API Component Suite supports of a set of Operational Domains exposing and managing “Network” Services. These services are referred to as Network as a Service (NaaS) and include all services offered from a service provider including connectivity, end points, media services, etc.

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.Party Role management API manages the following data resources: PartyRole

This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer.

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.

Provides a standardized mechanism for performance management such as creation, partial or full update and retrieval of the resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hocCollection). It allows also notification of events related to performance

Policy API is designed from SID Policy description. The Policy API is defined from Event-Condition-ActionECA definition: The Event part specifies the signal that triggers the invocation of the rule. The condition part is a logical test that, if satisfied or evaluates to true, causes the action to becarried out. The action part consists of updates or invocations on the local data

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. Subscriber scan pass credit between different subscriptions, therefore transferring the balance from one account to another.

The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:

The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:

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. 

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.

Product Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility.

Provides a standardized mechanism for placing a product order with all 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.

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

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 the necessary quote parameters.

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

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.

Provides a standardized interface for Service Level Agreement (SLA) life-cycle Management (SLA Negotiation, SLA configuration SLA Activation/enforcement, SLA Operations, SLA violation / consequence handling, SLA reporting) between a Customer and a Service Provider which provides offers (product with attached SLA in its catalogue) the customer can discover, browse, trigger and order.

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.

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.

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.

The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.

The REST API for Service Order Management provides a standardized mechanism for placing a service order with all the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications.

The Service Test API provides a standardized mechanism for placing a service test with all 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.

No description available yet

Shipment Management

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.

No description available yet

No description yet

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

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.

No description available yet

No description available yet

The Work Order API performs the following operations on a workOrder resource:

The Work Order API performs the following operations on a workOrder resource:

No description available yet

The ZTP API suite v1 captures the essential suite of APIs required to enable multi-party partnering at scale. These APIs reuse the existing TMF Open APIs however there have been up versions to cater for multi-party partnering which have been incorporated into the baseline APIs. The suite covers key functional areas as captured in the TMF916A ZTP API profile v2, Ecosystem Factory, Partner Onboarding Management, Product Onboarding, Partner Event Management, Partner Problem Management. Additional areas will be covered in the next iteration of the suite, Partner Settlement and Billing, Party Knowledge Management, Campaign Management within the Ecosystem, Front End Partner Management within the Ecosystem. The APIs in this suite are based on V4 TMF Open APIs.