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. Helpful for internal context. The description must be a maximum of 256 characters.
string, required
contactLists
List of contact list names
array[string], required
dncLists
Contains the contact lists added under the Do Not Call (DNC) list.
object, required
dncLists.name
The name of the contact list included in the Do Not Call (DNC) list.
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
Phone number shown as the caller ID to the recipient.
string, required
dialingStrategy.callingHours.frequency
Frequency of calling hours. Must be one of: WEEKLY, DAILY, or CUSTOM.
string, required
dialingStrategy.callingHours.timezone
Timezone used for enforcing calling windows.
string, required
dialingStrategy.callingHours.days
List of allowed calling time blocks. Each object should include: day (MO, TU, WE, TH, FR, SA, SU), start (for example, 9:00 AM), and end (for example, 6:00 PM). You can define multiple entries for different days and time slots.
array[object], required
dialingStrategy.dialingOrder
Order of dialing, such as First In First Out (FIFO) or Last In First Out (LIFO).
string, required
dialingStrategy.maxAttemptsPerRecord
Maximum number of call attempts per contact. Must be between 1 and 100.
number, required
dialingStrategy.defaultRetryPeriod
Time in minutes to wait between retries. Must be between 1 and 1440.
number, required
dialingStrategy.maxRingTime
Maximum ring duration in seconds before disconnecting. Must be between 5 and 120.
number, required
experienceFlowName
Name of the voice flow (bot or IVR) used to interact with the user.
string, required
enableMachineDetect
Enables detection of answering machines/voicemails. Valid values are: no (disable AMD), detect (detect machine and trigger flow), disconnect (detect machine and disconnect the call).
