List available phone numbers

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

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Path parameters

string

default:"ve9EPM428h8vShlRW1KT"

required

The unique identifier of the account

Query parameters

string

default:"US"

required

ISO 3166-1 alpha-2 country code for which to search available numbers

string

default:"local,tollFree"

Comma-separated list of phone number types to search for (e.g. local, tollFree, mobile)

string

default:"830"

Filter numbers that begin with this digit pattern

string

default:"825"

Filter numbers that end with this digit pattern

string

default:"825"

Filter numbers that contain this digit pattern anywhere

boolean

default:"True"

Filter for numbers with SMS capability

boolean

default:"True"

Filter for numbers with MMS capability

boolean

default:"True"

Filter for numbers with voice capability

Respuestas

200 - Successfully retrieved list of available phone numbers

string

default:"1773314252953"

required

Unique fingerprint ID for this search result, required when purchasing one of the returned numbers

object[]

required

List of available phone numbers matching the search criteria

Show cada item

string

default:"+18705871861"

required

E.164 formatted phone number

string

default:"(870) 587-1861"

required

Human-readable formatted phone number

string

default:"US"

required

ISO 3166-1 alpha-2 country code

string

default:"528"

Local Access and Transport Area code

string

default:"Wynne"

City or locality of the number

string

default:"WYNNE"

Rate center of the number

string

default:"35.241800"

Latitude coordinate of the number’s account

string

default:"-90.846000"

Longitude coordinate of the number’s account

string

default:"AR"

State or region abbreviation

string

default:"72396"

Postal code of the number

string

default:"none"

required

Address requirements for purchasing this number Posibles valores: ‘none’, ‘any’, ‘local’, ‘foreign’

boolean

default:"False"

required

Whether this is a beta number

object

required

Communication capabilities supported by this number

Show propiedades

boolean

default:"True"

boolean

default:"True"

boolean

default:"True"

object

Pricing information for this number

Show propiedades

string

default:"local"

Type of number for billing purposes

number

default:"1.15"

Monthly price for this number

string

default:"USD"

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

string

default:"countryCode is required"

string

default:"Bad Request"

number

default:"400"

{
  "message": "countryCode is required",
  "error": "Bad Request",
  "statusCode": 400
}

401 - Unauthorized

{}

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);

Empezar

Scopes

List available phone numbers

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo

​Autorización

​Path parameters

​Query parameters

​Respuestas

​Ejemplo

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo