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 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 How many resources to return in each list page. The default is 50, and the maximum is 1000.
The page index for pagination. The default is 0.
Filter numbers by phone number pattern. Supports partial matching (e.g., “+91” to find all Indian numbers).
Whether to exclude numbers that are assigned to number pools. Default is true.
Respuestas
200 - Successfully retrieved list of active numbers
Array of phone number objects with detailed configuration phoneNumber
string
default: "+14155552671"
required
E.164 formatted phone number
friendlyName
string
default: "Sales Line 1"
Human-readable name assigned to the number
sid
string
default: "PN1234567890abcdef1234567890abcde"
required
Phone number SID (unique identifier)
countryCode
string
default: "US"
required
ISO 3166-1 alpha-2 country code
Communication capabilities supported by this number Whether the number supports voice calls
Whether the number supports SMS messaging
Whether the number supports MMS messaging
Whether the number supports fax transmission
type
string
default: "local"
required
Type of phone number (local, toll-free, mobile, etc.) Posibles valores: ‘local’, ‘toll-free’, ‘mobile’, ‘national’
isDefaultNumber
boolean
default: "False"
required
Whether this is the default outbound number for the account
linkedUser
string
default: "user_123456789"
User ID of the user assigned to this number
Array of user IDs that should ring when this number is called
Configuration for inbound call handling service Type of inbound call service Posibles valores: ‘voice_ai’, ‘ivr’, ‘forward’
value
string
default: "68e381b296a83800a27cd1"
Service configuration value or ID
forwardingNumber
string
default: "+14155552672"
Phone number to forward calls to
isGroupConversationEnabled
boolean
default: "True"
required
Whether group conversations are enabled for this number (US/CA numbers with SMS/MMS only)
addressSid
string
default: "AD1234567890abcdef1234567890abcde"
Address SID for compliance purposes
bundleSid
string
default: "BU1234567890abcdef1234567890abcde"
Bundle SID for regulatory compliance
dateAdded
string
default: "2023-01-15T10:30:00Z"
When the number was originally purchased/added
dateUpdated
string
default: "2023-02-20T14:45:00Z"
When the number configuration was last updated
Source or origin of the phone number Posibles valores: ‘twilio’, ‘hosted’, ‘ported’
isUnderGhl
boolean
default: "True"
required
Whether this account is manged by LeadconnectorHQ
pageSize
number
default: "100"
required
Number of items requested per page
page
number
default: "0"
required
Current page index (0-based)
accountStatus
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
error
string
default: "Bad Request"
{ "message" : "Invalid locationId format or pagination parameters" , "error" : "Bad Request" , "statusCode" : 400 }
404 - Phone system not connected
message
string
default: "Phone system is not connected to this account"
{ "message" : "Phone system is not connected to this account" , "statusCode" : 404 }
500 - Internal server error
msg
string
default: "Internal server error"
accountStatus
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 );
