get_whatsapp_devices
Comprehensive tool to retrieve WhatsApp devices with flexible filtering options. Supports all device query scenarios: get all devices, filter by status/session status, search by terms, get only active/online devices, etc.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_whatsapp_devices"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (0-based) | |
| limit | No | Maximum number of devices to retrieve | |
| search | No | Search term: phone number, alias, or device ID | |
| status | No | Filter by device operational statuses | |
| minUptime | No | Minimum session uptime in seconds (for online devices) | |
| activeOnly | No | Only include active/operational devices (authorized, verified, operative) | |
| exactMatch | No | Whether to use exact match for search (only applies when search is provided) | |
| onlineOnly | No | Only include devices that are currently online | |
| sessionStatus | No | Filter by session connectivity statuses | |
| includeMetrics | No | Include device metrics (chat counts, contacts, etc.) | |
| includeSettings | No | Include device settings and configuration | |
| includeSessionLogs | No | Include recent session logs | |
| includeSessionDetails | No | Include detailed session information |