1. References
  2. Management API
  3. CallLists
Rate this page:

CallLists

Methods

AppendToCallList

Copy URL

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.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Call list manager
AppendToCallList example
Copy

AppendToCallList example

Append new tasks to existing call list.

Parameters

  • delimiter:

    string

    Optional

    Separator values. The default is ';'

  • encoding:

    string

    Optional

    Encoding file. The default is UTF-8

  • escape:

    string

    Optional

    Escape 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

Copy URL

Cancels the specified tasks in the call list by their IDs or UUIDs.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Call list manager
CancelCallListTask example
Copy

CancelCallListTask example

Cancel the call list tasks by IDs.

Parameters

  • account_id:

    string

    Account's ID

  • list_id:

    string

    Call list's ID

  • tasks_ids:

    string

    Optional

    Task IDs separated by a semicolon. Specify either tasks_ids or tasks_uuids. The method returns an error if none of the parameters is specified

  • tasks_uuids:

    string

    Optional

    Task UUIDs separated by a semicolon. Specify either tasks_ids or tasks_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

Copy URL

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.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Call list manager
CreateCallList example
Copy

CreateCallList example

Add a new CSV file.

Parameters

  • delimiter:

    string

    Optional

    Separator values. The default is ';'

  • encoding:

    string

    Optional

    Encoding file. The default is UTF-8

  • escape:

    string

    Optional

    Escape character for parsing csv

  • file_content:

    file

    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

    Optional

    Interval 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

    Optional

    Specifies 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

    Optional

    Specifies 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

Copy URL

Deletes an existing call list by its ID.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Call list manager
DeleteCallList example
Copy

DeleteCallList example

Deletes the call list with ID=1.

Parameters

  • account_id:

    number

    Account's ID

Returns

  • msg:

    string

    Text description

  • result:

    boolean

    Result

EditCallListTask

Copy URL

Edits the specified call list's task.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Call list manager
Support
EditCallListTask example
Copy

EditCallListTask example

Set attempts_left, start_at, and custom_data the task with id=1 in the call list with id=1.

Parameters

  • attempts_left:

    number

    Optional

    Number of remaining calling attempts

  • custom_data:

    string

    Optional

    Custom data string

  • list_id:

    number

    Call list's ID

  • min_execution_time:

    timestamp

    Optional

    Start time for the daily calling attempts in the UTC+0 24-h format: HH:mm:ss format

  • start_at:

    timestamp

    Optional

    Next calling attempts timestamp in the yyyy-MM-dd HH:mm:ss format

  • task_id:

    number

    Optional

    Call list's task ID. Please specify either the task's ID or the task's UUID to edit the task

  • task_uuid:

    string

    Optional

    Call 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

Copy URL

Gets details of the specified call list. Returns a CSV file by default.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Call list manager
sys.Admin read only
GetCallListDetails example
Copy

GetCallListDetails example

Get all lists registered by user.

Parameters

  • count:

    number

    Optional

    Maximum number of entries in the result

  • delimiter:

    string

    Optional

    Separator values. The default is ';'

  • encoding:

    string

    Optional

    Encoding of the output file. Default UTF-8

  • list_id:

    number

    The list ID

  • offset:

    number

    Optional

    The first N records are skipped in the output

  • output:

    string

    Optional

    Output format (CSV/JSON/XLS). Default CSV

Returns

GetCallLists

Copy URL

Get all call lists for the specified user.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Supervisor
Call list manager
Support
GetCallLists example
Copy

GetCallLists example

Get all lists registered by user.

Parameters

  • application_id:

    intlist

    Optional

    The application ID to filter. Can be a list separated by semicolons (;). Use the 'all' value to select all applications

  • count:

    number

    Optional

    The max returning record count

  • from_date:

    timestamp

    Optional

    The UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss

  • is_active:

    boolean

    Optional

    Whether to find only active call lists

  • list_id:

    intlist

    Optional

    The list ID to filter. Can be a list separated by semicolons (;). Use the 'all' value to select all lists

  • name:

    string

    Optional

    Find call lists by name

  • offset:

    number

    Optional

    The first N records are skipped in the output

  • to_date:

    timestamp

    Optional

    The UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss

  • type_list:

    string

    Optional

    The type of the call list. The possible values are AUTOMATIC and MANUAL

Returns

  • count:

    number

    The returned call list count

  • result:

    [CallListType]

    Array of lists

  • total_count:

    number

    The total found call list count

RecoverCallList

Copy URL

Resume processing the specified call list.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Call list manager
RecoverCallList example
Copy

RecoverCallList example

Restore list with id = 1.

Parameters

  • list_id:

    number

    The list Id

Returns

  • count_recovery:

    number

    Number restored tasks

  • result:

    boolean

    true

StopCallListProcessing

Copy URL

Stops processing the specified call list.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Call list manager
Support
StopCallListProcessing example
Copy

StopCallListProcessing example

Cancel list with id = 1.

Parameters

  • list_id:

    number

    The list Id

Returns

  • msg:

    string

    Result message

  • result:

    boolean

    true