Page tree

Versions Compared

Key

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

...

Table Filter
sparkNameSparkline
datepatternyy-mm-dd
id1505484813230_633664360
sortTM Forum Open APIs Early Adopters (‍Asc)
isORAND
separatorPoint (.)
TM Forum Open APIs Early Adopters

API Specification

Postman Collection

Swagger and Swagger_UI

Reference Implementation Code

Download PDF Specification

Conformance

Profile and CTK

Release StatusRelease version

Communication API

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

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF681_Communication_API_REST_Specification_v1.0.1.docx?api=v2
NameCommunication API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soonComing soonComing soon

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF681_Communication_API_REST_Specification_v1.0.1.pdf?api=v2
NameCommunication API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF681_Communication_API_Conformance_Profile_v1.0.1.docx?api=v2
NameCommunication API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Beta17.5.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.

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF678_CustomerBill_API_REST_Specification_R17.5.docx?api=v2
NameBilling Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon 

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
Linkhttps://projects.tmforum.org/wiki/download/attachments/8173047984575796/TMF678_CustomerBill.json?version=1&modificationDate=1507278816000&api=v2
NameBilling Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

 Coming soon 

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/8173047984575796/TMF678_CustomerBill_API_REST_Specification_R17.5.docx?version=1&modificationDate=1507278781000&pdf?api=v2
NameBilling Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/81730479/TMFXXX_CustomerBill_ConformanceProfile-v01_draft.docx?version=1&modificationDate=1505835217000&api=v2
NameBilling Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Beta17.5.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.

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579952/TMF647_Address_API_REST_Specification_R17.0.0.docx?version=2&modificationDate=1507300895753&api=v2
NameGeographic Address Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon  

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579952/GeographicAddressSwagger.json?version=1&modificationDate=1505316331000&api=v2
NameGeographic Address Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

 Coming soon 

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579952/TMF647_Address_API_REST_Specification_R17.0.0.pdf?version=1&modificationDate=1507300900906&api=v2
NameGeographic Address Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579952/GeographicAddressManagement_conformanceProfile-v100-28282017-1.docx?version=1&modificationDate=1505316348000&api=v2
NameGeographic Address Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Beta17.5.0

Geographic Location Management API

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

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579954/Geographic_Location_Management.spec.generated.docx?version=2&modificationDate=1507301350362&api=v2
NameGeographic Location API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

 Coming soon 

 Coming soon 

Coming soon  

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579954/Geographic_Location_Management.spec.generated.pdf?version=1&modificationDate=1507301350927&api=v2
NameGeographic Location API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579954/GeographicLocationManagement_ConformanceProfile-v1.docx?version=1&modificationDate=1507122768000&api=v2
NameGeographic Location API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Beta17.5.0

Geographic Site Management API

Covers the operations to manage (create, read, delete) sites that can be associated to a customer, account, service delivery or other entities. This API defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the  entity that can answer the question “where?”, allowing to determine where things are in relation to the earth's surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a  spatial reference system (geographic location)

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579956/TMF674_GeographicSiteManagement_API_REST_Specification_Proposal_R17.0.0_v1-0-0C_21June17.docx?version=1&modificationDate=1507302002000&api=v2
NameGeographic Site API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon  

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579956/GeographicSiteManagement_v1draft1.swagger.json?version=1&modificationDate=1505316403000&api=v2
NameGeographic Site API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon  

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579956/TMF674_GeographicSiteManagement_API_REST_Specification_Proposal_R17.0.0_v1-0-0C_21June17.pdf?version=1&modificationDate=1507302003000&api=v2
NameGeographic Site API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84579956/GeographicSiteManagement_ConformanceProfile-v100-210617.docx?version=1&modificationDate=1505316418000&api=v2
NameGeographic Site API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Beta17.5.0

Payment Management API

This API allows the following operations. Notify of a performed payment, retrieve a list of payments filtered by a given criteria, retrieve a single performed payment, notify of a performed refund, retrieve a list of refunds filtered by a given criteria and retrieve a single performed refund.

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF_PaymentManagement_API_REST_Specification_Proposal_v1draft1C.docx?api=v2
NamePayment Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
Linkhttps://projects.tmforum.org/wiki/download/attachments/8173515684575796/paymentManagementTMF_v0.1.6.json?version=1&modificationDate=1499267025000&api=v2
NamePayment Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/8173515684575796/TMF_PaymentManagement_API_REST_Specification_Proposal_v1draft1C.pdf?version=1&modificationDate=1505065795000&api=v2
NamePayment Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/8173515684575796/TMF_PaymentManagement_ConformanceProfile-v01draft5.docx?version=1&modificationDate=1499166813000&api=v2
NamePayment Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Beta17.5.0

Product Catalog Management API

The catalog management API allows the management of the entire lifecycle of the catalog elements, the consultation of catalog elements during several processes such as ordering process, campaign management and sales management.

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84582492/TMF620_Product_Catalog_Management_API_REST_Specification_R17.5.0.docx?version=1&modificationDate=1506381134000&api=v2
NameProduct Catalog Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon 

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
Linkhttps://projects.tmforum.org/wiki/download/attachments/84582492/Product_Catalog_Management.regular.swagger.json?version=1&modificationDate=1506381134000&api=v2
NameProduct Catalog Management API

 

 

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon 

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84582492/TMF620_Product_Catalog_Management_API_REST_Specification_R17.5.0.pdf?version=1&modificationDate=1506381134000&api=v2
NameProduct Catalog Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84582492/TMF620_Product_Catalog_Management_Conformance%20_Profile_R17.5.0.docx?version=1&modificationDate=1506381133000&api=v2
NameProduct Catalog Management API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

 Beta17.5.0 

Quote Management API

The customer Quote API provides a standardized mechanism for placing a customer quote with all of the necessary quote parameters. The API consists of a simple set of operations that interact with CRM/Order Negotiation systems in a consistent manner. A customer quote is created based on a product offer that is defined in a catalog.

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84585046/TMF648_Quote_Management.specification_V2.0.0.docx?version=1&modificationDate=1507560971000&api=v2
NameQuote API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
Linkhttps://projects.tmforum.org/wiki/download/attachments/84585046/quote_swagger.json?version=1&modificationDate=1507558889000&api=v2
NameQuote API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84585046/TMF648_Quote_Management.specification_V2.0.0.pdf?version=1&modificationDate=1507560971000&api=v2
NameQuote API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84585046/TMF648_Quote_Management.Conformance.Profile_V2.0.0.docx?version=1&modificationDate=1507561006000&api=v2
NameQuote API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Beta17.5.0

Recommendation API

Recommendation API is used to recommend offering quickly based on the history and real-time context of customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF680_Recommendation_API_REST_Specification_v1.0.0.docx?api=v2
NameCommunication API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soonComing soonComing soon

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF680_Recommendation_API_REST_Specification_v1.0.0.pdf?api=v2
NameCommunication API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF680_Recommendation_API_Conformance_Profile_v1.0.1.docx?api=v2
NameCommunication API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Beta17.5.0

Service Catalog Management API

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

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84578532/TMF633_Service_Catalog_Management_API_REST_Specification_R17.0.docx?version=1&modificationDate=1504708436000&api=v2
NameService Catalog API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
Linkhttps://projects.tmforum.org/wiki/download/attachments/84578532/TMF633_Service_Catalog_Management.regular.swagger_R17.0.json?version=1&modificationDate=1504708572000&api=v2
NameService Catalog API

 

 

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84578532/TMF633_Service_Catalog_Management_API_REST_Specification_R17.0.pdf?version=1&modificationDate=1505125520514&api=v2
NameService Catalog API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84578532/Service_Catalog_Management_API_Conformance_Profile_R17.0.docx?version=1&modificationDate=1504708603000&api=v2
NameService Catalog API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Beta17.5.0

Usage Consumption Management API

This API should allow to view in real-time the balance of the various buckets (SMS, Voice, Data for example) that an user consumes with each of his devices and the usages done out of the bucket. An usage report retrieve the data related to these balances. This API should also allow to perform a direct topup on the balance of a prepaid bucket with voucher references or with a given credit value after a payment done by a credit card or with a credit value transfered.

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF_Usage_Consumption_API_REST_Specification_1.0-06092017%20%281%29.docx?api=v2
NameUsage Consumption API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSwagger
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/usageConsumption_swagger_06092017.json?api=v2
NameUsage Consumption API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Coming soon

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF_Usage_Consumption_API_REST_Specification_1.0-06092017.pdf?api=v2
NameUsage Consumption API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Show If
special@authenticated
matchall
grouptmforum-members
Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/UsageConsumption_ConformanceProfile-v101draft5-0609017.docx?api=v2
NameUsage Consumption API

 

Show If
special@authenticated
matchall
groupnot-tmforum-members

Show If
special@anonymous

Beta17.5.0

...