Page History

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

Archived

N-1

Activation and Configuration API

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.

N-1

Agreement Management API

The Agreement API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners.

N-1

Appointment API

The appointment API provides a standardized mechanism to book an appointment with all the necessary appointment characteristics. The API allows searching of free slots based on parameters, as for example a party, then creating the appointment. The appointment has characteristics such as nature of appointment, place of appointment.

Archived

N-1

Change Management API

The Change Management API provides the standard integration capabilities between external applications and Change Management Application. The API consists of a simple set of operations that interact with Change Request in a consistent manner. A Change Request is an IT service management discipline.

Archived

N-1

Communication API

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

Archived

N-1

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.

Archived

N-1

Customer Management API

Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.

Archived

N-1

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

Archived

N-1

Partnership Type Management API

Standardized mechanisms for creating partnership types. It is one of the APIs involved in an onboarding process. Identifies a type of a partnership between parties, including the list of role types that are permitted (i.e Buyer, Seller, Developer). Role types may refer to agreement specifications to be signed by parties playing the role.
The API allows the retrieval, creation, update, and deletion of partnership type and its owned sub-resources.

Archived

N-1

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.

Archived

N-1

Party Management API

Provides a standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events.
Party can be an individual or an organization that has any kind of relationship with the enterprise.

Archived

N-1

Party Role Management API

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

Archived

N-1

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. 

TMF676

N-1

Payment Methods 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.

N-1

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.

Archived

N-1

Product Catalog Management API

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. 

Archived

N-1

Product Inventory Management API

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.

Archived

N-1

Product Offering Qualification API

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

N-1

Product Ordering API

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

Archived

N-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

Archived

N-1

Quote Management API

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

Archived

N-1

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.

Archived

N-1

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

N-1

Resource Inventory Management API

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

N-1

Service Catalog API

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

N-1

Service Inventory Management API

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

N-1

Service Ordering Management API

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