Search for available phone numbers to purchase for a specific account. Supports filtering by number pattern, type, and capabilities.
GET https://services.leadconnectorhq.com/phone-system/numbers/location/{locationId}/available
Autorización
Bearer token generado desde el portal Leadway. Ver Autenticación. Version
string
default:"2021-07-28"
required
Versión de la API.
Path parameters
locationId
string
default:"ve9EPM428h8vShlRW1KT"
required
The unique identifier of the account
Query parameters
countryCode
string
default:"US"
required
ISO 3166-1 alpha-2 country code for which to search available numbers
numberTypes
string
default:"local,tollFree"
Comma-separated list of phone number types to search for (e.g. local, tollFree, mobile)
Filter numbers that begin with this digit pattern
Filter numbers that end with this digit pattern
Filter numbers that contain this digit pattern anywhere
Filter for numbers with SMS capability
Filter for numbers with MMS capability
Filter for numbers with voice capability
Respuestas
200 - Successfully retrieved list of available phone numbers
fingerprintId
string
default:"1773314252953"
required
Unique fingerprint ID for this search result, required when purchasing one of the returned numbers
List of available phone numbers matching the search criteria
phoneNumber
string
default:"+18705871861"
required
E.164 formatted phone number
friendlyName
string
default:"(870) 587-1861"
required
Human-readable formatted phone number
isoCountry
string
default:"US"
required
ISO 3166-1 alpha-2 country code
Local Access and Transport Area code
City or locality of the number
Rate center of the number
latitude
string
default:"35.241800"
Latitude coordinate of the number’s account
longitude
string
default:"-90.846000"
Longitude coordinate of the number’s account
State or region abbreviation
Postal code of the number
addressRequirements
string
default:"none"
required
Address requirements for purchasing this number Posibles valores: ‘none’, ‘any’, ‘local’, ‘foreign’
beta
boolean
default:"False"
required
Whether this is a beta number
Communication capabilities supported by this number
Pricing information for this number
Type of number for billing purposes
Monthly price for this number
Currency unit for the price
{
"fingerprintId": "1773314252953",
"numbers": [
{
"phoneNumber": "+18705871861",
"friendlyName": "(870) 587-1861",
"lata": "528",
"locality": "Wynne",
"rateCenter": "WYNNE",
"latitude": "35.241800",
"longitude": "-90.846000",
"region": "AR",
"postalCode": "72396",
"isoCountry": "US",
"addressRequirements": "none",
"beta": false,
"capabilities": {
"MMS": true,
"SMS": true,
"voice": true
},
"price": {
"number_type": "local",
"price": 1.15,
"price_unit": "USD"
}
}
]
}
400 - Bad request - Invalid parameters
message
string
default:"countryCode is required"
error
string
default:"Bad Request"
{
"message": "countryCode is required",
"error": "Bad Request",
"statusCode": 400
}
500 - Internal server error
Ejemplo
curl -X GET 'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/available' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
const response = await fetch('https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/available', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/available',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
<?php
$ch = curl_init('https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/available');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
