...
Authorization: Bearer Token (Метод для получения токена по логину и паролю)
URL: https://tcl.twin24.ai/api/cis/beta/tasks
...
Блок кода | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
{ "name": "02.02 тестирование на номер Никиты", "botId": "44e62ac6-6c08-4ad1-923d-5ee3299dd737", "dialplanId": "d71c9c44-e942-4c6c-9ccc-ea5a043efb75", "backgroundNoise": "/background/office.wav", "amd": { "enabled": true, "mode": "BACK", "file": null }, "defaultCallerId": { "type": "Custom ", "data": "7913391204779996662211", "additional": null }, "defaultRedirect": { "type": "hangup", "data": null, "additional": null }, "scheduledAt": null, "intensity": 1, "webhookUrl": "https://webhook.site/12345678", "allowedTimeRange": { "from": 32500, "to": 79000 }, "phoneNormalization": "ru", "detectGenderByVoice": true, "isTest": false, "recallRules": { "BUSY": { "enabled": true, "tries": 3, "interval": 900 }, "NO_ANSWER": { "enabled": true, "tries": 3, "interval": 1800 }, "MACHINE": { "enabled": true, "tries": 2, "interval": 1800 }, "CONGESTION": { "enabled": true, "tries": 3, "interval": 900 }, "NOT_SUCCESSFUL": { "enabled": false, "tries": null, "interval": null, "duration": 0 } } } |
Подсказка | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Значения полей параметров передаются в блоке Запрос к серверу передаются как JSON-объект в следующем виде:
Если параметр представляет собой пару «ключ/значение» 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 | Режим запуска задания. Если задание должно запуститься автоматически в определенную дату и время, их необходимо указать в формате дд.мм.гггг чч:ммГГГГ-ММ-ДДTчч:мм:сс+чч:мм (год-месяц-деньTчасы:минуты:секунды+часовой пояс) Например: 2022-10-13T09:00:00+00:00. Если задание будет запущено сразу должно запуститься при загрузке реестра номеров, укажите null. |
intensity | Int | Да | 1 | Интенсивность обзвона. Указывает для системы обзвона, сколько нужно совершать одновременных наборов номеров , какое количество вызовов система будет совершать в секунду. При Например, при значении 1 , например, система будет набирать один номер , каждую секунду. , 60 вызовов за номеров в минуту и 3 600 3 600 номеров за час работы задания. Задается целым числом в виде целого числа в диапазоне от 1 до 5. |
webhookUrl | string | Нет |
| URL webhook'а, на который присылать вебхук по результату диалога. Протестировать работу вебхука можно через сервис https://webhook.site |
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": "ce68bf14-2d76-4bf3-b718-3df2d36b7698" } |
Описание полей ответа:
Поле | Тип | Обязательно | Описание |
id | string | Да | Уникальный идентификатор созданного задания на обзвон. По этому идентификатору задание можно наполнятьредактировать, управлять его параметрами , и получать по нему статистику с результатами обработки. |