List active numbers

Retrieve a paginated list of active phone numbers for a specific account. Supports filtering, pagination, and optional exclusion of number pool assignments.

GET https://services.leadconnectorhq.com/phone-system/numbers/location/{locationId}

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

number

default:"100"

How many resources to return in each list page. The default is 50, and the maximum is 1000.

number

The page index for pagination. The default is 0.

string

default:"+91"

Filter numbers by phone number pattern. Supports partial matching (e.g., “+91” to find all Indian numbers).

boolean

default:"True"

Whether to exclude numbers that are assigned to number pools. Default is true.

Respuestas

200 - Successfully retrieved list of active numbers

object[]

required

Array of phone number objects with detailed configuration

Show cada item

string

default:"+14155552671"

required

E.164 formatted phone number

string

default:"Sales Line 1"

Human-readable name assigned to the number

string

default:"PN1234567890abcdef1234567890abcde"

required

Phone number SID (unique identifier)

string

default:"US"

required

ISO 3166-1 alpha-2 country code

object

required

Communication capabilities supported by this number

Show propiedades

boolean

default:"True"

Whether the number supports voice calls

boolean

default:"True"

Whether the number supports SMS messaging

boolean

default:"True"

Whether the number supports MMS messaging

boolean

default:"False"

Whether the number supports fax transmission

string

default:"local"

required

Type of phone number (local, toll-free, mobile, etc.) Posibles valores: ‘local’, ‘toll-free’, ‘mobile’, ‘national’

boolean

default:"False"

required

Whether this is the default outbound number for the account

string

default:"user_123456789"

User ID of the user assigned to this number

string[]

required

Array of user IDs that should ring when this number is called

object

Configuration for inbound call handling service

Show propiedades

string

default:"voice_ai"

Type of inbound call service Posibles valores: ‘voice_ai’, ‘ivr’, ‘forward’

string

default:"68e381b296a83800a27cd1"

Service configuration value or ID

string

default:"+14155552672"

Phone number to forward calls to

boolean

default:"True"

required

Whether group conversations are enabled for this number (US/CA numbers with SMS/MMS only)

string

default:"AD1234567890abcdef1234567890abcde"

Address SID for compliance purposes

string

default:"BU1234567890abcdef1234567890abcde"

Bundle SID for regulatory compliance

string

default:"2023-01-15T10:30:00Z"

When the number was originally purchased/added

string

default:"2023-02-20T14:45:00Z"

When the number configuration was last updated

string

default:"twilio"

Source or origin of the phone number Posibles valores: ‘twilio’, ‘hosted’, ‘ported’

boolean

default:"True"

required

Whether this account is manged by LeadconnectorHQ

number

default:"100"

required

Number of items requested per page

number

default:"0"

required

Current page index (0-based)

string

default:"active"

required

Current status of the account Posibles valores: ‘active’, ‘suspended’, ‘closed’

{
  "numbers": [
    {
      "phoneNumber": "+14155552671",
      "friendlyName": "Sales Line 1",
      "sid": "PN1234567890abcdef1234567890abcde",
      "countryCode": "US",
      "capabilities": {
        "voice": true,
        "sms": true,
        "mms": true,
        "fax": false
      },
      "type": "local",
      "isDefaultNumber": true,
      "linkedUser": "user_123456789",
      "linkedRingAllUsers": [
        "user_123",
        "user_456"
      ],
      "inboundCallService": {
        "type": "voice_ai",
        "value": "68e381b296a83800a27cd1"
      },
      "forwardingNumber": "+14155552672",
      "isGroupConversationEnabled": true,
      "addressSid": "AD1234567890abcdef1234567890abcde",
      "bundleSid": "BU1234567890abcdef1234567890abcde",
      "dateAdded": "2023-01-15T10:30:00Z",
      "dateUpdated": "2023-02-20T14:45:00Z",
      "origin": "twilio"
    },
    {
      "phoneNumber": "+18005551234",
      "friendlyName": "Support Toll-Free",
      "sid": "PN9876543210fedcba9876543210fedcb",
      "countryCode": "US",
      "capabilities": {
        "voice": true,
  // truncado: 26 lineas mas
}

400 - Bad request - Invalid parameters

string

default:"Bad Request"

number

default:"400"

{
  "message": "Invalid locationId format or pagination parameters",
  "error": "Bad Request",
  "statusCode": 400
}

401 - Unauthorized

{}

404 - Phone system not connected

string

default:"Phone system is not connected to this account"

number

default:"404"

{
  "message": "Phone system is not connected to this account",
  "statusCode": 404
}

500 - Internal server error

string

default:"Internal server error"

string

default:"suspended"

Account status when error occurs

{
  "msg": "Internal server error",
  "accountStatus": "suspended"
}

Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId', {
  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',
    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');
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

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo

​Autorización

​Path parameters

​Query parameters

​Respuestas

​Ejemplo

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo