List voice campaigns
list_voice_campaignsList the voice campaigns of this account, newest first, 25 per page (meta.total_count is the total). Each has its status (draft, scheduled, running, paused, completed, cancelled, failed), whether it is outbound (the dialer calls contacts) or inbound (agents answer the PBX queues in inbound_queue_ids), its dialer mode and the progress counters. Contacts and their phone numbers are not included. Archived campaigns (archived_at set) and test campaigns (test true) are left out unless asked (archived, include_test); q searches the title, from/to the creation date. A campaign that is a batch and sweep of a program carries program_id, batch_label and sweep_number (filter by program_id or batch_label).
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": "list_voice_campaigns"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Part of the campaign title. | |
| to | No | Created at or before: YYYY-MM-DD covers that whole day; an ISO 8601 timestamp is used as is. | |
| from | No | Created at or after: YYYY-MM-DD (from the start of that day) or an ISO 8601 timestamp, used as is. | |
| page | No | ||
| fields | No | Optional: return only these fields of each record. | |
| archived | No | false (default) lists unarchived campaigns only, true archived ones only, all both. | |
| program_id | No | Only the campaigns of this program (id from list_voice_campaign_programs). | |
| batch_label | No | Only the campaigns of this batch. | |
| include_test | No | Include test campaigns (left out by default). |