Campaign Management API

Overview

The Campaign Management API, a Talkdesk Predictive Dialer™ solution, allows for managing call center campaigns. It’s possible to create and edit campaigns. It’s also possible to associate and dissociate external resources to campaigns in the Talkdesk Dialer.

Business Context

What You Achieve with the Campaign Management API

Companies can introduce their campaign management functionalities into their own business automation and rules using the Campaign Management API.

Business Problems the Campaign Management API Solves

Configuring the campaign manually via the Talkdesk user interface won't be necessary. You can do all the campaign management automatically via the Campaign Management API.

What the Campaign Management API doesn't Support

It’s not possible to edit running campaigns. To do that, it’s necessary to pause the campaign. Early Access campaign features are not available in these endpoints. It will be necessary to configure these features manually through the UI.

📘

Use Cases

Use Case 1
As a real life example, consider the scenario where a company wants to add a new record list to a call center campaign, considering the current one is exhausted. In order to do that, the campaign manager will disassociate the existing record list and associate a new one.

Use Case 2
As a real life example, consider the scenario where the campaign manager wants to associate more agents to an existing campaign because they are new in the team. In order to do that, it will be necessary to use the Campaign Management API to associate these agents from a campaign.

Use Case 3
As a real-life example, consider the scenario where the campaign manager needs to change some campaign configurations after a campaign performance analysis. The configuration that needs to be changed involves: the maximum dialing ratio, maximum abandonment rate, abandonment timeout, and global maximum attempts per record. The campaign manager can execute these actions by using the Campaign Management API.

👍

Access and Registration

Authentication

Usage

• Create or duplicate a campaign.

• Get campaigns list.

• Get campaign details.

• Delete campaign.

• Patch campaign for an account.

• Get a Do Not Call List (DNCL) in a campaign.

• Associate a DNCL with a campaign.

• Dissociate a DNCL from a campaign.

• Get record lists in a campaign.

• Associate record lists with a campaign.

• Dissociate record lists from a campaign.

• Get users in a campaign.

• Associate users with a campaign.

• Dissociate users from a campaign.

• Get numbers in a campaign.

• Associate numbers with a campaign.

• Dissociate numbers from a campaign.

Campaign Management Limits

• Global limit of 25 requests per second in all endpoints
• Associate or disassociate record lists - Limit of 20 lists per request (per campaign)
• Associate or disassociate do not call lists - Limit of 1 do not call list per request (per campaign)
• Associate or disassociate users - Limit of 20 users per request (per campaign)
• Associate or disassociate numbers - Limit of 20 numbers per request (per campaign)

📘

Supported Regions and Base URLs

👍

API Availability

The Campaign Management API has been in General Availability since February 2022.

Troubleshooting

If you have questions or technical issues, please open a ticket using this form.