Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Блок кода
languagepy
themeDJango
firstline1
titleТело запроса в формате Json
linenumberstrue
collapsetrue
{

    "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": "79133912047",

        "additional": null

    },

   

    "defaultRedirect": {

        "type": "hangup",

        "data": null,

        "additional": null

    },




    "scheduledAt": null,

    "intensity": 1,




    "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

        }

    }

}


Описаниеполейметода:

Поле

Тип

Обязательно

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

Описание

name

string

Да


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

botId

string

Да


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

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


dialplanId


string


Да


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

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

backgroundNoise

string

Да


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

/background/office.wav – шум офиса

Null - если фоновый шум не нужен.

amd

amdInfo {
}

Да


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

enabled

boolean

Да


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

mode

string

Да


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

back – модуль определения автоответчиков работает параллельно с работой бота, в синхронном режиме
blok – модуль определения автоответчиков блокирует работу бота и не дает общаться по сценарию, пока не примет однозначного решения, что на той стороне есть человек.

file

string

Да


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

Для режима BACK укажите null

defaultCallerId

defaultCallerIdInfo{

}

Да


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


type


Да


Тип АОНа

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

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

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


data


Да


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

Custom – указываем номер телефона, который хотим использовать в качестве АОНа, в формате 7хххххххххх

groupAON – указываем ID группы АОНов, настроенную в личном кабинете

Для Default - null

additional


Да


Доп ифнормация.

Всегда null

defaultRedirect

defaultRedirectInfo{

}



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

type

string

Да


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

Hangup – завершить диалог

Dialplan – план набора

Transfer – направление перевода

Custom – произвольный перевод

Twin – другой сценарий

data

string

Да


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

Dialplan – план набора

Transfer – направление перевода

Custom – произвольный перевод

Twin – другой сценарий


Для Hangup - null

additional

string

Да


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

Dialplan – план набора

Custom – произвольный перевод


Для остальных - null

scheduledAt

Date

Да


Режим запуска задания.

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

Если задание будет запущено сразу при загрузке реестра номеров, укажите null


intensity

Int

Да


Интенсивность обзвона. Указывает для системы обзвона, сколько нужно совершать одновременных наборов номеров в секунду. При значении 1, например, система будет набирать один номер, каждую секунду. 60 вызовов за минуту и 3 600 номеров за час работы задания.

Задается целым числом в диапазоне от 1 до 5.

allowedTimeRange

allowedTimeRangeInfo{
}

Да


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

from

Int

Да


Самое ранее время, в которое можно позвонить клиенту.

Указывается в секундах, с отсчетом от 00:00

to

Int

Да


Самое позднее время, в которое можно позвонить клиенту.

Указывается в секундах, с отсчетом от 00:00

phoneNormalization

string

Нет


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


ru – номера будут приводиться в формат номера для звона по России

null – переданные номера будут передаваться в работу в том виде, в котором их передали

detectGenderByVoice

boolean

Да


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

isTest

boolean

Да


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

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

recallRules

recallRulesInfo {
}

Да


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

BUSY

busyInfo {
}

Да


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

enabled

boolean

Да


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

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

tries

Int

Да


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

interval

Int

Да


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

NO_ANSWER

no_answerInfo {
}

Да


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

enabled

boolean

Да


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

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

tries

Int

Да


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

interval

Int

Да


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

MACHINE

machineInfo {
}

Да


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

enabled

boolean

Да


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

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

tries

Int

Да


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

interval

Int

Да


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

CONGESTION

congestionInfo {
}

Да


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

enabled

boolean

Да


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

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

tries

Int

Да


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

interval

Int

Да


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

NOT_SUCCESSFUL

not_SuccessFulInfo {
}

Да


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

enabled

boolean

Да


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

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

tries

Int

Да


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

interval

Int

Да


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

duration

Int

Да


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

...