Name of the campaign. Used to identify it in the Platform. The name must be a maximum of 48 characters.
string, required
description
Description of the campaign’s purpose. Helps teams understand the goal. The description must be a maximum of 256 characters.
string, required
contactLists
List of contact list names to be dialed. Must exist in the system. At least one contact list name is required.
array[string], required
priority
Campaign priority. Higher values indicate higher execution priority. Priority must be one of the following: 1, 2, 3, 4, or 5.
string, required
dialingMode
Dialing mode defines how calls are handled. Valid values are: Agentless, Progressive, or Preview.
string, required
dialingStrategy.callerId.phoneNumber
Caller ID number shown to the recipient. Must be a verified number.
string, required
dialingStrategy.callingHours.frequency
Frequency of calling hours must be one of: WEEKLY, DAILY, or CUSTOM.
string, required
dialingStrategy.callingHours.timezone
Timezone in which calling hours are defined.
string, required
dialingStrategy.callingHours.days
List of allowed calling time blocks. Each object should include: day (‘MO’, ‘TU’, ‘WE’, ‘TH’, ‘FR’, ‘SA’, ‘SU’), start (“9:00 AM”), end (“6:00 PM”). You can define multiple entries to cover different days and time slots.
array[object], required
dialingStrategy.dialingOrder
Order in which contacts are dialed: First In First Out (FIFO), Last In First Out (LIFO), etc.
string, required
dialingStrategy.maxAttemptsPerRecord
Maximum number of call attempts per contact. Minimum is 1 and maximum is 100.
number, required
dialingStrategy.defaultRetryPeriod
Time (in minutes) to wait between retries. Must be between 1 and 1440.
number, required
dialingStrategy.maxRingTime
Max time (in seconds) the phone should ring before disconnecting. Must be between 5 and 120.
number, required
queue_name
Name of the agent queue used to route calls when agents are needed. Required for Progressive dialing.
string, required
enableMachineDetect
Enables detection of answering machines/voicemail. Valid values are true or false.
