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.

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}

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

pageSize
number
default:"100"
How many resources to return in each list page. The default is 50, and the maximum is 1000.
page
number
The page index for pagination. The default is 0.
searchFilter
string
default:"+91"
Filter numbers by phone number pattern. Supports partial matching (e.g., “+91” to find all Indian numbers).
skipNumberPool
boolean
default:"True"
Whether to exclude numbers that are assigned to number pools. Default is true.

Respuestas

numbers
object[]
required
Array of phone number objects with detailed configuration
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
}
message
string
error
string
default:"Bad Request"
statusCode
number
default:"400"
{
  "message": "Invalid locationId format or pagination parameters",
  "error": "Bad Request",
  "statusCode": 400
}
{}
message
string
default:"Phone system is not connected to this account"
statusCode
number
default:"404"
{
  "message": "Phone system is not connected to this account",
  "statusCode": 404
}
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'