TM Forum Open APIs Pre-Production _____________________________________
| Document Number | Swagger (Apache 2.0 or RAND) | API SpecificationUser Guide (RAND) | Conformance Profile (RAND) | CTK | Reference Implementation Code | Postman Collection | Release | Lifecycle Status |
|---|
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. | TMF642 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF642_AlarmManagement |
|---|
| Name | Alarm Management API |
|---|
| |
|
| Show If |
|---|
| 
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta | Communication API Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. | TMF681 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134776981/TMF642_Alarm_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Alarm Management API |
|---|
| |
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
| | Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF681_Communication |
|---|
| Name | Communication API |
|---|
| |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
| Open API Table - Open API Table - Pre-production (Beta) |
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
Customer Bill Management Communication 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. Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. | TMF681TMF678 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF678TMF681_CustomerBillCommunication |
|---|
| Name | Customer Bill Management Communication API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
Event Customer Bill 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. 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. | TMF678TMF688 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF688-EventTMF678_CustomerBill |
|---|
| Name | Event management Customer Bill Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
Geographic Location Event Management API Provides the information of a geographic region of the entity (customer, equipment, address). | TMF675 | 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. | TMF688 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF675_GeographicLocationTMF688-Event |
|---|
| Name | Geographic Location Management Event management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
Geographic Site Location 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?” | TMF674 | Provides the information of a geographic region of the entity (customer, equipment, address). | TMF675 |
| Show Ifshow-if |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF674TMF675_GeographicSiteGeographicLocation |
|---|
| Name | Geographic Site Location Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
Party Interaction Geographic Site 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. 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?” | TMF674TMF683 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF683TMF674_PartyInteractionGeographicSite |
|---|
| Name | Party Interaction Geographic Site Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 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. | TMF676 | |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134776996/TMF674_Geographic_Site_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Geographic Site Management API |
|---|
| |
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | not-tmforum-members |
|---|
| | Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF676_PaymentManagement |
|---|
| Name | Payment Management API |
|---|
| |
Open API Table - Pre-production (Beta) |
| Not Yet Available | | Not Yet Available | Not Yet Available | Not Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (4v4.0.0) | Beta |
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. | TMF683 | 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. | TMF644 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | RANDApache 2.0 |
|---|
| Link | https://projectsgithub.com/tmforum.org/wiki/download/attachments/123090132/TMF644_Privacy-4.0.0.swagger.json?version=1&modificationDate=1573117743866&api=v2-apis/TMF683_PartyInteraction |
|---|
| Name | Party Interaction | Name | Privacy Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (4.0.0) | Pre-production |
Recommendation Payment Management 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. | TMF680The 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 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF676_PaymentManagement |
|---|
| Name | Payment Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 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. | TMF644 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/123090132/TMF644_Privacy-4.0.0.swagger.json?version=1&modificationDate=1573117743866&api=v2 |
|---|
| Name | Privacy Management API |
|---|
| |
|
| Show If |
|---|
|  Image Added
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 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. | TMF680 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF680_Recommendation |
|---|
| Name | Recommendation API |
|---|
| |
|
| | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134777000/TMF680_Recommendation_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Recommendation API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
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.
| TMF702 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF702-ResourceActivationConfiguration |
|---|
| Name | Resource Activation & Configuration API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
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. | TMF634 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF634_ResourceCatalog |
|---|
| Name | Resource Catalog API |
|---|
| |
|
|
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | SwaggerSpecification PDF |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF680_Recommendation |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134776967/TMF634_Resource_Catalog_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Catalog | Name | Recommendation API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
Resource Function 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.
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 | TMF664TMF702 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF702-ResourceActivationConfigurationTMF664_ResourceFunctionActivationConfiguration |
|---|
| Name | Resource Function Activation & and Configuration API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta | 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. | TMF634 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Specification PDF | | Link | https://github.com/tmforum-apis/TMF634_ResourceCatalog://projects.tmforum.org/wiki/download/attachments/134776992/TMF664_Resource_Function_Activation_and_Configuration_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Resource Catalog Function Activation and Configuration API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
Resource Function Activation and Configuration Inventory Management 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 The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory. | TMF639TMF664 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF664TMF639_ResourceFunctionActivationConfigurationResourceInventory |
|---|
| Name | Resource Function Activation and Configuration Inventory API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
Resource Inventory Ordering Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.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. | TMF652TMF639 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF639TMF652_ResourceInventoryResourceOrderManagement |
|---|
| Name | Resource Inventory Order Management API |
|---|
| |
|
| Show If |
|---|
|
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta | 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. | TMF652.5.0 (v4.0.0) | Beta |
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. | TMF657 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF652TMF657_ResourceOrderManagementServiceQualityManagement |
|---|
| Name | Resource Order Service Quality Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta | | | 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. | TMF657 | | Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Specification PDF | | Link | https://github.com/tmforum-apis/TMF657_ServiceQualityManagementprojects.tmforum.org/wiki/download/attachments/134776985/TMF657_Service_Quality_Management_API_User_Guide_v4.0.0.pdf?api=v2 |
|---|
| Name | Service Quality Management API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |
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. | TMF672 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF672_UserRolesPermissions |
|---|
| Name | User Roles & Permissions API |
|---|
| |
|
| Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | Not Yet Available | 19.5.0 (v4.0.0) | Beta |