API. Создание задания на обзвон.
Метод: POST
Authorization: Bearer Token
URL: https://tcl.twin24.ai/api/cis/beta/tasks
Значения полей в блоке Запрос к серверу передаются в следующем виде:
| Тип значения | Пример | Значение параметра |
|---|---|---|
| Значение true | { "isTest": true } | 1 |
| Значение false | { "detectGenderByVoice": false } | 0 |
| Значение null | { "backgroundNoise": null } |
Описание полей метода:
Поле | Тип | Обязательно | Значение по умолчанию | Описание |
name | string | Да | Имя задания. Задается в любом формате, который поможет отличить одно задание от другого и понять, кому звонили, и когда был обзвон. | |
botId | string | Да | Идентификатор сценария, по которому бот должен вести диалог с клиентом, в рамках данного задания на обзвон. Для каждого аккаунта уникален, и указан у каждого сценария бота в личном кабинете. | |
dialplanId | string | Да | Идентификатор плана набора подключенной к аккаунту телефонии. Для каждого аккаунта уникален, и указан в настройках телефонии в личном кабинете. | |
backgroundNoise | string | Нет | Настройка фонового шума, для создания ощущения естественности, который воспроизводится системой, во время работы бота. Название файлов можно взять в личном кабинете. /background/office.wav – шум офиса Null - если фоновый шум не нужен. | |
amd | amdInfo { | Нет | Перечень настроек модуля определения автоответчиков. | |
enabled | boolean | Нет | Поле, отвечающее за включение/отключение работы модуля определения автоответчиков у всего задания. | |
mode | string | Нет | Режим работы модуля определения автоответчиков. Существует два режима работы: back – модуль определения автоответчиков работает параллельно с работой бота, в синхронном режиме | |
file | string | Да | Указывается путь к аудиофайлу приветствия, при режиме работы модуля определения автоответчиков BLOCK. Для режима BACK укажите null | |
defaultCallerId | defaultCallerIdInfo{ } | Нет | Настройка параметров номера телефона (АОН), который увидит на своем телефоне клиент, получив звонок от бота | |
type | Нет | Тип АОНа Default – использовать номер телефона, указанный в настройках канала связи Custom – использовать указанный в поле data номер телефона groupAON – использовать настроенную в личном кабинете группу АОНов | ||
data | Нет | Первичный параметр настройки для типов Custom – указываем номер телефона, который хотим использовать в качестве АОНа, в формате 7хххххххххх groupAON – указываем ID группы АОНов, настроенную в личном кабинете Для Default - null | ||
additional | Нет | Доп ифнормация. Всегда null | ||
defaultRedirect | defaultRedirectInfo{ } | Нет | Настройка параметров переадресации звонка по умолчанию. Будет использоваться если сценарий требует перевода и в самом сценарии указано использование параметров переадресации из настроек задания. | |
type | string | Нет | Тип переадресации по умолчанию Hangup – завершить диалог Dialplan – план набора Transfer – направление перевода Custom – произвольный перевод Twin – другой сценарий | |
data | string | Нет | Первичный параметр настройки для типов Dialplan – план набора Transfer – направление перевода Custom – произвольный перевод Twin – другой сценарий Для Hangup - null | |
additional | string | Нет | Вторичный параметр настройки для типов Dialplan – план набора Custom – произвольный перевод Для остальных - null | |
scheduledAt | Date | Нет | Режим запуска задания. Если задание должно запуститься автоматически в определенное дату и время, их необходимо указать в формате дд.мм.гггг чч:мм Если задание будет запущено сразу при загрузке реестра номеров, укажите null | |
intensity | Int | Да | Интенсивность обзвона. Указывает для системы обзвона, сколько нужно совершать одновременных наборов номеров в секунду. При значении 1, например, система будет набирать один номер, каждую секунду. 60 вызовов за минуту и 3 600 номеров за час работы задания. Задается целым числом в диапазоне от 1 до 5. | |
allowedTimeRange | allowedTimeRangeInfo{ | Нет | Указание самого раннего и самого позднего времени, в которое можно позвонить клиенту, в рамках данного задания. | |
from | Int | Нет | Самое ранее время, в которое можно позвонить клиенту. Указывается в секундах, с отсчетом от 00:00 | |
to | Int | Нет | Самое позднее время, в которое можно позвонить клиенту. Указывается в секундах, с отсчетом от 00:00 | |
phoneNormalization | string | Нет | Модификатор номеров телефона, загруженных в задание, к формату, который нужен для системы обзвона. ru – номера будут приводиться в формат номера для звона по России null – переданные номера будут передаваться в работу в том виде, в котором их передали | |
detectGenderByVoice | boolean | Нет | Поле, отвечающее за включение/отключение работы модуля определения половой принадлежности клиента по его голосу. | |
isTest | boolean | Нет | Признак для отключения у задания механизмов ограничений ФЗ 230 и отключение любых сдерживающих механизмов платформы. true – задание считается тестовым и для него отключаются механизмы соблюдения ФЗ и прочее. | |
recallRules | recallRulesInfo { | Нет | Перечень настроек стратегии перезвонов. Перезвон на каждый статус попытки дозвона настраивается отдельно. | |
BUSY | busyInfo { | Нет | Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Занято» | |
enabled | boolean | Нет | Поле, отвечающие за необходимость перезвона на статус true – нужно перезванивать | |
tries | Int | Нет | Количество попыток дозвона на статус | |
interval | Int | Нет | Длительность паузы между попытками перезвона в секундах | |
NO_ANSWER | no_answerInfo { | Нет | Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Нет ответа» | |
enabled | boolean | Нет | Поле, отвечающие за необходимость перезвона на статус true – нужно перезванивать | |
tries | Int | Нет | Количество попыток дозвона на статус | |
interval | Int | Нет | Длительность паузы между попытками перезвона в секундах | |
MACHINE | machineInfo { | Нет | Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от модуля определения автоответчиков, при условии его работы, статус «Атоответчик» | |
enabled | boolean | Нет | Поле, отвечающие за необходимость перезвона на статус true – нужно перезванивать | |
tries | Int | Нет | Количество попыток дозвона на статус | |
interval | Int | Нет | Длительность паузы между попытками перезвона в секундах | |
CONGESTION | congestionInfo { | Нет | Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Ошибка дозвона» | |
enabled | boolean | Нет | Поле, отвечающие за необходимость перезвона на статус true – нужно перезванивать | |
tries | Int | Нет | Количество попыток дозвона на статус | |
interval | Int | Нет | Длительность паузы между попытками перезвона в секундах | |
NOT_SUCCESSFUL | not_SuccessFulInfo { | Нет | Настройки стратегии перезвонов на номера, у которых время диалога бота было ниже или равным указанного в настройках данной опции | |
enabled | boolean | Нет | Поле, отвечающие за необходимость перезвона на статус true – нужно перезванивать | |
tries | Int | Нет | Количество попыток дозвона на статус | |
interval | Int | Нет | Длительность паузы между попытками перезвона в секундах | |
duration | Int | Нет | Длительность, ниже или равной которой диалог считается не результативным и потребует перезвона на данный номер клиента |
Описание полей ответа:
Поле | Тип | Обязательно | Описание |
id | string | Да | Уникальный идентификатор созданного задания на обзвон. По этому идентификатору задание можно наполнять, управлять его параметрами, и получать по нему статистику с результатами обработки |