Numbers and Reservations

A developer may search for availability of Numbers, by geography, number type, vanity (specific digit patterns), contiguous blocks of numbers and other search criteria. TCL’s number inventory returns matching numbers if available. It is possible to subsequently create a Reservation for these numbers. After completing a search of the available number inventory most number products allow for any chosen numbers to be “reserved” during the ordering processes. A reservation stays valid for 10 minutes after which those numbers are released back as available inventory other users. Use the /reservations API calls to make and manage your reservations. It is very easy to place a subsequent order by simply providing an active reservation identifier.

Orders

The Orders API is used to buy one or more sets of number products that are offered by TCL. Orders are how a Product is purchased. The information and parameters necessary for order submission include a completed Customer resource configured with the Account Management API and a completed payment Method resource in the Billing API.

Bulk Ordering via Order APIs.

For any product, there are 4 distinct styles that can be used to submit an order for numbers:

1. Any numbers: The system chooses the first available numbers.
2. Porting numbers: The phone numbers that need to be ported are given.
3. Reserved numbers: A reservation from a previous number search and reserve is given.
4. Number ranges: The system chooses the available numbers from a range of numbers.
5. Direct Ordering: The system provision numbers which user passes after fetching from TATA Inventory.

API developers should follow a simple, discrete design semantic when placing orders. Discrete means that there are separate API calls to place orders for a specific product, in one country, for a specific order type; with each call being an independent, complete order that can be correlated via an external identifier. For placing an order, the 2 steps are required:

1. Determining the product Id.
2. Choosing the applicable API to place an order.

Every order also includes certain characteristics that should be confirmed such as out pulse type, CLID type, etc., as well as the country it is being ordered in. A discrete order lets a developer create multiple, composable orders that become simple to understand on a per-product, per-number-style, per-country basis. It is strongly recommended to use a single request Id when placing related multiple orders so as to have a single way to retrieve them later.

Managing active numbers via order APIs.

Active or In-service number products may be moved, changed, or removed from service. These are achieved via an Order, along with /change, /move or /delete API command based on what you want to do.

1. Order Change: Change the characteristic (Out pulse digit, Ou tpulse Type and Connection Id) of in-service/active number.
2. Order Delete: Delete the specified numbers from in-service/active number inventory.
3. Order Delete All: Delete all numbers from in-service/active number inventory.
4. Order Move: Changes the service emergency address for Domestic calling in-service numbers.

Release 1.1 feature:

1. Customer can move specified numbers from one SIP trunk to another.
2. Customer can manage their manual orders via existing API. They can make change request, cancel request, move request product location request.

Products and Connections

Customers that have in-service Products can review details about them using the Products & Connections API. Subscribed products will reflect active services that have been previously ordered (whether ordered via Number Management APIs or other processes). As ordered products go into service, they are delivered via Connections. These connections identifiers route traffic between networks and can be used to specify routing preferences or for numbers to use specific trunks. They are also relevant when buying more numbers since an Order can include a connection Id that tells TCL to use a specific connection/route when putting new numbers into service.

Release 1.1 feature:

1. Customer can change/update the connection for a given connection Id.
2. Customer can see in-service numbers order via manual process.

Document Management

Customers have Document Management API module to fetch the regulatory documents required to fulfill an order based on the order Id. Once customers see the document, they can upload using POST document upload method.

Key parameters and resource

The following key parameters and resources are used in the Number Management APIs.