campaigns
campaigns.cancel
campaigns.cancel
Effects: external_api
Cancel a campaign — no further numbers are dialed.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
campaign_id | integer | yes |
campaigns.create
campaigns.create
Effects: external_api
Start a bulk outbound call campaign: dial a list of phone numbers with a voice agent, at a bounded concurrency, retrying no-answers. Phone network only (twilio/telnyx). It begins dialing on its own — no separate start.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
agent_id | integer | no | Voice agent that makes the calls. |
channel | string | no | Carrier (default telnyx). (one of twilio, telnyx) |
greeting | string | no | First line the agent says on pickup. |
instructions | string | no | What the agent should do on the call. |
max_attempts | integer | no | Retries per number on no-answer (default 3). |
max_concurrent | integer | no | Simultaneous calls (default 2). |
name | string | yes | Campaign name |
phone_numbers | array | yes | Numbers to dial, E.164 (e.g. '+15551234567'). |
retry_delay_minutes | integer | no | Wait before a retry (default 30). |
campaigns.list
campaigns.list
Effects: read
List this workspace's campaigns, newest first.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
limit | integer | no | |
offset | integer | no |
campaigns.pause
campaigns.pause
Effects: external_api
Pause a campaign — stop starting new calls; in-flight ones finish.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
campaign_id | integer | yes |
campaigns.resume
campaigns.resume
Effects: external_api
Resume a paused campaign.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
campaign_id | integer | yes |
campaigns.status
campaigns.status
Effects: read
Progress of one campaign: status and per-number counts.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
campaign_id | integer | yes |