Once a campaign is running, the API provides tools to pause dialing, update configurations, monitor queue activity, filter call items, and manage agent workloads.
Campaign States
Campaigns move through operational states that control dialer behavior.
RUNNING
Campaign is actively dialing and processing queued calls.
SUSPENDED
New outbound calls stop immediately while active conversations continue.
ENDED
Campaign is permanently stopped and pending calls are cancelled.
Updating Running Campaigns
Campaign configurations can be updated while campaigns are active.
Scheduling Updates
- • Modify campaign dates
- • Update calling windows
- • Change timezone settings
- • Enable or disable weekends
Retry & Delivery Updates
- • Adjust retry limits
- • Update retry delays
- • Change delivery method
- • Pause or resume campaigns
campaign_data Cannot Be Modified
Recipient records inside campaign_data are immutable after campaign creation. Scheduling and retry configurations can be updated, but recipient phone numbers cannot be edited directly.
Searching & Filtering
Use filtering and pagination parameters to manage large campaign queues efficiently.
Campaign Filters
- • Filter by campaign state
- • Search campaigns by name
- • Paginate large result sets
Call Item Filters
- • Filter by disposition
- • Search recipients
- • Inspect attempt history
Call Item States
Each recipient progresses through its own queue lifecycle.
| State | Description |
|---|---|
PENDING | Waiting to be dialed or retry cooldown |
IN_PROGRESS | Call is currently active |
COMPLETED | Call finished or retries exhausted |
CANCELLED | Cancelled because campaign ended |
Agent-Level Workload APIs
Track workload and campaign activity for specific AI agents.
Campaign Counts
Code
Returns total, active, and completed campaign counts for an agent.
Active Call Load
Code
Returns the number of active calls currently handled by the agent.
Multi-Campaign Views
Enterprise workflows often require combined analytics across multiple campaigns.
The API supports:
- Aggregated analytics
- Combined campaign stats
- Cross-campaign dispositions
- Shared call item views
- Bulk CSV exports
Core Management APIs
Update Campaign
Code
Code
Campaign Details
Code
Multi-Campaign Call Items
Code
Next Steps
Campaign Analytics
Explore dispositions, analytics, exports, and reporting APIs.
Multi-Campaign Operations
Aggregate data and manage multiple campaigns together.