Overview

Calls and CDRs

The Calls API allows you to get call data or call recordings filtered by various parameters. In the CDRs API, you can also access full CDR data of calls made in the system.

Campaigns

Campaigns contain a predefined lead-calling logic and include leads assigned to them.
The Campaigns API provides functionalities for managing your campaigns. You can clone existing campaigns, create new campaign groups, retrieve a list of all campaigns, and delete or update campaigns as needed. Additionally, you can manage leads within campaigns and check their statuses.

Campaign Leads

Campaign leads are leads assigned to a specific campaign, at which point they are given a unique lead ID and become part of the campaign.
In the Campaign Leads API, you can manage leads associated with your campaigns. This includes mass assigning leads to campaigns, deleting leads from campaigns, unassigning leads in bulk, and updating lead information in a single request.

Comments

In the Comments API, you can create comments for campaigns and retrieve all comments related to campaign leads. You can also send multiple comments at once.

Caller IDs (DIDs)

The Caller IDs API allows you to manage your Сaller IDs. You can create new Сaller IDs, enable or disable them, view the list of all Сaller IDs, and delete specific ones as needed.

📘

NOTE

Before adding new Call IDs, verify them in the CommPeak Portal. API calls with non-validated Caller IDs will return errors.

Devices

The Devices API lets you manage the devices connected to the system. You can create new devices, retrieve lists of existing devices, update device information, and delete devices when necessary.

Do Not Call (DNC)

In the Do Not Call API, you can manage your DNC list. This includes creating new DNC entries, retrieving and deleting existing DNCs, and approving or unapproving phone numbers. You can also perform bulk operations on DNC numbers.

Lead Files

The Lead Files API allows you to view all lead files in the system and manage the data associated with your leads.

Leads

Leads in the system are customer profiles containing key information like first and last names. Once assigned to a campaign, they inherit the campaign’s calling logic and become campaign leads. A single lead can be linked to multiple campaign leads.
The Leads API enables you to create new leads, retrieve all leads, update existing lead information, and delete leads as needed. You can also access custom fields related to leads and get extended information about them.

Logs

The Logs API allows you to retrieve all system logs and filter them based on object types or API activities.

Speech Recognition

The Speech Recognition API provides access to speech recognition features. You can get speech recognition details for specific calls, view available languages, and send calls for speech analysis. You can also send speech recognitions to a callback URL.

Timezones

The Timezones API allows you to retrieve a list of all available timezones.

User Groups

User groups contain dialing rules that determine which leads will be called, the priority order of the calls, and which skill groups will handle the calls.
The User Groups API allows you to manage groups of users. You can create, update, or delete user groups, view their associated campaigns and users assigned to groups, and manage priority groups or skill groups.

Users

The Users API allows you to manage users within the system. This includes creating new users, retrieving user details, updating user information, and deleting users. You can also manage user roles, desks, and skill groups.

Call Center Regions

In Call Center Regions API, you can retrieve information about the FreeeSWITCH regions to connect agents to the FreeSWITCH closest to your call center.