A comprehensive set of APIs which underpin Colt’s Wholesale SIP service. These APIs enable you to activate new phone numbers and port-in existing phone numbers to Colt in a sandbox environment with a “try it out” feature or in the production environment.

API Details:

Status

LIVE

Version

v1

Maturity status

Production

Endpoint (Production)

https://apis.colt.net/numberManagement/resourceName

Endpoint (Sandbox)

https://sandbox.apis.colt.net/numberManagement/resourceName

 

Below are the list of Wholesale SIP APIs (with resource names)

Operation

API resource name

Method

Description

Search free number(s)

/v1/freeNumber

GET

Allows you to get list of free numbers

Search number(s) from the inventory

/v1/Number

GET

Allows you to search your number from your number inventory with multiple search criteria (by status, customer reference, orderID, CLI details). You can also fetch the number details (end customer name, status, address, customer Registration Number) by providing numberRangeStart and numberRangeEnd parameters

Reserve number(s)

/v1/reservation/order

POST

Allows you to add or reserve number in stock without endcustomer assignment nor network configuration. Number will be reserved for 90 calendar days.

Return number(s)

/v1/return/order

POST

Allows you to return the number to Colt by cancelling the reservation of reserved numbers and deactivating Activated/Port-in Activated numbers.

Activate number(s)

/v1/activation/order

POST

Allows you to assign number to an end-customer and activate on Colt network.

Update end customer details and directory service details

/v1/updateCustomer/order

POST

Allows you to update activated number details, e.g. emergency address and Directory services(for few countries only) etc.

Port number(s)

/v1/portIn/order

POST

Allows you to create new port-in order.
Please note: Out of hours porting is chargeable.

Update porting order

/v1/portUpdate/order

POST

Allows you to updatea porting order (change date, cancel, modify, send notes, accept/reject port out order, schedule port, activate port)

Portability checker

t/v1/checkPortability

POST

API to allow you to confirm whether a number/range can be ported-in

Reactivate number(s)

/v1/reactivation/order

POST

Allows you to reactivate colt owned or ported in numbers. Number will be reassigned to the same end-user, Network will be reconfigured, and number will be ready to be used again.

Bulk activation

/v1/bulkActivationOrder

POST

Allows you to send bulk request for activation API.

Bulk portIn

/v1/bulkPortInOrder

POST

Allows you to send bulk request for portIn API.

Bulk end customer/ DS details

/v1/bulkUpdateCustomerDetailsOrder

POST

Allows you to send bulk request for address/DS update API.

Fetch list of orders

/v1/order

GET

Allows you to get list of orders matching your search criteria.

Fetch order details

/v1/order/{orderId}

GET

Allows you to get details for a specific order.

CLI Order History

/v1/CLIOrderHistory

GET

Allows you to get list of orders for a specific number.

Fetch free number count

/v1freeNumberCount

GET

RESTRICTED USE ONLY
allows you to get the count of free numbers for given LAC

Lock free numbers

/v1/lockFreeNumbers

POST

RESTRICTED USE ONLY
allows you to get the list of free numbers in locked state for 10 mins for a given LAC

Request for free numbers backfill

/v1/freeNumberBackfill/order

POST

RESTRICTED USE ONLY
Allows you to request for free number backfill for a specific location

Cancel backfill request

/v1/cancelFreeNumberBackfill/order

POST

RESTRICTED USE ONLY
Allows you to cancel a free number backfill request which has been submitted and which is not yet fulfilled.

 

 

Please note: If you use the "Try it out" feature in the production environment, then charges will apply as per your Wholesale SIP ratecard.  For more information on pricing, please contact your Account Manager. 

 

 

Title
Introducing Wholesale SIP Trunking APIs

Wholesale SIP (Number Hosting) is Colt Wholesale SIP trunking with on Demand Number Management supporting high volume transactions (reservation, activation, porting) via our Numbers on Demand (NOD) portal and our APIs. We have pan-European coverage in 20 countries, with full regulatory compliance and a uniform experience for Carrier Grade SIP Trunks.

Wholesale SIP addresses Service Providers with their own VoIP platform who want to build, integrate and sell their own VoIP & Cloud solutions under their own brand to their business end-customers. We are the digital infrastructure provider, underpinning Hyperscalers' & OTTs' growth in the Cloud Voice market.

We are a one stop shop, enabling you to order new geographic & nomadic numbers, as well as Port-In numbers over API and in our NOD portal for your end-customers. This gives you an opportunity to simplify your business processes, build E2E automation, and deliver a high quality end-customer experience.

Colt Wholesale SIP APIs are based on REST JSON. Our Next Gen REST APIs:

  • Conform to the Industry standard REST-JSON APIs
  • Align with TMF conventions
  • Support OAuth2.0 and JWT based authentication and authorization
  • Support open API specifications (earlier swagger)
  • Support flexible version management
  • Optimized fields and offer a standard format for numbers, date-time, etc.

List of Wholesale SIP (Number Hosting) Countries

Please find below country supported in Colt APIs:

Country

Country Code

Zone A

Austria

AT

Belgium

BE

Denmark

DK

France

FR

Germany

DE

Ireland

IE

Italy

IT

Netherlands

NL

Portugal

PT

Spain

ES

Sweden

SE

Switzerland

CH

United Kingdom

GB

Zone B

Luxembourg

LU

Slovakia

SK

Finland

FI

Norway

NO

Czech Republic

CZ

Romania

RO

Poland

PL

Our full list of terms and conditions, alongside our acceptable use policy is available below.

Read our terms and conditions

 

Germany: 100+ Range Allocation

German Regulator Bundesnetzagentur (BNetzA) defines the maximum range sizes for new subscribers in the document ‘Struktur und Ausgestaltung des Nummernbereichs für Ortsnetzrufnummern‘.

A German and an English version are available on the homepage of BnetzA:

  1. Bestimmung der Anzahl zuzuteilender Rufnummern bei durchwahlfähigen VoIP-Anschlüssen
  2. http://www.bundesnetzagentur.de/cln_1431/DE/Sachgebiete/Telekommunikation/Unternehmen_Institutionen/Nummerierung/Rufnummern/ONRufnr/Ortsnetze_Basepage.html?nn=268384

(Struktur und Ausgestaltung des Nummernbereichs für Ortsnetzrufnummern)

  1. https://www.bundesnetzagentur.de/EN/Areas/Telecommunications/Companies/NumberManagement/GeographicNumbers/LocalNumbers_Basepage.html?nn=404520

(Structure and configuration of the number range for geographic numbers)

For a block greater than 100, the allocation must be approved by BnetzA before assigning numbers to the end-customer.

Process is as per the following:

  • Customer sends the request form to BnetzA
  • Official timeline for BnetzA to answer is 3 weeks, but less than 1 week in practice.
  • Customer sends the approval to Colt
  • Customer can assign the numbers.

It’s the customer’s responsibility to engage with BnetzA and share the confirmation with Colt.

Request form is available below in German/English. It can be filled out in both languages; the other language will be populated automatically.

Austria

There is a private numbering plan in Austria.  When you assign a single main number to an end-customer, the end-customer can configure or add digits/extensions (0-9 or 00-99 or 000-999 or 0000-9999) to the main number in their PBX, as per their needs.  You do not need to inform Colt of the range of extensions/digits when (de/re) activating a number, submitting a port-in order or sending an address update – these transactions require the main number only.  The end-customer’s emergency address is entered and stored at the main number level, and not at the extension level.

 

France: Hosted customer numbers

There are 2 important Regulatory changes impacting the use of phone numbers in France, which came into effect on 1st January 2023:-

1.            The resale of geographic and location independent numbers for outbound voice services is forbidden

2.            France no longer has 400+ local area codes.  01-05 numbers are available for use throughout mainland France

ARCEP, the Regulator in France, published further information on these changes here: https://www.arcep.fr/uploads/tx_gsavis/22-1583.pdf

If you are reselling Colt numbers to your end-customers under your own brand, then you need to take action to register with ARCEP and obtain your own numbers, which Colt can then host on your behalf.  You can contact your Colt Account Manager to complete the order form to host your number blocks with Colt.  For further information, please refer to these links to the Customer Q&A in English and in French.

Hosting your numbers

When we confirm your own numbers are available to use, you will be able to reserve and (pre)activate your own numbers, update addresses etc.  As a result of the Regulatory changes above you will only need to search for numbers on the basis of the LAC: 01-05 and the LAC extension or search by city will no longer be available - should you need the historical reference, please refer to the Number Coverage file.  Your own numbers will be available in ranges of 1, 10, 100 as requested in your order form.  If you run out of single numbers, then our system will automatically take a range of 10 Free numbers and split this into 10 Free single numbers and similar logic applies if you run out of ranges of 10 etc.  You can also view or query for your Free numbers in France and this enables you to monitor your own inventory and apply to ARCEP for new number blocks in good time – the E2E lead-time is 2-3 months depending on ARCEP, Orange & OLO availability during busy periods.

If you have obtained your own routing/porting prefix in France then you can select this when you port-in a number.

We will return deactivated numbers from your number blocks to your “free” pool of numbers at the end of the quarantine & frozen period.  We will return numbers which were ported-out and which have been cancelled / deactivated by the end-customer into your “free” pool of numbers at the end of the quarantine & frozen period, using our established processes & system integration with APNF.

The responsibility to supply compliance reports or to comply with regulatory audits is yours.  Colt will provide a clear view of your number inventory  - the number status & end-customer data via our APIs & Numbers on Demand which you can use to meet these requests together with your own data. 

Tri-partite agreement with Colt numbers

If you do not have your own numbers from ARCEP yet, then from 21st January 2023 you are responsible for submitting a tri-partite agreement with every order for new Colt number activations. The tri-partite agreement template can be found in English here and in French here.  You are responsible for filling in your own company details, the numbers being ordered, entering the accurate address details of your end-customer and obtaining the end-customer’s signature. 

France: Introduction of RIO codes for the wider business market

There are some changes to the use of RIO codes in France, which came into effect from 1st December 2023, pursuant to Arcep’s decision no 2022-2148.

A RIO code is a unique identifier associated to a telephone number, which is created when a consumer or small business request a new telephone number in France and its purpose is to facilitate the portability process.  If they wish to move / port numbers to a new operator, then the new operator will request the RIO code provided by the current operator for each single telephone number from the consumer / small business in order to validate that the port order is legitimate and to implement the porting order.  These RIO codes are not yet mandatory in the wider business market but this will gradually change.

The changes are:

  1. Colt, as a technical operator, must define a unique RIO code for every:
    1. Colt geographic or location independent number
    2. Geographic or location independent number ported-in to Colt
    3. Geographic or location independent number hosted by Colt on your behalf – this includes both new and ported-in numbers where you have mandated Colt as your OPTA (i.e. where we technically manage the porting of your numbers on your behalf)
  2. Colt must make these RIO codes available to you via a secure portal, which is our Numbers on Demand portal and over API and these will be available in our May 2024 release.   Up until the May 2024 release, if you require the RIO code for e.g. a consumer / small business port, then please get in touch with [email protected].

It is not foreseen that RIO codes will be required for number portability in the wider business market until 2025, due to the complexity of inter-operator process & system integration work and pursuant to Arcep’s decision.

In a wider context, if you currently support consumers, we would like to remind you that consumer-specific obligations apply pursuant to the regulations, including the provision of an IVR service through which you provide the RIO code associated to a specific number.

As an operator providing voice services in France, you are responsible for portability to your end-customers and other operators, even where Colt is technically managing portability for you as your OPTA.  Obligations regarding how the RIO codes should be shared with your subscribers apply, as well as other obligations related to portability (i.e. additional information to be provided to your subscribers,  contractual provisions, etc.). Obligations may vary depending on the customer type (business, small business, consumer) and the kind of service you provide (OTT, single-number or multi-number offers, etc.).

For further information please see this decision from ARCEP: https://information.colt.net/hubfs/22-2148_FR_Published%20document_22Mar2023%20en-GB.pdf

The RIO code will be present against each CLI in the Numbers on Demand portal when viewing the ‘Number Details’ and will be returned in the B2B API response (SOAP/HTTPs: getNumberDetails and REST: GET/CLIDetails) as well.

Portugal & Spain: Introduction of CIF/NIF/VAT ID check

In May 2024 we have introduced an external check on the CIF/NIF/VAT ID in Portugal and Spain against the European Commission’s VAT Information Exchange System (VIES). – see: https://europa.eu/youreurope/business/taxation/vat/check-vat-number-vies/index_en.htm.   The reason is to improve the accuracy and validity of orders for new numbers and ports as explained below:

  • The VAT ID/CIF is included in the CVP generated by Colt for an end-customer and is highly confidential.  The CVP was introduced by the PT Regulator, Anacom, to give greater security to end-customers.  End-customers must include their CVP in a future port order to prove their request is genuine.
  • As requested by the ES Regulator, CNMC, the VAT ID/CIF/NIF must be uploaded into the emergency database in Spain and be an exact match to the registered end-customer name.

In Numbers on Demand portal you will see the extra validation step on the CIF/NIF/VAT ID in Portugal & Spain when activating a number, porting-in a number and updating an end-customer address, including bulk orders.  In both Portugal and Spain if your end-customer has only recently registered for VAT and their details are not yet in VIES, then you can enter their VAT ID by selecting “NIF//CIF/VAT ID not registered” and your order will proceed as normal.

Spain: Number Type offerings

Number Type offerings

‘Geo’

‘Geo-nomadic’

‘Nomadic’

Description

LAC can be used only for the applicable city / town

LAC can be used within the province for any city / town

LAC can be used across entire country of Spain

Local Area Codes (LACs)

LACs starting with 8- Please refer to Number Coverage file present in www.colt.net/cocom

LACs starting with 8- Please refer to Number Coverage file present in www.colt.net/cocom

512/516

Free Number Search

Yes

Yes

Yes

LAC Validation

Yes

Yes

No

Port-in/ Port-Out

Yes

No

No

Quarantine Period

30 calender days

30 calender days

30 calender days

numberType (used for ‘Free’ number search

Geo

Geo

Non Geo

Colt Number Life Cycle

The below diagram provides a view of number status [cliStatus] transition based on API action:

num life cycle

 

    1.  

Ported-In Number Life Cycle

The below diagram provides a view of number status [cliStatus] transition based on API action:

ported lifecycle

 

Number Format

Colt REST APIs support these number formats:

  • E164 international format, combination of {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), Czech Republic (+420), Denmark (+45), Finland (+358), France (+33), Germany (+49), Ireland (+353), Italy Nomadic (+39), Luxembourg(+352),Netherlands (+31), Norway (+47), Poland (+48), Portugal (+351), Romania (+40), Slovakia (+421), 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

Number Status 

Please find the list of resourceStatus supported by Colt APIs, with associated country availability & description.

resourceStatus

Country

Description

Free

All

Colt free number you can search and acquire, or customer owned numbers (FR only)

Reserved

All

Colt Number in your stock, and/or customer owned numbers (FR only)

Network is not configured & no end-customer assigned.

Reservation period = 90 days.

Allocated

All

Intermediate status for Colt number or customer owned numbers (FR only) during activation process.

No action possible.

Activated

All

Colt number in your stock, and/ or customer owned numbers (FR only)

Network is configured & end-customer assigned (variance applicable for Premium offer).

Quarantined

All

Following a deactivation, Colt number and/or customer owned numbers (FR only) stays in your stock during quarantine period as Quarantined.

Network is not configured & no end-customer assigned.

Quarantine period varies per country.

For zone B country: when Colt perform hard cease, the numbers will move to this status

PortIn_Allocated

All except DE

After port-in order has been confirmed (transactionStatus = Firm order commitment), ported-In number will appear in your stock as PortedIn_Allocated.

Network is not configured & no end-customer assigned.

No action possible.

PortIn_Activated

All

Ported-In number in your stock.

Network is configured & end-customer assigned.

PortIn_Quarantined

FR, NL, PT, CH, SE, ES, IT

Following a deactivation, Ported-In number stays in your stock during quarantine period as PortIn_Quarantined.

Network is not configured & no end-customer assigned.

Quarantine period varies per country.

Port-In Reactivation can be requested

PortIn_Reallocated

FR, NL, PT, CH, SE, ES, IT

When Port-In reactivation is requested, the numbers goes into intermediate status.

Network configuration and end customer re-assignment is in progress.

No action possible.

Port Out In Progress

All except DE

When a port-out request is raised for Colt-owned numbers which will be ported out from Colt’s network to new operator.

No action possible.

Transfer In Progress

All except DE

When a port-out request is raised for Ported-In numbers which will be ported out from Colt’s network

and is scheduled to be transferred to new operator.

No action possible.

Return In Progress

All except DE

When a port-out request is raised for Ported-In numbers which will be ported out from Colt’s network

and is scheduled to be returned to the original range holder.

No action possible.

PortOut

All

When Colt-owned numbers are ported out from Colt’s network

Transferred

All except DE

When a ported-in number is ported out of Colt’s network and is transferred to new operator

Returned

All except DE

When a ported-in number is ported out of Colt’s network and is returned to original range holder

 

 

Number Action & Transition

The below table provides status transition depending on user action and country:

Number Source

Country

User

REST API (resource name)

Current cli status

Next cli status

Colt

All

Customer

/v1/reservation/order

Free

Reserved

Colt

All except IT

Customer

/v1/activation/order

Free

Activated

Colt

All

Customer

/v1/activation/order

Reserved

Activated

Colt

All

Customer

/v1/return/order

Reserved

Free

Colt

All except Zone B countries

Colt System

(reservation period expiration)

Reserved

Free

Colt

(Premium Only)

All except DE

Customer

Address Update- (ADD) REST API

/v1/updateCustomer/order

Activated

Activated

Colt & Ported-In

All

Customer

Address Update- (MODIFY) REST API

/v1/updateCustomer/order

Activated

PortIn_Activated

Activated

PortIn_Activated

Colt

All

Customer

/v1/return/order

Activated

Quarantined

Ported-In

FR, NL, PT, CH, ES

Customer

/v1/return/order

PortIn_Activated

PortIn_Quarantined

Ported-In

AT, BE, CH, DK, IE, IT, SE, GB

Customer

/v1/return/order

PortIn_Activated

Returned

Colt

All

Customer

/v1/reactivation/order

Quarantined

Activated

Colt

All except Zone B countries

Colt System

(quarantine expiration)

Quarantined

Activated

Ported-In

FR, NL, PT, ES, SE, CH

Customer

/v1/reactivation/order

PortIn_Quarantined

PortIn_Activated

Ported-In

FR, NL, PT, CH, ES

Colt System

(quarantine expiration)

PortIn_Quarantined

Returned

Colt

All (20)

Colt

portOut (Internal only)

Activated

PortOut

Ported-In

All (20)

Colt

portOut (Internal only)

PortIn_Activated

Returned

Ported-In

All (20)

Colt

portOut (Internal only)

PortIn_Activated

Transferred

Order ID

After order creation, a unique ID [orderID] will be returned to you.

orderID follows the below pattern and format:

Description

Pattern

32 character long (128 bit)

Format

“[A-Za-z0-9\-]{1,36}“

Maximum length

36, including ‘-’ characters

Example

8700206f-c3b3-4c10-8cc2-2490f41eedc0

  1.  

Order Status

Your order will have a status [orderStatus], that will vary over the time and the scenarios.

Non porting related orders have a 2 steps update: ‘In progress’, from order creation until completion, and then the final status.

Please find below orderStatus and description:

orderStatus

Description

Next action

In progress

Your order is in progress, usually the first step.

No action required.

Completed

Your order has been completed.

No action required.

Failed with error

This error, also known as a business error

Occurs when you have submitted incorrect information.

Please review the error message, correct and resubmit the request.

Please note: If a failure occurs whilst updating the Emergency Database for the order types below, a message: “Your order is technically completed and pending for emergency database update" will be shared as a new Order Description.  Order types are:-

  • Activation
  • Deactivation
  • Address Update
  • Reactivation
  • Port-In
  • Port-Out

Email notifications will be triggered for Port-In and Port-Out orders with the same message. Post the successful completion of an order which reflects the successful update of the Emergency Database, the order description will be updated to: “Request has been processed successfully.”

Applicable for all countries except DE, DK and Zone B.

Porting related orders have multiple updates, at each key order milestone.

  • For port updates, Colt API will return a new orderID, named ‘Child Order ID’.
  • Please track child orderID to get status of the update (mainly for cancellation & date change) and please continue to track parent ID to get order status.

Please refer to porting sections for more information.

Please find below list of the ones applicable to Port-In orders:

orderStatus

Country

Description 

Validation In Progress

All except NL

Order validation is pending at Colt end. Status is applicable:

  • As first status after order submission.
  • After customer has provided additional, i.e., after ‘Customer feedback awaited’

Submitted to operator

All

The order has been sent to releasing operator for port negotiation.

Firm order commitment

All

Order has been confirmed by the losing operator with:

  • The First Possible Date (FPD) in the Netherlands (usually within the next 48 hours).
    • FPD is the soonest date numbers can be ported-in. It can be any day within the next 120 calendar days.
    • Please note that an overall FPD will be returned for order with multiple ranges and different FPD.
    • You can schedule the port (optional).
  • Agreed port date & window in the other countries.

Ready for porting Initiation

NL

Once the FPD is reached, order status will change automatically to ‘Ready for Porting Initiation’.

You can initiate or schedule the Port within the next 90 calendar days.

Please note that order will automatically expire 90 calendar days after FPD if port has not been initiated.

Email notification will be sent 10 days before expiration, every day until expiration.

Porting initiated

All except NL

Port has been initiated by Colt.

Completed

All

Port has been completed.

No further action possible.

Customer feedback awaited

All except NL

Additional information is required by Colt and/or the releasing operator.

Please note order will expire after 72 hours if no update provided by customer.

Delayed

All except NL

Port has been delayed before the initiation of porting. Colt will provide the reason.

Porting Completion Delayed

All except NL

Port has been delayed after the initiation of porting. Colt will provide the reason.

Expired

All except NL

Order automatically expires after:

  • 90 calendar days after the FPD if initiation has not been performed in the Netherlands.
  • 72 hours for order in ‘Customer Feedback Awaited’ status (i.e. if you have not provided updates to the order) in the other countries.

No further action will be possible.

Cancelled

All

Order has been cancelled. No further action will be possible.

Rejected

All

Order has been rejected by Colt. Rejection code and reason will be shared.

No further action will be possible.

Porting failed

All except NL

The port has been rolled back to the releasing operator.

No further action will be possible.

For more details on Porting, please click here.

Port-In in the Netherlands

The below diagram provides a view of order status transition based on API action:

NL port in

Please note that Port-In process is fully automated with direct connection to National Porting Database (COIN). Colt Porting Desk only manages complex and Out of Hours orders.

    1.  

Port-In in the Other Countries

The below diagram provides a view of order status transition based on API action:

port in other

When a port-out request will be received by Colt from another provider, Colt will create a portOut order and notification will be sent to you. In some countries, you will be asked to confirm or reject the request.

Port Out Order Status

port-out order might have additional status [orderStatus] than the ones described in the section 2.5.

Please find below list of the ones applicable to port-out orders:

orderStatus

Country

Description

Confirmed

All except AT, BE, DE, CH, NL

In countries where your confirmation is not required, this will be the order status, mainly until port-out completion.

Number status will be ‘Port out In progress/ Transfer In progress / Return In progress’.

Customer feedback awaited

BE, CH

In countries where your confirmation is required, this will be the first order status. You will be asked to accept or reject the request.

Colt will automatically accept the request on your behalf after 2 working days.

Daily reminders will be sent to you to accept the port out request once the order is created in “Customer feedback awaited” status.

Number status will be ‘Port out In progress/ Transfer In progress / Return In progress’.

Customer feedback awaited

AT, DE

In countries where your confirmation is required, this will be the first order status. You will be asked to accept or reject the request.

Colt will automatically accept the request on your behalf after 5 working days

Daily reminders will be sent to you to accept the port out request once the order is created in “Customer feedback awaited” status.

Number status will be ‘Port out In progress/ Transfer In progress / Return In progress’.

Customer feedback awaited

NL

In NL, where your confirmation is required, this will be the first order status. You will be asked to accept or reject the request.

You will have 2 working days to:

  • Accept the request and provide the First Possible Date (FPD) for the Port-Out,
  • Decline the request with the relevant blocking code.

Same as port-in, FPD is the soonest numbers can be ported-out and should be any day within the next 120 calendar days.

Please note that Colt will automatically accept the request and set the FPD to the next business day on your behalf after 48 hours.

Number status will be ‘Port out In progress/ Transfer In progress / Return In progress’.

Rejected

AT, BE, DE, CH, NL

Applicable in countries where your confirmation is required.

If you reject the request, this will be the final status.

Please always share the rejection reason. No further action.

Confirmed

AT, BE, CH

Applicable in countries where your confirmation is required.

If you accept the request, this will be the next status, until order completion or update.

Number status will remain in ‘Port out In progress/ Transfer In progress / Return In progress’.

Firm Order Commitment

NL

In NL, after you have accepted the request, the order will be in this status until the First Possible Date (FPD) is reached

– or order cancelled.

Ready for porting initiation

NL

In NL, when the First Possible Date (FPD) is reached, the status will be changed automatically,

and the gaining operator will be able to initiate the port during the next 90 calendar days.

Without action during this period, order will expire.

Expired

NL

Gaining operator did not request the port. No further action.

Port initiated

NL

When the gaining operator has requested the port.

Port Out initiated

All except NL

When the port-out is initiated from Colt or the Gaining Operator

Cancelled

All

Order has been cancelled. No further action.

Completed

All

Port completed. Number is not live on your service anymore.

Rollback can be requested for all countries (except NL) by reaching out to Colt’s local porting desk.

If the Rollback request is accepted by Colt, then the port-out order will move to ‘confirmed’ status and number status

will be ‘Port out In progress/ Transfer In progress / Return In progress’.

Please note: All DE port out orders raised by a registered DE reseller will move to ‘Customer Feedback Awaited’ status and will require confirmation/rejection from the registered DE reseller. If no response received, an order will automatically move to Confirmed status after 5 working days

 

You can update port-in/out orders using portUpdate/order API.

 Port-In Date Change in all countries except NL & IT

Below image provides you high level flow:

date update

  • A child orderID will be generated, with orderStatus = Validation In Progress.
  • Parent orderID will remain in the same status until update completion.

Following process completion, child & parent orderStatus will be updated as per the below:

Action

Child orderStatus Update

Parent orderStatus Update

Request accepted by Colt

Accepted

Submitted to operator

Request rejected by Colt

Rejected

No status change

  • Request can only be performed when orderStatus = ‘Validation in progress’, ‘Firm order commitment’ & ‘Customer feedback awaited’.
  • Please note that when orderStatus = ‘Firm order commitment’, a date change can only be requested at the latest 2 working days before the agreed port date in all Zone A countries (except FR), 3 working days in Finland, 4 working days in France & other Zone B countries.

Modify Port in all countries except NL

 

The API allows you to modify your port when the order moves to the ‘Customer feedback awaited’ status. This includes, modify porting date/window, current operator details, CLI list, main billing number, add new attachments and notes.

  • A child orderID will be generated, with orderStatus = In Progress.
  • Parent orderID will remain in the same status until update completion. Post completion of child order, parent order will move to Validation in progress status.

Cancellation in all countries except NL

The API allows you to request cancellation of your order. Cancellation has to be approved by Colt Porting Desk.

Below image provides you high level flow:

cancel port

 

 

 

 

 

 

 

 

 

 

  • A child orderID will be generated, with orderStatus = Validation In Progress.
  • Parent orderID will remain in the same status until update completion.

Following process completion, child & parent orderStatus will be updated as per the below:

Action

Child orderStatus Update

Parent orderStatus Update

Request accepted by Colt

Accepted

Cancelled

Request rejected by Colt

Rejected

No status change

  • Request can only be performed when orderStatus = ‘Validation in progress’, ‘Submitted to operator’, ‘Firm order commitment’ & ‘Customer feedback awaited’.
  • Please note that when orderStatus = ‘Firm order commitment’, cancellation can only be requested at the latest 4 working days before the agreed port date in Norway, Czech Republic, Poland, Romania and Slovakia, 3 working days before the agreed port date in Luxembourg, Finland and 2 working days before the agreed port date in the Zone A countries.

You can cancel the reservation of reserved numbers or deactivate any activated/port-in activated numbers using the return/order API.

API

Description

/return/order

Only if cliStatus = Reserved

  • Number will be removed from your inventory and go back to free status.

Only if cliStatus = Activated or PortIn_Activated.

Number will either enter the quarantine period or be returned to the range holder.

Network configuration will be removed, and number will not be reachable.

Deactivation journey of NL 088 numbers/ranges.

  • 088 deactivation is immediate upon submission without the 2 month (quarantine) period
  • Deactivation lead time in regulatory database is 3 working days (day of submission not counted).
  • Completion will be confirmed/notified to you as soon as numbers are removed from Colt network and on the receipt of the Ack from PTXS upon submission of the deactivation request
  • No re-instate or re-activation is possible once deactivation is submitted
  • Numbers will be updated as ‘Returned’

ADD & MODIFY using address update APIs (NL)

Below are for the Netherlands only:-

  • End Customer Details and the Directory Services entry  are Mandatory for Activation, Portin and Address update (ADD) scenarios.
    • As the Emergency address is optional, then the end customer details will be populated in the emergency database (if the emergency address is not provided)
    • If the Emergency address is provided, then no LAC validation will be done on the emergency address and it will be populated in the emergency database
    • LAC validation applies to the End Customer address only

  • Emergency Address is optional in Address update (action=ADD).
    • If the Emergency address is provided, then no LAC validation will be done on the emergency address and it will be populated in the emergency database

  • In an Address Update(Modify) request the customer can include any or ALL of these as conditional mandatory:
    • Directory Services entry, and/or
    • the End Customer Address and/or
    • the Emergency Address.
    • If the Emergency address is provided, then it will be populated in the emergency database.  Any new or updated Emergency address will be validated before it is accepted.  LAC validation does not apply to emergency address.
    • LAC validation applies to the End Customer address only

  • ADD operation is only applicable to Premium customers and MODIFY is applicable for both Standard and Premium customers.

Phonebook Publication

In Belgium, Ireland, Italy, Portugal, Sweden, Netherlands, Spain, Austria and UK, Colt APIs allows you to provide and update Directory Service as well.

In the Netherlands, you can use the activation, Port-In and address update functionality to provide new or additional Address and Directory Services information at an order and/or at a CLI level.

Please refer to below table while submitting the request for these countries.

API

End customer Details & address +

Directory Services update

(BE, ES, SE)

End customer Details & address +

Directory Services update

(NL)

Emergency Address

(NL)

End customer Details & address

(IE, IT, PT, UK, CH)

Directory Services update

(IE, IT, PT, UK, CH)

/activation/order

(Pre-activation)

Not applicable

Not applicable

Not applicable

Not applicable

Not applicable

/activation/order

Mandatory

Mandatory

Not applicable

Mandatory

Optional

/updateCustomer/order

(ADD)

Mandatory

Mandatory

Optional

Mandatory

Optional

/updateCustomer/order

(MODIFY)

Mandatory

any or ALL of these as conditional mandatory:

  • Directory Services entry, and/or
  • the End Customer Address and/or
  • Emergency Address

any or ALL of these as conditional mandatory:

  • Directory Services entry, and/or
  • the End Customer Address

any or ALL of these as conditional mandatory:

  • Directory Services entry, and/or
  • the End Customer Address

Below is the TMF compliant error payload:

{

  "code": "ERR01",

  "reason": "string",

  "message": "string"

}

Error Codes

Below are the error codes which comes as the part of API response

 

HTTP response Code

code

reason

message

Details

400

Bad request

001

OAS validation failed

{APIGW error message}

e.g: Mandatory field missing, pattern not matching, The request is missing APIGWTrackingId.

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.

002

Validation not met

The mandatory parameter/node <> is missing.

Allowed length of <field name> in <country name> is <max allowed length> only.

Allowed pattern of <field name> in <country name> is <>.

<>field only accepts numbers in E164 format.

Maximum allowed ranges/CLI is <>  (1 for all customers and 20 for Microsoft)

Please refer to field wise validation message in next table.

401

Unauthorized

001

Authentication error

The authorization parameter is missing.

Colt will return a HTTP-401 error when the specified user’s authorization parameter is either invalid or missing or expired. Ensure the provided credentials are valid.

002

Authentication error

Invalid token.

003

Authentication error

Token expired.

004

Authentication error

The ClientID/Application ID + country is not valid.

403

Forbidden

001

 Resource forbidden

The client application is not authorized to call this resource.

Colt will return a HTTP-403 error when the user does not have access to the API.

404

Not found

001

Resource not found

The requested URI or the requested resource does not exist

Colt will returns a HTTP-404 error when the path is not found. Ensure the request path provided is correct.

405

Method not supported

001

Method not allowed

The requested method is not allowed for this resource.

Colt will return a HTTP-405 error when the HTTP method used in the request is invalid. Check the allowed HTTP methods for this endpoint

415

Unsupported Media Type

001

Unsupported media type

The format of the posted body is not supported by the endpoint.

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.

429

Too many requests

001

Rate limit exceeded

The application has made too many calls and has exceeded the rate limit for this service

Colt will returns a HTTP-429 error when the rate limit has been reached.

500

Internal server error

001

Internal server error

The server encountered an unexpected error and is unable to process the request at this time

Colt will return a HTTP-500 Error when an unknown error occurs. If you receive a HTTP-500 error from the Colt API

503

Service unavailable

001

service unavailable

The service is temporarily unavailable

Backend 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. 

504

Gateway timeout

001

Gateway timeout

Gateway timeout

System timed out talking to downstream system

 

Please click here to access Wholesale SIP documents like the Service Matrix, Numbers on Demand user guide and release notes. 

Please click on 'API Documents' on the left to find the OAS specification and sample API requests and responses.