CreateCallListRequest
Props
acdVersion: string
The ACD version. The possible values are: V1, V2. Applies only if call_list_type is predictive or progressive
avgDialTimeSec: number
The initial average dial time in seconds for the dialing statistics. Applies only if call_list_type is predictive or progressive
avgTimeTalkSec: number
The initial average talk time in seconds for the dialing statistics. Applies only if call_list_type is predictive or progressive
avgTotalTimeSec: number
The initial average total call time in seconds for the dialing statistics. Applies only if call_list_type is predictive or progressive
bufferSizeTarget: string
The PDS buffer size target. The possible values are: VALUE, OPERATOR, AGENT. Applies only if call_list_type is predictive or progressive
bufferSizeValue: number
The PDS buffer size, from 20 to 500. Applies only if buffer_size_target is VALUE
bufferThresholdFactor: number
The PDS buffer threshold factor. Cannot be negative. Applies only if buffer_size_target is specified
callListType: string
Call list type. The possible values are: automatic, predictive, progressive. The value is case-insensitive
delimiter: string
Separator values. The default value is ';'
encoding: string
Encoding file. The default value is UTF-8
escape: string
Escape character for parsing csv
fileContent: Buffer
Send as the "body" part of the HTTP request or as multiform. The sending "file_content" via URL is at its own risk because the network devices tend to drop HTTP requests with large headers. Refer to the Call lists guide to learn about file syntax
intervalSeconds: number
Interval between call attempts in seconds. The default value is 0
ipAddress: string
IP from the geolocation of the call list subscribers. It allows selecting the nearest server for serving subscribers. If not specified, the client IP of the request is used
isCancelled: boolean
Whether to create the call list in the cancelled state
isPersonalCampaign: boolean
Whether the call list is a personal campaign. Applies only if call_list_type is progressive
listCustomData: string
Custom data string for the call list
maxSimultaneous: number
Number of simultaneously processed tasks
maximumErrorRate: number
The maximum abandoned call rate for predictive dialing, from 0 to 1. Applies only if call_list_type is predictive or progressive
minimumBusyFactor: number
The minimum agent busy factor for predictive dialing, from 0 to 1. Applies only if call_list_type is predictive or progressive
name: string
File name, up to 255 characters and cannot contain the '/' and '\' symbols
numAttempts: number
Number of attempts. Minimum is 1, maximum is 5
percentSuccessful: number
The initial successful call ratio for the dialing statistics. Applies only if call_list_type is predictive or progressive
personalCampaignType: string
The personal campaign mode. The possible values are: smart, strict. Allowed only if is_personal_campaign is true; the default value in that case is smart
predictiveType: string
The predictive dialing algorithm. The possible values are: DEFAULT_PREDICTIVE_TYPE, AR_OPTIMIZED, BF_OPTIMIZED, AR_SMALL_GROUP, AR_AUTO_BALANCED. Applies only if call_list_type is predictive
priority: number
Call list priority. The value is in the range of [0 … 2^31] where zero is the highest priority
queueId: number
The ACD queue ID. Required if call_list_type is predictive or progressive, and should be omitted otherwise
quote: string
Quote character for parsing csv
serverLocation: string
Location of the server where the scenario needs to be executed. Has higher priority than ip_address. Request getServerLocations for possible values
startAt: number
Time when the call list should start, as a Unix timestamp in seconds (UTC). The default value is the current time. The value cannot be in the past
taskMultiplier: number
The task multiplier for progressive dialing. The minimum value is 1. Applies only if call_list_type is progressive
taskPriorityStrategy: string
Optional. Whether to prioritize first calling attempts or repeated ones. The possible values are: first_attempts, repeated_attempts. The default values is first_attempts.