PowerDialer API
The PowerDialer API lets you create and run PowerDialer outbound calling campaigns from your own systems. A typical use is keeping a campaign supplied with leads straight from your CRM, instead of exporting and uploading CSV files.
Key concepts
Leads are the people a campaign calls. A lead is identified by its primary phone number: creating a lead with a phone number that already belongs to one of your leads updates that lead rather than adding a duplicate. Leads can carry your own custom fields, such as the contact's ID in your CRM.
Lead lists decide who a campaign calls. Every campaign has its own lead list, which can draw on uploaded CSV files, fixed lists of leads, and audiences: saved queries over your leads, such as "custom field campaign_tag is spring-promo". See Audience queries.
Campaigns dial their lead list through one of your call centers, within the calling hours and end date you set. A campaign whose list includes an audience is dynamic: while it is running, new leads that match the audience are added to it automatically, usually within a minute.
Getting started
To use the PowerDialer API you need:
- PowerDialer enabled on your Dialpad account
- an API key, which a company admin can create in Dialpad's admin settings under Authentication > API keys, with the Power Dialer scope selected
- the ID of the call center your campaigns will dial through, which you can look up with the Call Centers API
All PowerDialer endpoints are under https://dialpad.com/api/v2/powerdialer and are subject to Dialpad's rate limits. Endpoint details are in the API reference, under PowerDialer.
To build your first campaign, follow Creating a dynamic campaign.
Updated about 12 hours ago