Contact list management using APIs

Overview

Webex campaign provides contact list management APIs to programmatically create and manage contact lists, automate contact ingestion, and expire contact lists at the campaign end time.

Using these APIs, you can automate the ingestion and management of contact data sourced from external lead systems.

1. Create contact list
2. Create contacts within a contact list

   📘

   This API will accept the phone number in field mapping format and will store it in E164 format.

3. Get contact lists within a campaign
4. Update a contact's status within a contact list
5. Update contact list status

On the UI, you can view the contacts list created using APIs. In a campaign you can configure contact list created using API and also SFTP.

The Manage Contact List screen displays the contact lists that were created using APIs.

With these APIs, you can automate the creation and management of your campaign contact lists without the need for a human user to manually upload the contact lists. You can also support use cases such as the following scenario:

let's say a bank's core debt accounting system every morning generates a file of customers whose debt payment is overdue, and this file is then used to automatically create a contact list for a 'debt-collection campaign' using the SFTP upload method. During the day, one of these customers may make the debt instalment payment online or in a bank branch office. In this case, you can write an application to invoke the 4th API in the above list to 'close the contact record' for this customer who no longer needs to be called as their debt payment is no longer overdue.