Skip to content

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.

MethodRouteWhat it does
campaigns.createPOST /api/v1/campaigns/createCreate a campaign from a contact list and an agent.
campaigns.listGET /api/v1/campaigns/Every campaign in the account.
campaigns.getGET /api/v1/campaigns/{campaign_id}One campaign.
campaigns.updatePATCH /api/v1/campaigns/{campaign_id}Change a campaign that has not started.
campaigns.startPOST /api/v1/campaigns/{campaign_id}/startStart dialling.
campaigns.pausePOST /api/v1/campaigns/{campaign_id}/pausePause dialling; calls in progress finish.
campaigns.resumePOST /api/v1/campaigns/{campaign_id}/resumeResume a paused campaign.
campaigns.redialPOST /api/v1/campaigns/{campaign_id}/redialDial the numbers that were not reached again.
campaigns.progressGET /api/v1/campaigns/{campaign_id}/progressDialled, answered, remaining.
campaigns.summaryGET /api/v1/campaigns/{campaign_id}/summaryOutcomes and cost so far.
campaigns.runsGET /api/v1/campaigns/{campaign_id}/runsEvery call the campaign placed.
campaigns.reportGET /api/v1/campaigns/{campaign_id}/reportDownload the report.