Products
Solutions
- Solutions Solutions
- By Industry
Services
Developers
- Developers
  - Documentation & APIs
Resources
About Us
- About Us

Documentation and APIs

Learn how to use our serverless platform to create voice, video and messaging applications and services by reading our getting started guide. It's the best way to become familiar with the platform architecture and capabilities.

Number Management

SMS

Anonymize

Authenticate – OTP

Authenticate – One Tap Authentication

Engage

Programmable Voice(India)

Programmable Voice (USA)

Number Management

The Number Management APIs focus on enabling your end-customers and partners to be able to search, order and manage service phone number and products directly and instantaneously. A partner can search for phone number products, order numbers, modify active services and manage their account information.

Numbers and Reservations

Orders

Products and Connections

Document Management

Key parameters and resource

Try API

Numbers and Reservations
Orders
Products and Connections
Document Management
Key parameters and resource

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 paymentMethodresource 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:

Any numbers: The system chooses the first available numbers.
Porting numbers: The phone numbers that need to be ported are given.
Reserved numbers: A reservation from a previous number search and reserve is given.
Number ranges: The system chooses the available numbers from a range of numbers.
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:

Determining the productId.
Choosing the applicable API to place an order.

Every order also includes certain characteristics that should be confirmed such as outpulse 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 requestId when placing related multiple orders so as to have a single way to retrieve themlater.

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.

Order Change: Change the characteristic (Outpulse digit, Outpulse Type and Connection Id) of in-service/active number.
Order Delete: Delete the specified numbers from in-service/active number inventory.
Order Delete All: Delete all numbers from in-service/active number inventory.
Order Move:Changes the service emergency address for Domestic calling in-service numbers.

Release 1.1 feature:

Customer can move specified numbers from one SIP trunk to another.
Customer can manage their manual orders via existing API. They can makechange 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 connectionId that tells TCL to use a specific connection/route when putting new numbers into service.

Release 1.1 feature:

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

Document Management

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

Key parameters and resource

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

Parameter	Description
customerId	Unique identifier for customer, created at time of onboarding
contactId	Unique identifier for customer’s contact, created at time of onboarding
paymentMethodId	Unique identifier for customer’s billing preferences, created at time of Onboarding
locationId	Unique identifier for customer’s product location, created at time of onboarding
reservationId	Unique identifier, created when a reservation is requested
orderId	Unique identifier, created when an order is requested
connectionId	Unique identifier for custome’s SIP trunk connections, created at time of onboarding or at creation of addition SIP trunk connections
serviceId	Unique identifier for each in-service number, created at time of order provisioning.
productId	4 enum field: LNS, ITFS, UIFN, DID
connectionType	Mandatory field for order requests, two enum fields: direct or pstn. Choosing direct will route traffic via a SIP trunk connection, thus a connectionId must also be provided in the API request. Choosing pstn will route traffic onto the PSTN network, thus outpulseDigits must also be provided in the API request.
outpulseType	Mandatory field for order requests, two enum fields: sameAsNumber or custom. Choosing sameAsNumber will route traffic to the e164 number itself. Choosing custom will route traffic to a preferred outpulseDigit instead, thus outpulseDigits must also be provided in theAPIrequest. Ifconnection Type is chosenas pstn, outpulseType must be custom.
outpulseDigits	Optional field for order requests, but if connectionType is chosen as pstn, this becomes a mandatory field. The defined outpulse digits will receive a call instead whenever the GSC number is dialed to. outpulseDigits can be changed via the OrderChange API.