Skip to main content

Power Dialer campaigns and operations

The Power Dialer API lets a tenant manage campaigns and lead lists, inspect the live state, recycle eligible outcomes into a new immutable list, and request bounded CSV exports. All operations use a tenant API token and are scoped to the token's tenant.

Campaign lifecycle​

Use the campaign endpoints in the API reference to create and revise a campaign, validate its current configuration, and control its lifecycle:

  • GET and POST /api/v1/power-dialer/campaigns
  • GET, PATCH, and DELETE /api/v1/power-dialer/campaigns/{id}
  • POST /api/v1/power-dialer/campaigns/{id}/validate
  • POST /api/v1/power-dialer/campaigns/{id}/schedule
  • POST /api/v1/power-dialer/campaigns/{id}/start
  • POST /api/v1/power-dialer/campaigns/{id}/pause
  • POST /api/v1/power-dialer/campaigns/{id}/resume
  • POST /api/v1/power-dialer/campaigns/{id}/drain
  • POST /api/v1/power-dialer/campaigns/{id}/stop

Use the campaign control endpoint when a single request should carry the desired lifecycle action. Schedule validation, entitlement, workspace, lead list, DNC, and webhook-bridge checks remain enforced when a campaign starts.

Live state and outcomes​

GET /api/v1/power-dialer/live returns the tenant's current campaign and capacity snapshot. GET /api/v1/power-dialer/campaigns/{id}/console returns the live console payload, while GET /api/v1/power-dialer/campaigns/{id}/outcomes returns outcome counts and the rows available for a call-again action.

To recycle eligible outcomes, send a reviewed selection to POST /api/v1/power-dialer/campaigns/{id}/recycle. The API creates a new immutable lead-list version and never modifies the source list. Do-not-call entries are reported but cannot be recycled. Review the response's created list ID before attaching it to another campaign revision.

Lead lists and exports​

Lead-list import, review, inspection, and sealing are available at /api/v1/power-dialer/lead-lists. Use the lead-list import guide for CSV and spreadsheet preparation rules.

Create a bounded export with POST /api/v1/power-dialer/exports, poll its status at GET /api/v1/power-dialer/exports/{id}, and download the completed CSV from GET /api/v1/power-dialer/exports/{id}/download. Supported export kinds include lead_list and campaign_results; campaign results can be filtered by campaign and outcome. Download URLs are tenant-authorized and expire, so do not store them as permanent links.

Tenant-wide safety controls are available at:

  • GET and PATCH /api/v1/power-dialer/settings
  • POST /api/v1/power-dialer/pause
  • POST /api/v1/power-dialer/resume
  • POST /api/v1/power-dialer/drain

The controls pause or drain new work and preserve the existing audit trail. Use the live snapshot and campaign console to confirm that work has reached the requested state before making another lifecycle change.

To open the application, use Power Dialer in sipsandwich.