Outbound Campaign Resource

The Outbound Campaign resource contains information about the outbound campaign, including the name and dialing mode. Outbound campaigns have the following endpoints: /api/v2/me/outbound-campaigns and /api/v2/me/outbound-campaigns /<campaing-name>.

Sample Data

{
   "campaign": {
      "groupName": " Outbound Contact Campaigns",
      "groupDescription": "",
      "description": "",
      "applicationId": 124,
      "state": "Started",
      "name": "Outbound Contact - Customer Satisfaction Campaign",
      "dialingMode": "Preview",
      "devicePath": "/devices/1234567890"
   }
}

Resource Details

Field	Description
groupName	The name of the agent or place group assigned to the outbound campaign.
groupDescription	A description of the agent or place group assigned to the outbound campaign.
description	A description of the outbound campaign.
applicationId	The Outbound Contact Server application ID.
state	The status of the campaign, such as Started or Loaded.
name	The name of the outbound campaign.
dialingMode	The dialing mode to use as the default for the agent group in a campaign. The dialing modes are Progressive, Predictive, Preview, Push Preview, and Power GVP.
devicePath	The path to a device.

Important

Not all fields are sent for each response.