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