API Reference

Create Number Request

post
https://api.cm.com/voice-phonenumberrequestapi/v1//numberrequests

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier of the Logical Account or Voice Account.

Body Params

Request data for new phone number ranges

uuid

Unique identifier of the company profile that will be operating the requested numbers.

int32
1 to 1000

The quantity of numbers to be requested.

int32

The size of the range to be requested. Only required if a range of numbers is requested.
Requires number ranges to be supported. See the order restrictions endpoint for the allowed ranges

string
enum

Phone number type

Allowed:
string | null

The area code to request numbers for. Required when city is not provided.
If the city is also provided, this will be used in combination with city.

string | null

City to request numbers for. Required when area code is not provided.
If the area code is also provided, this will be used in combination with area code.

string | null

Region to request numbers for. Only required for NANPA.

string | null

Additional comment for customers to for example add a distribution group or IP address.

string | null

URL that we'll send a POST request to when the status of the request has been updated. The body of this post request will contain the entire number request order including the updated status.

Responses

id, start, validFrom and validTo fields will be null.

401

Unauthorized

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago