Running an API campaign

Who should read this article: Administrators

Use the Voiso Campaigns APIs to add contacts to your live outbound Dialer campaign.

Introduction

Voiso provides a variety of APIs that you can use to automate many processes. For details, refer to the Voiso Developer Portal.

You can use the Campaigns APIs to get a list of your current campaigns and to add a list of contacts to an active Live campaign.

Voiso supports Dialer campaign integrations with several common CRMs (refer to Running a CRM campaign). If you use a CRM, Helpdesk, or other data source for contacts that is not currently supported by an integration, you can easily use the Voiso Add contacts API to submit a list of contacts to your Live Dialer campaign.

Add contacts API

The Add contacts API enables you to programmatically add multiple contacts to an active Dialer campaign. For example, you can enable third-party automation to add contacts based on certain conditions, such as adding a contact to a campaign when a new lead is created in your CRM, Helpdesk, or other data source.

Create a Live Dialer campaign

Live Outbound Dialer campaigns automatically dial a list of contacts that you have added to the campaign. The campaign remains active until you stop it. When all the contacts in the calling list have been called, the Live Dialer campaign waits for more contacts to be added before resuming dialing.

Follow these steps to set up a Live Dialer campaign:

1. From the main menu bar, navigate to Outbound > Dialer campaigns.
2. In the Dialer campaigns page, click Add Dialer campaign.
3. Follow the steps in Adding a new campaign to configure the campaign.
4. Select Live campaign. You do not need to specify a Poll interval as this will be determined by the application you create to use the Add contacts API.
5. In the Calling list section, set the Method to File import (CSV, XLSX). You do not need to import a calling list file if all of the contacts in the campaign are being provided by the Add contacts API.
6. Click Save.

Create an application

To automatically add contacts to your Live Dialer campaign using the Add contacts API, create an application that extracts contact information from your CRM, Helpdesk, or other data source and adds it to the body of an Add contacts POST request:

{{baseUrl}}/api/v1/:api_key/campaigns/:campaign_id/contacts

The following is the expected format of the body of the request:

{
  "contacts": [
    {
      "phoneNumber": "<string>",
      "contactName": "<string>",
      "contactSource": "<string>",
      "contactURL": "<string>",
      "priority": "<integer>"
    },
    {
      "phoneNumber": "<string>",
      "contactName": "<string>",
      "contactSource": "<string>",
      "contactURL": "<string>",
      "priority": "<integer>"
    }
  ]
}

Here is a sample of a POST request in Postman:

Running and monitoring the campaign

When you first create a Live Dialer campaign without contacts, its status on the Dialer campaigns page is Draft (1). The total number of contacts in a live campaign is unknown while the campaign is running, so in the Campaigns table, the infinity symbol (∞) is displayed in the Contacts column (2) and a dash (-) is displayed in the Progress column (3). The controls (4) are not enabled until contacts are added to the campaign.

When contacts are added to the campaign by your application, the controls become available.

Click Start to launch the campaign. The campaign status changes to Active as long as there are contacts assigned to the campaign and there are agents available to handle calls.

Live campaigns pause under the following conditions:

• There are no new contacts available
• There are no contacts available that meet the local time requirement
• There are no logged-in agents available

Live campaigns resume when new contacts are available that meet the local time constraint and there are logged-in agents available to handle the calls.