...
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": " |
...
79996662211", |
...
"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 | Первичный параметр настройки для |
типов:
|
|
|
|
|
|
|
|
Для Default - null
additional | Нет | null | Дополнительная информация |
additional
Да
. Всегда 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 номеров за час работы задания. Задается |
в виде целого числа в диапазоне от 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 | Да | Уникальный идентификатор созданного задания на обзвон. По этому идентификатору задание можно |
редактировать, управлять его параметрами |
и получать по нему статистику с результатами обработки. |