Этот метод позволяет добавлять до 1000 кандидатов в задание на обзвон. Время, необходимое для подготовки задания перед стартом, зависит от количества добавленных кандидатов.
| Предупреждение |
|---|
Кандидатов в задание нельзя добавлять сразу после создания задания. Либо нужна небольшая задержка (хотя бы 2 сек, лучше 5), либо status = BLANK в ответе метода на получение информации по заданию. |
Метод: POST
Authorization: Bearer Token
URL: https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/batch
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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 – задание будет автоматически запущено после добавления кандидатов. |
batch | List[object] | да | Массив кандидатов для обзвона |
| phone | List[string] | да | Номера телефона кандидата |
| variables | Object[object] | нет | Объект с переменными по кандидату. |
| | any_key | string | нет | Пользовательская стартовая переменная по кандидату |
| callbackData | Object[object] | нет | Объект с полями информации по кандидату, которую нужно вернуть в неизменном виде в хуке о результате звонка и результате обработки кандидата. Например: ID клиента или ID номера телефона. Ограничений на количество нет, для примера указаны 2 |
| | any_key | string | нет | Поле и значение, возвращаемое в хуке о результате звонка или результате обработки кандидата |
| clientExternalId | string | нет | Внешний идентификатор клиента |
| timezone | int | нет | Таймзона кандидата (отклонение от UTC+0 в минутах) |
| autoCallId | string | да | Идентификатор задания на обзвон |
При успешном выполнении метода придет ответ с кодом 200 без тела