...
| Подсказка | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Значения полей в блоке Запрос к серверу передаются в следующем виде:
|
Описаниеполейметода:
Поле | Тип | Обязательно | Значение по умолчанию | Описание |
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 | Нет | Модификатор номеров телефона, загруженных в задание, к формату, который нужен для системы обзвона. ru – номера будут приводиться в формат номера для звона по России null – переданные номера будут передаваться в работу в том виде, в котором их передали | |
detectGenderByVoice | boolean | Нет | false | Поле, отвечающее за включение/отключение работы модуля определения половой принадлежности клиента по его голосу. |
isTest | boolean | Нет | false | Признак для отключения у задания механизмов ограничений ФЗ 230 и отключение любых сдерживающих механизмов платформы. true – задание считается тестовым и для него отключаются механизмы соблюдения ФЗ и прочее. |
recallRules | recallRulesInfo { | Нет | Перечень настроек стратегии перезвонов. Перезвон на каждый статус попытки дозвона настраивается отдельно. | |
BUSY | busyInfo { | Нет | Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Занято» | |
enabled | boolean | Нет | false | Поле, отвечающие за необходимость перезвона на статус true – нужно перезванивать |
tries | Int | Нет | null | Количество попыток дозвона на статус |
interval | Int | Нет | null | Длительность паузы между попытками перезвона в секундах |
NO_ANSWER | no_answerInfo { | Нет | Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Нет ответа» | |
enabled | boolean | Нет | false | Поле, отвечающие за необходимость перезвона на статус true – нужно перезванивать |
tries | Int | Нет | null | Количество попыток дозвона на статус |
interval | Int | Нет | null | Длительность паузы между попытками перезвона в секундах |
MACHINE | machineInfo { | Нет | Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от модуля определения автоответчиков, при условии его работы, статус «Атоответчик» | |
enabled | boolean | Нет | false | Поле, отвечающие за необходимость перезвона на статус true – нужно перезванивать |
tries | Int | Нет | null | Количество попыток дозвона на статус |
interval | Int | Нет | null | Длительность паузы между попытками перезвона в секундах |
CONGESTION | congestionInfo { | Нет | | Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Ошибка дозвона» |
enabled | boolean | Нет | false | Поле, отвечающие за необходимость перезвона на статус true – нужно перезванивать |
tries | Int | Нет | null | Количество попыток дозвона на статус |
interval | Int | Нет | null | Длительность паузы между попытками перезвона в секундах |
NOT_SUCCESSFUL | not_SuccessFulInfo { | Нет | Настройки стратегии перезвонов на номера, у которых время диалога бота было ниже или равным указанного в настройках данной опции | |
enabled | boolean | Нет | false | Поле, отвечающие за необходимость перезвона на статус true – нужно перезванивать |
tries | Int | Нет | null | Количество попыток дозвона на статус |
interval | Int | Нет | null | Длительность паузы между попытками перезвона в секундах |
duration | Int | Нет | null | Длительность, ниже или равной которой диалог считается не результативным и потребует перезвона на данный номер клиента |
...