Request
Endpoint:
|
/api/available_numbers
|
Method:
|
GET
|
Headers:
|
Accept: application/vnd.cloudlx.v1+json
|
Authorization: Bearer <access_token>
|
Optional GET request parameters
search
|
Description
|
The number must contain these digits
|
Type
|
Integer
|
Example
|
123
|
max_per_page
|
Description
|
Limit the number of results returned (max 200)
|
Type
|
Integer
|
Example
|
50
|
page
|
Description
|
The page number, if the number of results exceeds max_per_page
|
Type
|
Integer
|
Example
|
2
|
number_service_type
|
Description
|
The code representing the Number Service Type. Permitted values; GEOGRAPHIC, TOLL FREE, PREMIUM, MOBILE
|
Type
|
String
|
Example
|
GEOGRAPHIC
|
Response
Example:
{
"available_numbers": [
{
"uuid": "84436b07-5aa7-481e-bc04-86b7a425b54c",
"number_e164": "+441245123456",
"number": "123456",
"range_code": "1245",
"range_name": "Chelmsford",
"country_code": "44",
"country_name": "United Kingdom",
"country_iso": "UK",
"monthly_charge": 0.3,
"setup_charge": 0,
"per_minute_charge": 0.85,
"setup": 0.05,
"no_pricing": false,
"pricing_currency": {
"name": "USD - US Dollar",
"symbol": "$",
},
"status": "Available"
},
...
],
"num_results": 31,
"paginates": false
}
uuid
|
Description
|
The uuid for the number, used to perform actions on the number
|
Type
|
String
|
Example
|
84436b07-5aa7-481e-bc04-86b7a425b54c
|
number_e164
|
Description
|
The E.164 representation of the number
|
Type
|
String
|
Example
|
+441245123456
|
number
|
Description
|
The local number
|
Type
|
String
|
Example
|
123456
|
range_code
|
Description
|
The range code for the number
|
Type
|
String
|
Example
|
1245
|
range_name
|
Description
|
The range name, such as number type or area code
|
Type
|
String
|
Example
|
Chelmsford
|
country_code
|
Description
|
The country dialling code for the number
|
Type
|
String
|
Example
|
44
|
country_name
|
Description
|
The country name for the number
|
Type
|
String
|
Example
|
United Kingdom
|
country_iso
|
Description
|
The ISO code for the country
|
Type
|
String
|
Example
|
UK
|
monthly_charge
|
Description
|
The monthly cost for the number
|
Type
|
String
|
Example
|
0.3
|
setup_charge
|
Description
|
The once off setup cost for the number
|
Type
|
String
|
Example
|
0
|
per_minute_charge
|
Description
|
The per-minute charge for the number
|
Type
|
Float
|
Example
|
0.85
|
setup
|
Description
|
The set up cost per call
|
Type
|
Float
|
Example
|
0.05
|
pricing_currency
|
Description
|
Boolean flag indicating if the number has pricing
|
Type
|
Boolean
|
Example
|
false
|
no_pricing
|
Description
|
Boolean flag indicating if the number has pricing
|
Type
|
Boolean
|
Example
|
false
|
status
|
Description
|
The status of the number
|
Type
|
String
|
Example
|
Available
|
num_results
|
Description
|
The total number of results returned
|
Type
|
Integer
|
Example
|
10
|
paginates
|
Description
|
Whether or not the number of results exceeds the maximum number of results specified
|
Type
|
Boolean
|
Example
|
false
|
Additional Response parameters
Below are additional parameters when service_type_code is returned as TOLL FREE. These replace the per_minute_charge and setup parameters.
toll_free_per_minute_charge_fixed
|
Description
|
The per-minute charge for calls originating from Fixed Line networks
|
Type
|
Float
|
Example
|
0.85
|
toll_free_per_minute_charge_mobile
|
Description
|
The per-minute charge for calls originating from Mobile networks
|
Type
|
Float
|
Example
|
0.85
|
toll_free_per_minute_charge_payphone
|
Description
|
The per-minute charge for calls originating from Payphone networks
|
Type
|
Float
|
Example
|
0.85
|
toll_free_fixed_setup
|
Description
|
The setup charge for calls originating from Fixed Line networks
|
Type
|
Float
|
Example
|
0.85
|
toll_free_mobile_setup
|
Description
|
The setup charge for calls originating from Mobile networks
|
Type
|
Float
|
Example
|
0.85
|
toll_free_payphone_setup
|
Description
|
The setup charge for calls originating from Payphone networks
|
Type
|
Float
|
Example
|
0.85
|