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.
If you are a Colt customer then please contact your Account Executive.
Click below to download the API user guide.
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:
|
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
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.
If you are a Colt customer then please contact your Account Executive.
Click below to download the API user guide.
Any misuse of number, whatever nature, might lead to service suspension or number claimed back.
IN Number APIs can be enabled below environments:
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 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) :
Italy Geo (+39):
Germany (+49)
|
There can be two types of errors
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:
|
|
401 |
Unauthorized |
Request was not authorized because of any one of the reasons below:
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. |
OAuth 2.0 protocol is implemented to generate access token of JWT token (applicable for 30 mins only) with client credential grant type. You can request up to 5 CLIENT IDs + CLIENT Secret per company account.
If you are a Colt customer then please contact your Account Executive.
Click below to download the API user guide.
API overview
Status LIVE
Version v1
Maturity status PRODUCTION
Endpoint (Production) https://apis.colt.net/authentication
Endpoint (Sandbox) https://sandbox.apis.colt.net/authentication
Errors returned by Auth API
|
Http response |
code |
reason |
message |
details |
|
400 Bad request Colt will return a HTTP-400 error when the request is malformed or invalid. See the message of the error for tips before trying again. |
001 |
Validation not met |
The request is missing authorization parameter. |
The request is missing authorization parameter |
|
002 |
Validation not met |
The request is missing grant_type. |
The request is missing grant_type |
|
|
003 |
Validation not met |
The request is missing content_type header |
The request is missing content_type header |
|
|
004 |
Validation not met |
The request is missing APIGWTrackingId. |
The request is missing APIGWTrackingId |
|
|
005 |
Validation not met |
Invalid input parameter |
The request contains
|
|
|
006 |
Validation not met |
The authorization grant type is not supported by authorization server |
The authorization grant type is not supported by authorization server |
|
|
401 Unauthorized Colt returns a HTTP-401 error when the specified user’s authorization parameter is either invalid or missing or expired. Ensure the provided credentials are valid. |
001 |
Authentication error |
The authorization parameter is missing. |
Client authentication failed due to no client authentication included in the request. |
|
002 |
Authentication error |
The authorization parameter is not valid. |
Client authentication failed due to unsupported authentication method other than Basic. |
|
|
415 Unsupported Media Type Colt will returns a HTTP-415 error when the content-type of the request is incorrect. Ensure the request header contains Content-Type: ‘application/x-www-form-urlencoded’ and try again. |
001 |
Validation not met |
The format of the posted body is not supported by the endpoint. |
The format of the posted body is not supported by the endpoint. |
|
500 Internal server error Colt will return a HTTP-500 Error when an unknown error occurs. If you receive a HTTP-500 error from the Colt API, please open a support ticket with the original request and the response returned. Please be sure to remove any passwords or sensitive information from the support ticket. |
001 |
Internal error |
An unknown internal error occurred |
Generic failure message used if no more precise code can be provided. |
|
002 |
internal error |
O Auth server failed. |
The server failed to generate access token |
|
|
503 Service unavailable Colt will return a HTTP-503 error if the service is unavailable for some reason, such as when there are no servers available to serve the request or if the system is at capacity. If you receive a HTTP-503 error from the Colt API, please try the request again. If you continue to receive HTTP-503 errors, please open a support ticket with the original request and the response returned. Please be sure to remove any passwords or sensitive information from the support ticket. |
001 |
service unavailable |
The service is temporarily unavailable |
Backend unavailable. |
OAuth 2.0 is the industry-standard protocol for authorization. This API returns an JSON web token (JWT) which is required to authorize API calls for a given app.
You can request up to 5 CLIENT_ID + CLIENT_Secret per company account.
API features
API Rate Limit
An API rate limit will be applied to protect our platforms from excessive resource usage caused by external attacks or misconfiguration from our customers. We will count API requests and return a HTTP 429 (Too Many Requests) response when the quota (XXX) is exceeded. In case you would reach the limit, you will have to wait max YYY secs before we will process again the requests.
The Trouble Ticket API provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets as a result of an issue or problem identified by a customer or another system.
If you are a Colt customer then please contact your Account Executive.
Click below to download the API user guide.
How to get access to this API?
If you are a Colt customer then please contact your Account Executive.
Test 2How to use this API
Click below to download the API user guide.
Download User Guide
Not a customer yet?
Contact our Sales Team
