ghl_phone_list_active_numbers
List active phone numbers for a specific location, with pagination, search filtering, and optional exclusion of number-pool numbers. Use it to inspect active numbers tied to a sub-account.
Instructions
List active numbers
List active numbers. With version: v3, the HTTP 200 body is the standard success envelope (status, data, message, statusCode). The v3 list payload is under data; isUnderGhl is renamed to isUnderLc per AIP naming convention.
Endpoint: GET /phone-system/numbers/location/{locationId} (Version header: v3; source: v3/phone-system-v3.json)
Requires a Sub-Account (location) token.
OAuth scopes: phonenumbers.read
Pagination params: pageSize, page — pass them to page through full result sets.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"locationId": "<locationId>"
},
"name": "ghl_phone_list_active_numbers"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page index. The default is 0. | |
| pageSize | No | How many resources to return in each list page. The default is 50, and the maximum is 1000. | |
| locationId | Yes | Location ID as string | |
| searchFilter | No | Number search Filter | |
| skipNumberPool | No | When true, exclude numbers assigned to number pools from the list. | |
| includeRcsSenderIds | No | Include RCS Sender IDs |