Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This table contains links to Beta versions of the Open APIs which are available to to TM Forum members onlyoAPI 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 .

...

Table Filter
sparkNameSparkline
datepatternyy-mm-dd
id15319533468511583007004662_-1199396180405528633
sortReleased TM Forum Open APIs (‍Asc)
isORAND
separatorPoint (.)


TMF681

TM Forum Open APIs

Pre-Production

Document Number

Swagger

(Apache 2.0 or RAND)

API Specification

(RAND)

Conformance Profile

(RAND)

CTK

Reference Implementation Code

Postman CollectionReleaseLifecycle Status

Communication API

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

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
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/
TMF681
TMF642_
Communication
AlarmManagement
Name
Communication
Alarm Management API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
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 TMF678

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.

TMF681


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/
TMF678
TMF681_
CustomerBill
Communication
Name
Customer Bill Management
Communication API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
Image Removed
Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Beta
Geographic Site

Customer Bill Management API

Covers the

This API allows 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

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.

TMF678


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/
TMF674
TMF678_
GeographicSite
CustomerBill
Name
Geographic Site
Customer Bill Management API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
Image Removed
Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Beta
Party Interaction TMF683

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

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
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF688-Event
NameEvent management API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members

Open API Table - Pre-production (Beta)


Show If
special@anonymous

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

Geographic Location Management API

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

TMF675


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF675_GeographicLocation
NameGeographic Location Management API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members

Open API Table - Pre-production (Beta)


Show If
special@anonymous

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

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

TMF674


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF674_GeographicSite
NameGeographic Site Management API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members

Open API Table - Pre-production (Beta)


Show If
special@anonymous

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

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


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF683_PartyInteraction
NameParty Interaction Management API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members

Open API Table - Pre-production (Beta)


Show If
special@anonymous

Open API Table - Pre-production (Beta)


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
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF676_PaymentManagement
NamePayment Management API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members

Open API Table - Pre-production (Beta)


Show If
special@anonymous

Open API Table - Pre-production (Beta)


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
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123090132/TMF644_Privacy-4.0.0.swagger.json?version=1&modificationDate=1573117743866&api=v2
NamePrivacy Management API

 



Show If
special@anonymous

Image Added


Show If
special@anonymous

Open API Table - Pre-production (Beta)


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
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/
TMF683
TMF680_
PartyInteraction
Recommendation
Name
Party Interaction Management
Recommendation API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
special@anonymous

Image Removed

Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(

4Payment Management

v4.0.0)

Pre-production

Beta

Resource Activation and Configuration 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 

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
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/
TMF676_PaymentManagement
TMF702-ResourceActivationConfiguration
Name
Payment Management
Resource Activation & Configuration API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
Image Removed
Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(

4Privacy

v4.0.0)

Pre-production

Beta

Resource Catalog 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

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
matchall
grouptmforum-members


Trackinglink
TypeSwagger
Licence
RAND
Apache 2.0
Linkhttps://
projects
github.
tmforum.org/wiki/download/attachments/123090132/TMF644_Privacy-4.0.0.swagger.json?version=1&modificationDate=1573117743866&api=v2NamePrivacy Management
com/tmforum-apis/TMF634_ResourceCatalog
NameResource Catalog API

 



Show If
special
@anonymousImage Removed
@authenticated
matchall
groupnot-tmforum-members

Open API Table - Pre-production (Beta)


Show If
special@anonymous

Image Modified


Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(

4

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

v4.0.0)

Pre-production

Beta

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

TMF664


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/
TMF680
TMF664_
Recommendation
ResourceFunctionActivationConfiguration
Name
Recommendation
Resource Function Activation and Configuration API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
@anonymousImage Removed
Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Beta

Resource

Catalog

Inventory 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

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

TMF639


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/
TMF634
TMF639_
ResourceCatalog
ResourceInventory
NameResource
Catalog
Inventory API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
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.TMF639

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


Show If
special@authenticated
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/
TMF639
TMF652_
ResourceInventory
ResourceOrderManagement
NameResource
Inventory
Order Management API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members
Image RemovedTMF652
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.

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
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/
TMF652
TMF657_
ResourceOrderManagement
ServiceQualityManagement
Name
Resource Order
Service Quality Management API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
Image Removed
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
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF672_UserRolesPermissions
NameUser Roles & Permissions API

 



Show If
special@authenticated
matchall
groupnot-tmforum-members
Image Removed
Image Removed
Not Yet Available Not Yet Available Not Yet Available Not Yet Available Not Yet Available 

19.5.0

(v4.0.0)

Beta


 

 

 

 

HTML
<script type="text/javascript">
function trackclick(url,type,api){
	woopra.track("click", {
    	"document type": type,
    	title: api,
		"strategic program": "Open API Program",
		program: "API Project",
		topic: "API",
		app: "Confluence",
		permalink: url
		
	}
,redirect(url)
);
//	alert("will redirect to " + url);
}
function redirect(url){
	window.open(url);
}
</script>

...