SIGN UP

Managing Call Lists

Methods

Appending new task to existing call list.

Parameters

  • Follow link for authentication parameter names and details.

  • 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

    Send as Body Request or multiform.

  • encoding:

    string

    Encoding file. The default is UTF-8.

  • delimiter:

    string

    Separator values. The default is ';'

Returns

  • result:

    boolean

    true

  • count:

    number

    The number of stored records

  • list_id:

    number

    The list ID.

Examples

request:

Append new tasks to existing call list.

https://api.voximplant.com/platform_api/AppendToCallList/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&rule_id=22071&list_id=1

response:

{
    "count": 1,
    "result": true,
    "list_id": 1
}

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 options __start_execution_time and __end_execution_time in CSV file. Time is in 24-h format: HH:mm:ss. 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.

Parameters

  • Follow link for authentication parameter names and details.

  • rule_id:

    number

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

  • priority:

    number

    Сall list priority. The value is in the range of 0 to 2^31 where zero is the highest priority.

  • max_simultaneous:

    number

    Number simultaneously processed tasks.

  • num_attempts:

    number

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

  • name:

    string

    File name.

  • file_content:

    string

    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

    Interval between call attempts in seconds. The default is 0.

  • queue_id:

    number

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

  • avg_waiting_sec:

    number

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

  • encoding:

    string

    Encoding file. The default is UTF-8.

  • delimiter:

    string

    Separator values. The default is ';'

  • reference_ip:

    string

    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.

Examples

request:

Add a new CSV file.

curl --data-binary '@callList.csv' -H 'Content-type: text/csv' 'https://api.voximplant.com/platform_api/CreateCallList/?account_id=1&api_key=4ed6060e-4608-443a-95e8-3f8f8481280c&rule_id=1&priority=1&max_simultaneous=2&num_attempts=2&name=callList'

response:

{
    "count": 1,
    "result": true,
    "list_id": 1
}

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.

Parameters

  • Follow link for authentication parameter names and details.

  • rule_id:

    number

    The rule ID.

  • priority:

    number

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

  • max_simultaneous:

    number

    Number simultaneously processed tasks.

  • num_attempts:

    number

    Number of attempts. Should be equal or greater than 1

  • name:

    string

    File name.

  • file_content:

    string

    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

    Interval between call attempts in seconds. The default is 0.

  • encoding:

    string

    Encoding file. The default is UTF-8.

  • delimiter:

    string

    Separator values. The default is ';'

  • reference_ip:

    string

    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.

Examples

request:

Add a new CSV file.

curl --data-binary '@callList.csv' -H 'Content-type: text/csv' 'https://api.voximplant.com/platform_api/CreateManualCallList/?account_id=1&api_key=4ed6060e-4608-443a-95e8-3f8f8481280c&rule_id=1&priority=1&max_simultaneous=2&num_attempts=2&name=callList'

response:

{
    "count": 1,
    "result": true,
    "list_id": 1
}

Get details of the tasks of outgoing calls. Default return CSV file.

Parameters

  • Follow link for authentication parameter names and details.

  • list_id:

    number

    The list ID.

  • count:

    number

    Maximum number of entries in the result

  • offset:

    number

    The first N records will be skipped in the output.

  • output:

    string

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

  • encoding:

    string

    Encoding of the output file. Default UTF-8

  • delimiter:

    string

    Separator values. The default is ';'

Returns

  • Array of tasks for the roll call.

  • count:

    number

    The number of tasks.

Examples

request:

Get all lists registered by user

https://api.voximplant.com/platform_api/GetCallListDetails/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&list_id=1&output=json

response:

{
    "count": 1,
    "result": [
        {
            "status": "In progress",
            "list_id": 270,
            "status_id": 2,
            "custom_data": "{\"first_name\":\"f_name\",\"phone\":\"1234567890\",\"age\":\"28\",\"last_name\":\"l_name\"}",
            "result_data": "true",
            "last_attempt": "2014-06-03 12:33:49",
            "attmepts_left": 0,
            "start_execution_time": "",
            "finish_execution_time": ""
        }
    ]
}

Get all lists of outgoing calls registered user

Parameters

  • Follow link for authentication parameter names and details.

  • name:

    string

    Find call lists by name

  • is_active:

    boolean

    Find only active call lists

  • from_date:

    string

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

  • to_date:

    string

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

  • type_list:

    string

    The type of call list. Available values: AUTOMATIC and MANUAL

  • count:

    number

    The max returning record count.

  • offset:

    number

    The first N records will be skipped in the output.

Returns

  • result:

    [ CallListType ]

    Array of lists.

  • count:

    number

    The returned call list count.

  • total_count:

    number

    The total found call list count.

Examples

request:

Get all lists registered by user

https://api.voximplant.com/platform_api/GetCallLists/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac

response:

{
    "count": 1,
    "result": [
        {
            "list_id": 1,
            "rule_id": 2,
            "user_id": 1,
            "priority": 1,
            "dt_submit": "2014-06-03 12:33:34",
            "list_name": "test_name",
            "dt_complete": "2014-06-03 14:32:57",
            "num_attempts": 1,
            "interval_seconds": 1,
            "max_simultaneous": 100
        }
    ],
    "total_count": 1
}

Restore processing the task list

Parameters

  • Follow link for authentication parameter names and details.

  • list_id:

    number

    The list Id.

Returns

  • result:

    boolean

    true

  • count_recovery:

    number

    Number restored tasks

Examples

request:

Restore list with id = 1

https://api.voximplant.com/platform_api/RecoverCallList/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&list_id=1

response:

{
    "result": true,
    "count_recovery": 2
}

Start processing the next task

Parameters

  • Follow link for authentication parameter names and details.

  • list_id:

    number

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

  • custom_params:

    string

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

Returns

  • result:

    number

    true

  • list_id:

    number

    The list id.

Examples

request:

Start next call task

https://api.voximplant.com/platform_api/StartNextCallTask/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&list_id=1

response:

{
    "result": 1,
    "list_id": 1
}

Stop processing the task list

Parameters

  • Follow link for authentication parameter names and details.

  • list_id:

    number

    The list Id.

Returns

  • result:

    boolean

    true

  • msg:

    string

    Result message.

Examples

request:

Cancel list with id = 1

https://api.voximplant.com/platform_api/StopCallListProcessing/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&list_id=1

response:

{
    "msg": "Tasks canceled.",
    "result": true
}