Этот метод позволяет добавлять до 1000 кандидатов в задание на обзвон. Время, необходимое для подготовки задания перед стартом, зависит от количества добавленных кандидатов.

Кандидатов в задание нельзя добавлять сразу после создания задания. Либо нужна небольшая задержка (хотя бы 2 сек, лучше 5), либо status = BLANK в ответе метода на получение информации по заданию. 

Метод: POST

Authorization: Bearer Token

URL: https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/batch

cURL 
curl --location 'https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/batch' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ТОКЕН' \
--data '{
    "forceStart": false,
    "batch": [
        {
            "phone": [
                "7999*******",
                "7995*******"
            ],
            "variables": {
                "name": "Иван Иванов",
                "age": "35"
            },
            "callbackData": [
                {
                    "id_debt": "123654",
                    "id_num": "4w421"
                }
            ],
            "clientExternalId": "123",
            "timezone": 0,
            "autoCallId": "de9fe70...a0e41a1f"
        },
        {
            "phone": [
                "7914*******"
            ],
            "variables": {
                "name": "Петр Петров",
                "age": "22"
            },
            "callbackData": [
                {
                    "id_debt": "456321",
                    "id_num": "12q12"
                }
            ],
            "autoCallId": "de9fe70...a0e41a1f"
        }
    ]
}'
Тело запроса 
{
    "forceStart": true,
    "batch": [
        {
            "phone": [
                "7999*******",
                "7995*******"
            ],
            "variables": {
                "name": "Иван Иванов",
                "age": "35"
            },
            "callbackData": [
                {
                    "id_debt": "123654",
                    "id_num": "4w421"
                }
            ],
            "clientExternalId": "123",
            "timezone": 0,
            "autoCallId": "de9fe70...a0e41a1f"
        },
        {
            "phone": [
                "7914*******"
            ],
            "variables": {
                "name": "Петр Петров",
                "age": "22"
            },
            "callbackData": [
                {
                    "id_debt": "456321",
                    "id_num": "12q12"
                }
            ],
            "autoCallId": "de9fe70...a0e41a1f"
        }
    ]
}

Описание полей метода:

Поле

Тип

Обязательно

Описание

forceStart

boolean

нет

Если передано true – задание будет автоматически запущено после добавления кандидатов.
Если передано false, или данный параметр отсутствует в теле запроса – задание будет ожидать запуска вручную/по расписанию.

batch

List[object]

да

Массив кандидатов для обзвона

|    phone

List[string]

да

Номера телефона кандидата

|    variables

Object[object]

нет

Объект с переменными по кандидату.
Ограничений на количество нет, для примера указаны 2

|    |    any_key

stringнетПользовательская стартовая переменная по кандидату

|   callbackData 

Object[object]нетОбъект с полями информации по кандидату, которую нужно вернуть в неизменном виде в хуке о результате звонка и результате обработки кандидата. Например: ID клиента или ID номера телефона.
Ограничений на количество нет, для примера указаны 2

|    |    any_key

stringнетПоле и значение, возвращаемое в хуке о результате звонка или результате обработки кандидата

|    clientExternalId

stringнетВнешний идентификатор клиента

|    timezone

intнетТаймзона кандидата (отклонение от UTC+0 в минутах)

|    autoCallId

string

да

Идентификатор задания на обзвон

При успешном выполнении метода придет ответ с кодом 200 без тела

  • Нет меток