Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Autorizacion

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticacion.
​
Version
string
default:"2021-07-28"
required
Version 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)
​
firstPart
string
default:"830"
Filter numbers that begin with this digit pattern
​
lastPart
string
default:"825"
Filter numbers that end with this digit pattern
​
anywhere
string
default:"825"
Filter numbers that contain this digit pattern anywhere
​
smsEnabled
boolean
default:"True"
Filter for numbers with SMS capability
​
mmsEnabled
boolean
default:"True"
Filter for numbers with MMS capability
​
voiceEnabled
boolean
default:"True"
Filter for numbers with voice capability

​
Respuestas

​
fingerprintId
string
default:"1773314252953"
required
Unique fingerprint ID for this search result, required when purchasing one of the returned numbers
​
numbers
object[]
required
List of available phone numbers matching the search criteria
{
  "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"
      }
    }
  ]
}
​
message
string
default:"countryCode is required"
​
error
string
default:"Bad Request"
​
statusCode
number
default:"400"
{
  "message": "countryCode is required",
  "error": "Bad Request",
  "statusCode": 400
}

{}

​
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'