Phone Number Request API (v1)

Get all number request orders for the given Account.

This endpoint allows you to request one or more phone numbers for use in our platform. The prices bound to purchasing new numbers can be found in the voice management App.

If the requested numbers are directly available, they will be immediately assigned to the specified voice account. If they are not directly available, your order may take some time to complete. We will keep you informed on the status of your order via the supplied email address and (if given) via the supplied callback URL.

Get a specific phone number request based on the given order ID.

A phone number request goes through a set of predefined statuses during its lifespan. With this request you can retrieve all possible statuses.

Because of different rules and regulation in different countries, we may need additional information (for example documents) after your request has been created. The required information will be checked by our support staff. Necessary documents can later be requested via email. With this endpoint you can retrieve the additional information based on the country related to the request.

If the response contains only an empty array, it means the country that the request is bound to does not require any information.

Get restrictions on the number request for the given country code and number type combination. (e.g. maximum amount of numbers per request, supported range sizes)

Check the availability of phone numbers based on the provided request details.

Get locale options when requesting numbers for a specific country.

Get all porting request orders for the given Account.

This endpoint allows you to request one or more phone numbers to be ported from your current number provider, to CM.com.

After your porting request has been created, we will keep you informed on the status of your order via the supplied email address and (if given) via the supplied callback URL. If your porting request has been completed, the phone numbers will be directly available for use inside our platform.

Get a specific porting request based on the given order ID.

A phone porting request goes through a set of predefined statuses during its lifespan. With this request you can retrieve all possible statuses to check the current status of your request based on the status ID.

IMPORTANT NOTE: Performing a porting is only possible for dutch numbers.

This endpoint allows you to perform (and thus complete) your porting request, once its status is set to Ready to be ported. After calling this endpoint, the order will be finalized and the phone numbers coupled to the given porting request will be activated on our platform.

This endpoint allows you to cancel an ongoing porting request, once its status is set to Ready to be ported. After calling this endpoint, the ongoing order process will be stopped.

Upload a document (LoA, Telco Invoice, etc.) for a porting request

Delete a document from a porting request

Retrieve all rules and regulations, ordered by country and phone number type. Be aware that every request also requires contact information (first & last name, email address), company representative contact information (first & last name, phone number) and company information (name, registration number, address).

Because of different rules and regulations in different countries, we may need certain additional information along with your request depending on the country related to the request. These required fields can be fetched with this endpoint, together with an example value describing the format in which it should be supplied.

If the response contains only an empty array, it means the country that the request is bound to does not require any required fields to be added.

Get a list of countries that are currently unavailable for phone number requests and phone number porting.