Data Structure for Campaign

Attribute Name

Base Type

Restrictions

Description

campaignId

baseIdInt

1 to 2147483647

Unique identifier for the campaign.

campaignName

string

minLength value = 1

maxLength value = 40

Campaign name contains alphanumeric characters, spaces, underscores (_), and hyphens (-) without leading or trailing white spaces.

Unique name for the campaign.

Note
PUT operation cannot modify the campaign name. If you try to modify the name, REST API throws 400 Bad Request error.

enabled

boolean

default = false

Indicates if the campaign is currently active.

description

string

minLength value = 0

maxLength value = 50

Description of the campaign.

startTime

timeType, string

Between 00:00 to 23:59 inclusive

default = 08:00

Campaign start time.

endTime

timeType, string

Between 00:00 to 23:59 inclusive

default = 21:00

Campaign end time.

timeZone

string

—

Time zone of the campaign.

Note
When you create a campaign, the time zone if given is ignored and the server time zone is considered by default.

This field is read only and cannot be modified through PUT operation.

campaignType

enum

enum values = AGENT, IVR

Type of campaign to be used for outbound calls. You can specify one of the following two campaign types:

  • Agent-based—All the outbound calls in the campaign are handled by the available agents.

  • IVR-based—All the outbound calls in the campaign are handled by the IVR scripts.

dialerType

enum

enum values = DIRECT_PREVIEW, PROGRESSIVE, PREDICTIVE

The dialer type options available for a campaign vary depending on the campaign type.

For Agent-based campaign type:

  • Direct Preview

  • Progressive

  • Predictive

For IVR-based campaign type:

  • Progressive

  • Predictive

pendingContacts

unsignedInt

default = 0

Indicates the number of contacts that are yet to be dialed, contacts that request a callback, and contacts that will be tried again because of unsuccessful prior attempts.

associatedSupervisors

sequence (supervisor : nameUrlPair)

minOccurs = 0

maxOccurs = 1

nillable = false

For the supervisor element,

minOccurs = 1

maxOccurs = 1

nillable = false

Indicates a campaign to which a supervisor is associated with.