Voice NGN Number Management | Colt Developer Portal

Regulatory compliant voice inbound number APIs are available for resellers in an automated environment where you can order IN Geo, Freephone, Shared Cost, Full rate and National Rate numbers and manage your inventory for your end-customers.

Our APIs offer customers the advantages of faster lead times, the highest level of security along with regulatory compliance. This gives you an opportunity to simplify your business processes, build E2E automation and deliver a first class end-customer experience.

Note: Only Colt customers with valid access will receive success response. Other users will receive a mock or failed response.

How to get access to this API?

If you are a Colt customer then please contact your Account Executive.

How to use this API

Click below to download the API user guide.

Download User Guide

Not a customer yet?

Contact our Sales Team

Any misuse of number, whatever nature, might lead to service suspension or number claimed back.

IN Number APIs can be enabled below environments:

Production: live environment. Network, Billing & Emergency services are enabled.
Sandbox: non-production environment for testing the production version of the APIs. Network, Billing & Emergency services are not enabled.

IN Number APIs support E164 international format for {startFullNumber & endFullNumber} in the APIs

Example: French national number range 03.82.50.xx.x0 – x9

Split format: areaCode = 3, areaCodeExtn = 8250, rangeStart = xxx0 & rangeEnd = xxx9
E164 format: startFullNumber = +3338250xxx0 & endFullNumber = +3338250xxx9

Split format to E164 format mapping

Austria (+43), Belgium (+32), Denmark (+45), France (+33), Germany (+49), Ireland (+353), Italy Nomadic (+39), Netherlands (+31), Portugal (+351), Spain (+34), Sweden (+46), Switzerland (+41), United Kingdom (+44) :

startFullNumber = CC + areaCode (without leading 0) + areaCodeExtn + rangeStart
endFullNumber = CC + areaCode (without leading 0) + areaCodeExtn + rangeEnd

Italy Geo (+39):

startFullNumber = CC + areaCode (with leading 0) + areaCodeExtn + rangeStart
endFullNumber = CC + areaCode (with leading 0) + areaCodeExtn + rangeEnd

Germany (+49)

startFullNumber = CC + areaCode + rangeStart
endFullNumber = CC + areaCode + rangeEnd

There can be two types of errors

Synchronous errors: are categorized as programming and access errors.
Asynchronous errors: are related to user program like an error in hardware or operating system.

Error description will be shown when an API throws an Error, typically with a HTTP status code (3xx, 4xx, 5xx) and HTTP status message (Gateway Timeout, Bad Request, Unauthorized etc.)

Error Code	Description	Next Step
200	Success	Order ID is successfully generated- no further action required
400	Bad request	Request was not successful because of any one of the reasons below: Check the request submitted as per the validation error received and resubmit the request. Header or body parameter or Query parameter or API GW tracking ID is missing. Please check and resubmit your request.
401	Unauthorized	Request was not authorized because of any one of the reasons below: Either Access token is not valid or has expired. CLIENT ID and CLIENT Secret or Application ID is not vali Please check the above and resubmit the request.
403	Forbidden	Application has been identified but it is currently suspended. Please contact Colt’s support team.
404	Not found	Resource not found. Please check and resubmit the request.
405	Method not allowed	Entered method (GET/POST) is not correct. Please check and resubmit the request.
406	Not allowed	Request not allowed. Please check and resubmit the request or contact Colt’s support team.
413	Payload too large	The size of response is too large. Please contact Colt’s support team.
415	Unsupported media type	Please provide the correct content type and resubmit the request.
429	Too many requests	Total number of invocations has reached the maximum limit. Please retry after some time.
500	Internal server error	This is an intermittent issue. Please retry to submit the request.
503	Service Unavailable	Please try accessing this API after some time.
504	Gateway Timeout	Please try accessing this API after some time.

Note: Only Colt customers with valid access will receive success response. Other users will receive a mock or failed response.

How to get access to this API?

If you are a Colt customer then please contact your Account Executive.

How to use this API

Click below to download the API user guide.

Download User Guide

Not a customer yet?

Contact our Sales Team

IN APIs are listed and described in the below table:

API	API Type: SOAP or REST	Order Type	Description	Order ID created (Yes/No)
GET/order/{orderId}	REST	N/A	Allows you to get details for a specific order.	No
GET/numberCollection	REST	N/A	Allows you to get: List of free numbers Number inventory details (list of number, number status).	No
POST/numberCollectionReservation	REST	Number Reservation	Allows you to add number in stock without end-customer assignment nor network configuration.	Yes
POST/numberCollectionReservationCancellation	REST	Number Reservation Cancellation	Allows you to return reserved number back to Colt.	No
POST/numberCollectionActivation	REST	Number Activation	Allows you to assign number to an end-customer and activate on Colt network.	Yes
POST/numberCollectionUpdateCustomerDetails	REST	Number Address Update	Allows you to update address and directory service details of an order.	Yes
POST/callBack API	REST	Notification	Allows you to receive order specific notifications whenever order is raised, completed or failed.	No

Status LIVE

Version v2

Maturity status Production

Endpoint (Production) https://apis.colt.net/numberManagement/inbound/v1

Endpoint (Sandbox) https://sandbox.apis.colt.net/numberManagement/inbound/v1

API Documents

NGN_NumberManagement_R3_v1.0.3_5_0.yaml (107.52 KB)