Rate this page:

EditCallListRequest

Props

avgDialTimeSec
Optional
Copy URL
avgDialTimeSec: 

number

The average dial time in seconds for the dialing statistics. Cannot be negative

avgTimeTalkSec
Optional
Copy URL
avgTimeTalkSec: 

number

The average talk time in seconds for the dialing statistics. Cannot be negative

avgTotalTimeSec
Optional
Copy URL
avgTotalTimeSec: 

number

The average total call time in seconds for the dialing statistics. Cannot be negative

callListType
Optional
Copy URL
callListType: 

string

Call list type. The possible values are: automatic, manual, predictive, progressive. The value is case-insensitive

callType
Optional
Copy URL
callType: 

string

Alias for call_list_type. Applies only if call_list_type is not specified

intervalSeconds
Optional
Copy URL
intervalSeconds: 

number

Minimum interval between call attempts. Cannot be a negative value

ipAddress
Optional
Copy URL
ipAddress: 

string

IP address in the Inet4Address format

isPersonalCampaign
Optional
Copy URL
isPersonalCampaign: 

boolean

Whether the call list is a personal campaign. Required if personal_campaign_type is specified

listCustomData
Optional
Copy URL
listCustomData: 

string

Custom data string for the call list

listId
Copy URL
listId: 

number

Call list ID. If the ID is non existing, the 251 error returns

maxSimultaneous
Optional
Copy URL
maxSimultaneous: 

number

Maximum simultaneous call attempts for this call list. Cannot be less than 1

maximumErrorRate
Optional
Copy URL
maximumErrorRate: 

number

The maximum abandoned call rate for predictive dialing, from 0 to 1. If omitted while call_list_type is set to predictive, the value becomes 0.02

minimumBusyFactor
Optional
Copy URL
minimumBusyFactor: 

number

The minimum agent busy factor for predictive dialing. Cannot be negative. If omitted while call_list_type is set to predictive, the value becomes 0.8

name
Optional
Copy URL
name: 

string

Call list name. Cannot be bigger than 255 characters, cannot contain slash symbol

numAttempts
Optional
Copy URL
numAttempts: 

number

Maximum call attempt number. Cannot be less than 1

percentSuccessful
Optional
Copy URL
percentSuccessful: 

number

The successful call ratio for the dialing statistics. Cannot be negative

personalCampaignType
Optional
Copy URL
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
Optional
Copy URL
predictiveType: 

string

The predictive dialing algorithm. The possible values are: AR_OPTIMIZED, BF_OPTIMIZED, AR_SMALL_GROUP, AR_AUTO_BALANCED. If omitted while call_list_type is set to predictive, the value becomes AR_OPTIMIZED; for progressive the value is reset

priority
Optional
Copy URL
priority: 

number

Call list's priority among other call list. The lower the value, the higher is the call list's priority

serverLocation
Optional
Copy URL
serverLocation: 

string

Location of the server processing the call list. If the ID is non existing, the 496 error returns: The 'server_location' parameter is invalid.

startAt
Optional
Copy URL
startAt: 

number

Time when the call list should start, as a Unix timestamp in seconds (UTC)

taskMultiplier
Optional
Copy URL
taskMultiplier: 

number

The task multiplier for progressive dialing. Cannot be negative. If omitted while call_list_type is set to progressive, the value becomes 1

taskPriorityStrategy
Optional
Copy URL
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

Rate this page: