Overview

Manage CommPeak Dialer calls, campaigns, leads, users, and caller IDs through the Dialer API.

The Dialer API gives you programmatic access to CommPeak Dialer: calls and call records, campaigns and leads, users and groups, caller IDs, and speech recognition. Use it to sync Dialer data with your CRM or reporting tools, or to manage your call center setup without opening the Dialer.

Send requests to https://api.commpeak.com/dialer/{sub_domain}/api with your Portal API key in the Authorization header. The key needs Full access (all services). Dispatch Automation and Click2Call are the exceptions: you call them on your own subdomain with their own credentials. For authentication, paging, filtering, and rate limits, see Core API Concepts. For your first request, see Getting Started with CommPeak APIs.

Dispatch Automation

Use Dispatch Leads to push leads into the Dialer from your CRM or other systems, and Dispatch Statuses to add their statuses. See Dispatch Leads Automation: Incoming Request Adapter.

Calls and CDRs

Get all calls or a specific call filtered by campaign, user, date, status, or destination, and download a call's recording. For aggregated counts, use Get aggregated call stats per campaign lead or Obtain Calls Statistics summarized by period. Get all CDRs returns full call detail records, and Aggregate CDRs groups them for reporting.

Campaigns

Campaigns contain a predefined lead-calling logic and the leads assigned to them. With the Campaigns endpoints, you can get all campaigns, get a specific campaign, clone a campaign, update or delete one, and delete leads from a campaign.

Campaign leads

Campaign leads are leads assigned to a specific campaign. At that point, they get a unique campaign lead ID and follow the campaign's calling logic. You can get campaign leads, mass assign or mass unassign them, move them to another campaign, update them, or mass delete them in a single request.

Click2Call

Click2Call lets agents start outbound calls from third-party applications, such as CRMs. CommPeak first rings the agent's extension, then connects the call to the destination based on your outbound routing configuration. This endpoint runs on your own subdomain, not through api.commpeak.com. See Click2Call Integrations Overview.

Comments

Get comments on campaign leads, create a comment, or create several comments at once. See lead comments.

Blacklists management

Manage your blacklisted leads through the DNC (Do Not Call) endpoints. You can get the DNC list, look up an entry by phone number, create or delete entries, approve or unapprove a phone number, and approve or unapprove numbers in bulk.

Leads

Leads are customer profiles with key information, such as first and last names. Once assigned to a campaign, a lead becomes a campaign lead, and one lead can belong to several campaigns. You can get all leads or page through them, create, update, or delete a lead, update or delete many leads at once, and get extended lead information, including custom fields.

Lead files

Get all lead files or a specific lead file to review the files your leads were imported from. See Lead Files Management.

Statuses

Get all statuses, filtered by status or campaign ID, or get a specific status by its ID.

Users

Manage the users of your Dialer: get all users or a specific user, and create, update, or delete users. You can also get the break types and users' break sessions, and manage desks, including which breaks each desk can use.

User groups

User groups contain dialing rules that determine which leads are called, in what priority order, and which skill groups handle the calls. You can get all groups or a specific group, update or delete a group, and see the users and campaigns assigned to it.

Priority groups

Priority groups set the order in which skill groups receive calls. Get your priority groups, then get the skill groups in a priority group in priority order.

Logs

Get all system logs and filter them by object type. To audit or troubleshoot your API requests, use Get API logs, filtered by date, API user, action, method, or response code.

Speech recognition

The Speech Recognition endpoints give you access to Speech-to-Text for your calls. You can get the supported languages, send a call to speech recognition, get the result for a call, or send the result to a callback URL.

Dynamic caller IDs (DIDs)

Manage your auto-dialing caller IDs: get all dynamic caller IDs, filter them, and activate or deactivate them.

📘

NOTE

Before you add new caller IDs, verify them in the CommPeak Portal. Requests that use caller IDs that are not verified return errors.

Route caller IDs (DIDs)

Manage the caller IDs used by your Dialer routes: get all route caller IDs or a specific one, create one, enable or disable it, or delete it.

Timezones

List all available timezones, as used in your general settings.

Devices

Manage the devices connected to your Dialer: get all devices or a specific device, and create, update, or delete devices.

Reference data

Get a reference dataset to map the codes in call data to readable labels, for example Q.850 cause codes, SIP response codes, call statuses, or country IDs. These values change rarely, so you can fetch them once and cache them.

Call center regions

Get the call center regions to see which PBX domains are available.