CallLists
Methods
AppendToCallList
Appends a new task to the existing call list.
This method accepts CSV files with custom delimiters, such a commas (,), semicolons (;) and other. To specify a delimiter, pass it to the delimiter parameter.
To call this method, make sure your service account has one of the following roles:
Parameters
delimiter:
string
OptionalSeparator values. The default is ';'
encoding:
string
OptionalEncoding file. The default is UTF-8
escape:
string
OptionalEscape character for parsing csv
file_content:
file
Send as request body or multiform
list_id:
number
The call list ID
Returns
count:
number
The number of stored records
list_id:
number
The list ID
result:
boolean
true
CancelCallListTask
Cancels the specified tasks in the call list by their IDs or UUIDs.
To call this method, make sure your service account has one of the following roles:
Parameters
account_id:
string
Account's ID
list_id:
string
Call list's ID
tasks_ids:
string
OptionalTask IDs separated by a semicolon. Specify either
tasks_ids
ortasks_uuids
. The method returns an error if none of the parameters is specifiedtasks_uuids:
string
OptionalTask UUIDs separated by a semicolon. Specify either
tasks_ids
ortasks_uuids
. The method returns an error if none of the parameters is specified
Returns
error_msg:
string
Reason for the error
result:
boolean
Result of the operation
task_id:
number
Task's ID
task_uuid:
string
Task's UUID
CreateCallList
Adds a new CSV file for call list processing and starts the specified rule immediately. To send a file, use the request body. To set the call time constraints, use the following options in a CSV file:
- __start_execution_time – when the call list processing starts every day, UTC+0 24-h format: HH:mm:ss
- __end_execution_time – when the call list processing stops every day, UTC+0 24-h format: HH:mm:ss
- __start_at – when the call list processing starts, UNIX timestamp. If not specified, the processing starts immediately after a method call
- __task_uuid – call list UUID. A string up to 40 characters, can contain latin letters, digits, hyphens (-) and colons (:). Unique within the call list
This method accepts CSV files with custom delimiters, such a commas (,), semicolons (;) and other. To specify a delimiter, pass it to the delimiter parameter.
IMPORTANT: the account's balance should be equal or greater than 1 USD. If the balance is lower than 1 USD, the call list processing does not start, or it stops immediately if it is active.
To call this method, make sure your service account has one of the following roles:
Parameters
delimiter:
string
OptionalSeparator values. The default is ';'
encoding:
string
OptionalEncoding file. The default is UTF-8
escape:
string
OptionalEscape character for parsing csv
file_content:
Send as "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
interval_seconds:
number
OptionalInterval between call attempts in seconds. The default is 0
max_simultaneous:
number
Number of simultaneously processed tasks
name:
string
File name, up to 255 characters and cannot contain the '/' and '\' symbols
num_attempts:
number
Number of attempts. Minimum is 1, maximum is 5
priority:
number
Call list priority. The value is in the range of [0 … 2^31] where zero is the highest priority
reference_ip:
string
OptionalSpecifies the IP from the geolocation of the call list subscribers. It allows selecting the nearest server for serving subscribers
rule_id:
number
The rule ID. It is specified in the Applications section of the Control Panel
server_location:
string
OptionalSpecifies the location of the server where the scenario needs to be executed. Has higher priority than
reference_ip
. Request getServerLocations for possible values
Returns
count:
number
The number of stored records
list_id:
number
The list ID
result:
boolean
true
DeleteCallList
Deletes an existing call list by its ID.
To call this method, make sure your service account has one of the following roles:
Parameters
account_id:
number
Account's ID
Returns
msg:
string
Text description
result:
boolean
Result
EditCallListTask
Edits the specified call list's task.
To call this method, make sure your service account has one of the following roles:
Parameters
attempts_left:
number
OptionalNumber of remaining calling attempts
custom_data:
string
OptionalCustom data string
list_id:
number
Call list's ID
min_execution_time:
timestamp
OptionalStart time for the daily calling attempts in the UTC+0 24-h format: HH:mm:ss format
start_at:
timestamp
OptionalNext calling attempts timestamp in the yyyy-MM-dd HH:mm:ss format
task_id:
number
OptionalCall list's task ID. Please specify either the task's ID or the task's UUID to edit the task
task_uuid:
string
OptionalCall list's task ID. Please specify either the task's ID or the task's UUID to edit the task
Returns
result:
boolean
true
GetCallListDetails
Gets details of the specified call list. Returns a CSV file by default.
To call this method, make sure your service account has one of the following roles:
Parameters
count:
number
OptionalMaximum number of entries in the result
delimiter:
string
OptionalSeparator values. The default is ';'
encoding:
string
OptionalEncoding of the output file. Default UTF-8
list_id:
number
The list ID
offset:
number
OptionalThe first N records are skipped in the output
output:
string
OptionalOutput format (CSV/JSON/XLS). Default CSV
Returns
count:
number
The number of tasks
result:
Array of tasks for the roll call
GetCallLists
Get all call lists for the specified user.
To call this method, make sure your service account has one of the following roles:
Parameters
application_id:
intlist
OptionalThe application ID to filter. Can be a list separated by semicolons (;). Use the 'all' value to select all applications
count:
number
OptionalThe max returning record count
from_date:
timestamp
OptionalThe UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
is_active:
boolean
OptionalWhether to find only active call lists
list_id:
intlist
OptionalThe list ID to filter. Can be a list separated by semicolons (;). Use the 'all' value to select all lists
name:
string
OptionalFind call lists by name
offset:
number
OptionalThe first N records are skipped in the output
to_date:
timestamp
OptionalThe UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
type_list:
string
OptionalThe type of the call list. The possible values are AUTOMATIC and MANUAL
Returns
count:
number
The returned call list count
result:
Array of lists
total_count:
number
The total found call list count
RecoverCallList
Resume processing the specified call list.
To call this method, make sure your service account has one of the following roles:
Parameters
list_id:
number
The list Id
Returns
count_recovery:
number
Number restored tasks
result:
boolean
true
StopCallListProcessing
Stops processing the specified call list.
To call this method, make sure your service account has one of the following roles:
Parameters
list_id:
number
The list Id
Returns
msg:
string
Result message
result:
boolean
true