Skip to main content
Get list of number pools
GET https://services.leadconnectorhq.com/phone-system/number-pools

Autorización

Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
Version
string
default:"2021-07-28"
required
Versión de la API.

Query parameters

locationId
string
default:"ve9EPM428h8vShlRW1KT"
Account ID to filter pools

Respuestas

success
boolean
default:"True"
Indicates if the request was successful
data
object[]
Array of number pool objects
total
number
default:"5"
Total number of pools returned
{
  "success": true,
  "data": [
    {
      "id": "ve9EPM428h8vShlRW1KT",
      "name": "Sales Team Pool",
      "locationId": "loc123",
      "numbers": [
        {
          "phoneNumber": "+14155552671",
          "friendlyName": "Sales Line 1"
        }
      ],
      "forwardingNumber": "+14155552671",
      "whisper": true,
      "whisperMessage": "Incoming call from sales line",
      "callRecording": true,
      "isActive": true,
      "inboundCallService": {
        "type": "voice_ai",
        "value": "68e381b296a83800a27cd1"
      }
    }
  ],
  "total": 1
}
message
string
default:"Invalid locationId format"
error
string
default:"Bad Request"
statusCode
number
default:"400"
{
  "message": "Invalid locationId format",
  "error": "Bad Request",
  "statusCode": 400
}

Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/phone-system/number-pools' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'
const response = await fetch('https://services.leadconnectorhq.com/phone-system/number-pools', {
  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/number-pools',
    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/number-pools');
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);