История страницы

Поле

Тип

Обязательно

Значение по умолчанию

Описание

name

string

Да

Имя задания. Задается в любом формате, который поможет отличить одно задание от другого и понять, кому звонили, и когда был обзвон.

botId

string

Да

Идентификатор сценария, по которому бот должен вести диалог с клиентом , в рамках данного задания на обзвон.

Для каждого аккаунта уникален, и указан у каждого сценария бота в личном кабинете.

dialplanId

string

Да

Идентификатор плана набора подключенной к аккаунту телефонии.

Для Уникален для каждого аккаунта уникален, и указан . Указан в настройках телефонии в личном кабинете.

backgroundNoise

string

Нет

null

Настройка фонового шума , для создания ощущения естественности, который . Фоновый шум воспроизводится системой , во время работы бота. Название файлов можно взять в личном кабинете.Названия файлов отображаются в списке значений параметра Фоновый шум в окне Добавление нового задания на обзвон в кабинете администратора.

Например: /background/office.wav – шум офиса.

Null - если фоновый шум не нужениспользуется.

amd

amdInfo {
}

Перечень настроек модуля определения автоответчиков.

enabled

boolean

Нет

0

Поле, отвечающее за включение/отключение работы модуля определения автоответчиков у всего задания.

• true – модуль определения автоответчиков включен и работает
• false – модуль определения автоответчиков отключен и не работает

mode

string

Нет

null

Режим работы модуля определения автоответчиков. Существует два режима работы:

• back – модуль определения автоответчиков работает параллельно с работой бота

• в синхронном режиме
  

• block – модуль определения автоответчиков блокирует работу бота и не дает

• начать диалог, пока не примет однозначного решения, что

• боту отвечает человек

file

string

Нет

Даnull

Указывается Содержит путь к аудиофайлу приветствия , при режиме для режима работы модуля определения автоответчиков BLOCK.

Для режима BACK укажите используйте значение null.

defaultCallerId

defaultCallerIdInfo{

}

Нет

Настройка параметров номера телефона (АОН), который увидит отображается на своем телефоне клиент, получив звонок телефоне клиента во время звонка от бота.

type

Нет

default

Тип АОНаАОН:

• Default – использовать номер телефона, указанный в настройках канала связи
• Custom – использовать номер телефона, указанный в поле data

• groupAON – использовать настроенную в личном кабинете группу

• АОН

data

Нет

null

Первичный параметр настройки для типов типов:

• Custom –

• определяет номер телефона, который

• используется в качестве

• АОН, в формате 7хххххххххх
• groupAON –

• определяет ID группы

• АОН,

• настроенной в

• кабинете администратора
  

Для Default - null

additional

Нет

null

Дополнительная информацияДоп ифнормация.

Всегда null.

defaultRedirect

defaultRedirectInfo{

}

Нет

Настройка параметров переадресации звонка по умолчанию. Будет использоваться Используется, если сценарий требует перевода, и в самом сценарии указано использование параметров заданы параметры переадресации из настроек задания.

type

string

Нет

hangup

Тип переадресации по умолчанию:

• Hangup – завершить диалог
• Dialplan – план набора
• Transfer – направление перевода
• Custom – произвольный перевод
• Twin – другой сценарий

data

string

Нет

Первичный параметр настройки для типов типов:

• Dialplan – план набора
• Transfer – направление перевода
• Custom – произвольный перевод
• Twin – другой сценарий

Для Hangup - null.

additional

string

Нет

null

Вторичный параметр настройки для типов типов:

• Dialplan – план набора
• Custom – произвольный перевод

Для остальных - 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

Нет

Модификатор номеров телефона, для приведения загруженных в задание , номеров телефонов к формату, который нужен требуется для системы обзвона.:

• ru – номера

• приводятся к российскому формату
  
• null –

• номера

• передаются в неизменном виде
  

detectGenderByVoice

boolean

Нет

false

Поле, отвечающее за включение/отключение работы модуля определения половой принадлежности клиента по его голосу.:

• true – модуль определения гендера включен и работает
• false – модуль определения гендера отключен и не работает

isTest

boolean

false

Признак для отключения у задания механизмов ограничений ФЗ-230 и отключение любых сдерживающих механизмов платформы.:

• true – задание считается тестовым, и для него отключаются механизмы соблюдения ФЗ и прочее.
• false – для задания работают ограничения и механизмы безопасности

recallRules

recallRulesInfo {
}

Перечень настроек стратегии перезвонов. Перезвон на каждый статус попытки дозвона настраивается отдельно.

BUSY

busyInfo {
}

Нет

Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Занято».

enabled

boolean

Нет

false

Поле, отвечающие отвечающее за необходимость перезвона на статус:

• true – нужно перезванивать
• false –

• не нужно перезванивать
  

tries

Int

Нет

null

Количество попыток дозвона на статус.

interval

Int

Нет

null

Длительность паузы между попытками перезвона в секундах.

NO_ANSWER

no_answerInfo {
}

Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Нет ответа».

enabled

boolean

Нет

false

Поле, отвечающие отвечающее за необходимость перезвона на статус:

• true – нужно перезванивать
• false –

• не нужно перезванивать
  

tries

Int

Нет

null

Количество попыток дозвона на статус.

interval

Int

Нет

null

Длительность паузы в секундах между попытками перезвона в секундах.

MACHINE

machineInfo {
}

Нет

Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от модуля определения автоответчиков , (при условии его работы, ) статус «Атоответчик».

enabled

boolean

Нет

false

Поле, отвечающие отвечающее за необходимость перезвона на статус:

• true – нужно перезванивать
• false –

• не нужно перезванивать
  

tries

Int

Нет

null

Количество попыток дозвона на статус.

interval

Int

Нет

null

Длительность паузы в секундах между попытками перезвона в секундах.

CONGESTION

congestionInfo {
}

Нет

Настройки стратегии перезвонов на номера, которые при попытке дозвона получили от оператора связи статус «Ошибка дозвона».

enabled

boolean

Нет

false

Поле, отвечающие отвечающее за необходимость перезвона на статус:

• true – нужно перезванивать
• false –

• не нужно перезванивать
  

tries

Int

Нет

null

Количество попыток дозвона на статус.

interval

Int

Нет

Длительность паузы между попытками перезвона в секундах.

NOT_SUCCESSFUL

not_SuccessFulInfo {
}

Нет

Настройки стратегии перезвонов на номера, у для которых время диалога бота было ниже меньше или равным указанного равно указанному в настройках данной опцииэтого параметра

enabled

boolean

Нет

false

Поле, отвечающие отвечающее за необходимость перезвона на статус:

• true – нужно перезванивать
• false –

• не нужно перезванивать
  

tries

Int

null

Количество попыток дозвона на статус.

interval

Int

Нет

null

Длительность паузы в секундах между попытками перезвона в секундах.

duration

Int

Нет

Длительность звонка, ниже или равной при которой диалог считается не результативным нерезультативным и потребует требует перезвона на данный номер клиента.