Campaigns
A campaign dials a list with an agent inside a calling window, with retries, the do-not-call list and consent applied on every number.
| Method | Route | What it does |
|---|---|---|
campaigns.create | POST /api/v1/campaigns/create | Create a campaign from a contact list and an agent. |
campaigns.list | GET /api/v1/campaigns/ | Every campaign in the account. |
campaigns.get | GET /api/v1/campaigns/{campaign_id} | One campaign. |
campaigns.update | PATCH /api/v1/campaigns/{campaign_id} | Change a campaign that has not started. |
campaigns.start | POST /api/v1/campaigns/{campaign_id}/start | Start dialling. |
campaigns.pause | POST /api/v1/campaigns/{campaign_id}/pause | Pause dialling; calls in progress finish. |
campaigns.resume | POST /api/v1/campaigns/{campaign_id}/resume | Resume a paused campaign. |
campaigns.redial | POST /api/v1/campaigns/{campaign_id}/redial | Dial the numbers that were not reached again. |
campaigns.progress | GET /api/v1/campaigns/{campaign_id}/progress | Dialled, answered, remaining. |
campaigns.summary | GET /api/v1/campaigns/{campaign_id}/summary | Outcomes and cost so far. |
campaigns.runs | GET /api/v1/campaigns/{campaign_id}/runs | Every call the campaign placed. |
campaigns.report | GET /api/v1/campaigns/{campaign_id}/report | Download the report. |