TMF639 10DLC Number Provisioning

Summary

For users of EnterpriseSMS, EnterpriseSMS10D or EnterpriseSMSTF APIs, that intend to send messages to AT&T users using a source address (sending number) of 18xx-xxx-xxxx or 1-ten_digits, this number provisioning API is used to instruct AT&T to allow the message traffic to traverse our network AND to enable routing of the replies from the AT&T users (MO Messages).

NOTE - While the API supports MMS provisioning, this will only be effective for MMS tollfree numbers. MMS 10Digit messaging does not require the use of this API.

The 10 digit number is defined as a RESOURCE, and the API allows the aggregator to CREATE, DELETE or GET details about the number. A PATCH method will also be made available.

The number provisioning API should be invoked using the OAuth token of the associated sending client (of type EnterpriseSMS, EnterpriseSMS10D or EnterpriseTF API). Use of the wrong OAuth credentials will result in API rejections.
The API checks the Number to be provisioned (or updated) is in the North American ENUM server, and the numbers' assigned NNID is the same as that provisioned for the SMS clientID.

The API asks the client to provision the following items

1. The Number in ten-digit form (without the leading 1)
2. The Brand that owns the number
3. The campaignID (or tollfree verification number)
4. Whether the number is enabled for SMS, MMS or BOTH
5. Whether the number is being used for test purposes only

Notes:
- Only one number is to be provisioned at a time
- The user of the API will be granted a TPS rate in order to provision batches
- Provisioning to AT&T's network happens in real time, the provisioned number can be used immediately
- MMS 10Digit support for MO and DR routing is available in a later release. Please contact your AT&T rep for more information

About the API:

The TeleManagement Forum (TM Forum) is a global industry association for service providers and their suppliers in the telecommunications and digital sectors. It aims to provide a platform for its members to collaborate and create solutions to common industry challenges.

The TM Forum offers a wide range of management and operations standards. One of the key contributions of the TM Forum is its suite of Open APIs, which are designed to provide a standardized and flexible way to integrate systems and ensure interoperability between different vendors and platforms.

TMF639 is part of this suite and focuses on Resource Inventory Management. This API standard is designed to enable the management of physical, logical, or virtual resources within the network.

The primary goal of TMF639 is to provide a standardized interface through which telecommunications service providers perform operations such as querying, updating, and managing the lifecycle of these resources. This ensures that service providers can maintain an accurate and up-to-date view of their available resources, optimize their utilization, and rapidly deploy new services by dynamically allocating and configuring resources as needed.

The API model includes meta-attributes prefixed by @. The @type attribute provides a way to represent the actual class type of an entity 10dlcBusinessMessage inheriting from the TMF639 abstract Resource entity (@baseType). The extended information model includes attributes to support the 10dlc business messaging solution.
The generic support of polymorphism and pattern extensions is described in the TMF API Guidelines v3.0 Part 2 document.