POST: https://twin24.ai/cis/api/v1/telephony/autoCallCandidate/single
Тип авторизации: BEARER
Метод позволяет создать задание на обзвон, добавить в него кандидата и запустить задание для звонка добавленному кандидату.
Перед запуском метода необходимо создать шаблон задания на обзвон и установить настройку использования этого шаблона по умолчанию. Подробнее о создании и настройке шаблона по умолчанию читайте в статье Управление шаблонами.
При использовании метода создается одно задание на обзвон в сутки под каждого участвующего бота. Использование метода повторно в течение одних суток после создания задания будет добавлять новых кандидатов в уже созданное задание. Все настройки создаваемого задания на обзвон, кроме сценария бота, берутся из шаблона, установленного по умолчанию в личном кабинете.
Сценарий бота, который будет использоваться в звонках, указывается в теле запроса в поле
botSettingsId.
curl --request POST \
--url https://twin24.ai/cis/api/v1/telephony/autoCallCandidate/single \
--header 'accept: application/json' \
--header 'authorization: Bearer ТОКЕН' \
--header 'content-type: application/json' \
--data '
{
"callbackData": {
"test": "123"
},
"phone": [
"79991234567"
],
"botSettingsId": "2656622a-57b2-478f-acf9-6167120d18bf",
"variables": {
"Имя": "Николай",
"Возраст": "28"
},
"timezone": 16800
}
'
{
"callbackData": {
"test": "123"
},
"phone": [
"79991234567"
],
"botSettingsId": "2656622a-57b2-478f-acf9-6167120d18bf",
"variables": {
"Имя": "Николай",
"Возраст": "28"
},
"timezone": 16800
}
| Название | Тип | Обязательное | Описание |
|---|---|---|---|
phone |
List[string] | Да | Список номеров телефона кандидатов, на которые будет запущен звонок. |
botSettingsId |
String | Да | Идентификатор сценария бота, который будет запущен в звонке. |
variables |
Object | Нет | Объект с пользовательскими переменными по кандидату. |
timezone |
Int | Нет | Часовой пояс кандидата. Указывается как отклонение от UTC+0 в секундах. Максимальное значение 43200 и минимальное -43200. |
callbackData |
Object | Нет | Объект с полями информации по кандидату. Информация возвращается в неизменном виде в хуках о результате звонка и о результате обработки кандидата. Например: ID клиента или ID номера телефона. |
{
"id": {
"identity": "bce7d22e-dde6-4427-b391-ebbdfda44de6"
}
}
Описание полей ответа:
| Название | Тип | Обязательное | Описание |
|---|---|---|---|
id |
object | Да | Объект, содержащий идентификатор кандидата, добавленного в созданное методом задание на обзвон. |
identity |
string | Да | Идентификатор добавленного кандидата на обзвон. |
{
"timestamp": 1544098870,
"type": "MyNamespace\\MyClass",
"error": "string",
"details": {}
}
Описание полей ответа:
| Название | Тип | Обязательное | Описание |
|---|---|---|---|
timestamp |
integer | Да | Текущее время. |
type |
string | Да | Класс исключения. |
error |
string | Да | Сообщение об ошибке. |
details |
object | null | Нет | Дополнительная информация об ошибке. |