Rate this page:

CallLists

Methods

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 will start every day, UTC+0 24-h format: HH:mm:ss
  • __end_execution_time – when the call list processing will stop every day, UTC+0 24-h format: HH:mm:ss
  • __start_at – when the call list processing will start, UNIX timestamp. If not specified, the processing will start immediately after a method call

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 won't start, or it stops immediately if it was active.

CreateCallList example

CreateCallList example

Add a new CSV file.

Parameters

  • rule_id:

    number

    Optional

    The rule ID. It's specified in the Applications section of the Control Panel

  • priority:

    number

    Optional

    Call list priority. The value is in the range of [0 … 2^31] where zero is the highest priority.

  • max_simultaneous:

    number

    Optional

    Number simultaneously processed tasks.

  • num_attempts:

    number

    Optional

    Number of attempts. Minimum is 1, maximum is 5.

  • name:

    string

    Optional

    File name, up to 255 characters and can't contain the '/' and '\' symbols.

  • file_content:

    string

    Optional

    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.

  • queue_id:

    number

    Optional

    Queue Id. For processing call list with PDS (predictive dialer) the ID of the queue must be specified.

  • avg_waiting_sec:

    number

    Optional

    Average waiting time in the queue(seconds). Default is 1

  • encoding:

    string

    Optional

    Encoding file. The default is UTF-8.

  • delimiter:

    string

    Optional

    Separator values. The default is ';'

  • escape:

    string

    Optional

    Escape character. Used for parsing csv

  • reference_ip:

    string

    Optional

    Specifies the IP from the geolocation of call list subscribers. It allows selecting the nearest server for serving subscribers.

Returns

  • result:

    boolean

    true

  • count:

    number

    The number of stored records

  • list_id:

    number

    The list ID.

CreateManualCallList

Copy URL

Adds a new CSV file for manual call list processing and bind it with the specified rule. To send a file, use the request body. To start processing calls, use the function StartNextCallTask. 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 won't start, or it stops immediately if it was active.

CreateManualCallList example

CreateManualCallList example

Add a new CSV file.

Parameters

  • rule_id:

    number

    Optional

    The rule ID.

  • priority:

    number

    Optional

    Call list priority. The value is in the range of [0 … 2^31] where zero is the highest priority.

  • max_simultaneous:

    number

    Optional

    Number simultaneously processed tasks.

  • num_attempts:

    number

    Optional

    Number of attempts. Should be equal or greater than 1

  • name:

    string

    Optional

    File name.

  • file_content:

    string

    Optional

    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.

  • encoding:

    string

    Optional

    Encoding file. The default is UTF-8.

  • delimiter:

    string

    Optional

    Separator values. The default is ';'

  • escape:

    string

    Optional

    Escape character. Used for parsing csv

  • reference_ip:

    string

    Optional

    Specifies the IP from the geolocation of call list subscribers. It allows selecting the nearest server for serving subscribers.

Returns

  • result:

    boolean

    true

  • count:

    number

    The number of stored records

  • list_id:

    number

    The list ID.

StartNextCallTask

Copy URL

Start processing the next task.

StartNextCallTask example

StartNextCallTask example

Start next call task

Parameters

  • list_id:

    number

    Optional

    The list Id. Can use a set of identifiers with the separator ";"

  • custom_params:

    string

    Optional

    The custom param. Use to transfer the call initiator parameters to the scenario.

Returns

  • result:

    number

    true

  • list_id:

    number

    The list id.

AppendToCallList

Copy URL

Appending a new task to the existing call list.

AppendToCallList example

AppendToCallList example

Append new tasks to existing call list.

Parameters

  • list_id:

    number

    The call list ID

  • list_name:

    string

    Can be used instead of list_id. The unique name call list

  • file_content:

    string

    Optional

    Send as request body or multiform.

  • encoding:

    string

    Optional

    Encoding file. The default is UTF-8.

  • escape:

    string

    Optional

    Escape character. Used for parsing csv

  • delimiter:

    string

    Optional

    Separator values. The default is ';'

Returns

  • result:

    boolean

    true

  • count:

    number

    The number of stored records

  • list_id:

    number

    The list ID.

GetCallLists

Copy URL

Get all call lists for the specified user.

GetCallLists example

GetCallLists example

Get all lists registered by user

Parameters

  • list_id:

    intlist

    Optional

    The list ID to filter. Can be a list separated by the ';' symbol or the 'all' value.

  • name:

    string

    Optional

    Find call lists by name

  • is_active:

    boolean

    Optional

    Find only active call lists

  • from_date:

    timestamp

    Optional

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

  • 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 call list. The possible values are: AUTOMATIC and MANUAL

  • count:

    number

    Optional

    The max returning record count.

  • offset:

    number

    Optional

    The first N records will be skipped in the output.

  • application_id:

    intlist

    Optional

    The application ID to filter. Can be a list separated by the ';' symbol or the 'all' value.

Returns

  • Array of lists.

  • count:

    number

    The returned call list count.

  • total_count:

    number

    The total found call list count.

GetCallListDetails

Copy URL

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

GetCallListDetails example

GetCallListDetails example

Get all lists registered by user

Parameters

  • list_id:

    number

    Optional

    The list ID.

  • count:

    number

    Optional

    Maximum number of entries in the result

  • offset:

    number

    Optional

    The first N records will be skipped in the output.

  • output:

    string

    Optional

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

  • encoding:

    string

    Optional

    Encoding of the output file. Default UTF-8

  • delimiter:

    string

    Optional

    Separator values. The default is ';'

Returns

StopCallListProcessing

Copy URL

Stop processing the specified call list.

StopCallListProcessing example

StopCallListProcessing example

Cancel list with id = 1

Parameters

  • list_id:

    number

    Optional

    The list Id.

Returns

  • result:

    boolean

    true

  • msg:

    string

    Result message.

RecoverCallList

Copy URL

Resume processing the specified call list.

RecoverCallList example

RecoverCallList example

Restore list with id = 1

Parameters

  • list_id:

    number

    Optional

    The list Id.

Returns

  • result:

    boolean

    true

  • count_recovery:

    number

    Number restored tasks