 Введите IP-адрес телефона в адресную строку бразуера для подключения к веб-интерфейсу.  В открывшемся окне введите логин – **admin**, пароль – **admin** и нажмите на кнопку **Авторизация**.  Перейдите на вкладку **Аккаунт**.  В открывшемся окне задайте следующие параметры:  **Активная линия –** Выбрано\ **Лейбл** - Axatel **Отображаемое имя –** имя которое будет высвечиваться у вас на экране **Имя регистрации** – имя учетной записи **ID пользователя** – такой же как и имя регистрации **Пароль** – пароль учетной записи **Адрес Sip-сервера** – название\_проекта\_номер сервера.axatel.by **Транспорт** – UDP **Таймаут сервера** – 60 **Количество запросов** – 3 **Outbound Proxy Server 1** – номер\_сервера.axatel.by Нажмите на кнопку **Сохранить** для сохранения настроек. Если данные введены верно, то в поле **Статус регистрации**, вы увидите статус **Зарегистрировано**.  Перейдите на вкладку **Кодеки.**\ В качестве используемых кодеков установите PCMA и PCMU т.к. они обеспечивают наилучшее качество звука.  В целях безопасности рекомендуется сменить стандартный пароль для доступа в Web-интерфейс.\ Для этого перейдите на вкладку **Безопасность** и задайте новый пароль.  # Настройка клиента Zoiper **Zoiper** — это бесплатная программа для осуществления звонков в сети интернет в любых направлениях. Единственное что требуется для обеспечения качественной работы данного сервиса — это наличие высокоскоростного подключения к интернету. Осуществляет поддержку протоколов SIP, IAX и XMPP. {% content-ref url="/pages/-MMzdY3Y90DzGU\_JA3Ls" %} [IOS](/softphone/mobilnoe-prilozhenie/zoiper-ios) {% endcontent-ref %} {% content-ref url="/pages/-MMzdVrHs22bW8DFtp1z" %} [Anroid](/softphone/mobilnoe-prilozhenie/zoiper-anroid) {% endcontent-ref %} {% content-ref url="/pages/-MN24WiPKs8azTuBpdvC" %} [Mac OS](/softphone/mobilnoe-prilozhenie/zoiper-mac-os) {% endcontent-ref %} {% content-ref url="/pages/-MNUtXDm-PupENT2xs29" %} [Windows](/softphone/mobilnoe-prilozhenie/windows) {% endcontent-ref %} # IOS Установите из App Store приложение Zoiper Lite voip soft phone.  Откройте приложение Zoiper на мобильном телефоне и перейдите в **Настройки**.  Далее нажмите на **Учетные записи**.  Нажмите на
Нажмите на кнопку **Login**.  На следующем шаге просто нажмите на кнопку **Next**.  Нажмите на кнопку **Skip** для перехода к следующему шагу.  Не дожидаясь окончания тестирования, выберите **SIP UDP** и нажмите на кнопку **Skip**.  Подтвердите выбранные действия нажав на кнопку **Yes**.  Задайте название для созданного аккаунта и выберите протокол SIP.\ В нашем примере, мы назвали подключение Demo Axatel.
 Для выхода из мастера настроек, нажмите на кнопку **Finish**.  Если все данные введены верно, то вы увидите зеленую галку рядом с названием вашей учетной записи.
 # Windows Перейдите по следующей ссылке и скачайте клиент Zoiper:\
Нажмите на кнопку **Login**.  На следующем шаге просто нажмите на кнопку **Next**.  Нажмите на кнопку **Skip** для перехода к следующему шагу.  Не дожидаясь окончания тестирования, выберите **SIP UDP** и нажмите на кнопку **Skip**.  Подтвердите выбранные действия нажав на кнопку **Yes**.  Задайте название для созданного аккаунта и выберите протокол SIP.\ В нашем примере, мы назвали подключение Demo Axatel.
 Если требуется проверить микрофон, наушники или камеру, нажмите на кнопку **Configure**.  Если все данные введены верно, то вы увидите зеленую галку рядом с названием вашей учетной записи.  # Установка и настройка софтофон Microsip Система Softfon - программный телефон, который устанавливается на рабочее место, к нему подключается гарнитура. С помощью программного телефона пользователь может работать со входящими и исходящими звонками.\ По умолчанию мы рекомендуем использовать бесплатное приложение **MicroSIP**. ## **Установка приложения** 1. Загрузите приложение с официального сайта.\
 4\. При первом запуске потребуется разрешить использование всех функций приложения MicroSIP в Windows Firewall.  ## **Настройка** В главном окне программы, нажмите на кнопку  и в контекстном меню выберите **Настройки**.  В открывшемся окне задайте следующие параметры:  1\. **Режим одиночного вызова -** для работы с переадресацией функцию нужно отключить. 2\. **Звук вызова** - по умолчанию 3\. **Устройства для вызова**, **Динамики**, **Микрофон** - выберите USB-гарнитру 4\. **Усиление микроф**она – активировать если Вас плохо слышит собеседник 5\. **Программная регулировка уровня** – позволяет системе регулировать уровень звука автоматически. 6\. **Доступные кодеки** – список доступных кодеков. Рекомендуемые «G.711 А-law и G.711 u-law 7\. **VAD** – определяет активность голоса 8\. **EC** – регулирует уровень эхо 9\. **Задавать кодек для входящих** – позволяет управлять кодеками для входящих звонков 10\. **Камера**, **Видеозвонок**, **Н.264**, **Н.263**, **VPS**, **Битрейт видео**, **Исходящий порт**, **rport**, **Порты RTP**, **Сервер имен**, **DNS SRV**, **STLN-сервер** – не используются. 11\. **Метод DTMF** - авто 12\. **Авто-ответ** – включить если требуется 13\. **Запретить входящие** - включить если требуется 14\. **Каталог пользователей** - загрузка телефонного справочника 15\. **Действие списка** - выбрать «Вызов» 16\. **Управление мультимедийными кнопками**, **Случайная позиция**, **Включить локальный аккаунт** – отключить. 17\. **Звуковые события**, **Всплывать при необходимости**, **Ожидание вызова**, **Включить лог-файл**, **Отправлять отчет с падений** – включить. Нажмите на кнопку **Сохранить** для сохранения настроек. ## **Добавление аккаунта.** В главном окне программы, нажмите на кнопку  и в контекстном меню выберите **Добавить аккаунт**.  В открывшемся окне задайте следующие параметры:  **Название** - Axatel **SIP-сервер** – указать домен пользователя: **название проекта\_номер сервера\_Axatel** **SIP-прокси** – номер сервера\_Axatel **Имя пользователя** – такой же как и **Логин**. **Домен** – указать домен пользователя: название проекта\_номер сервера\_Axatel **Логин** – логин пользователя **Пароль** – пароль пользователя **Ваше имя**- введите имя **Голосовая почта** – указать эл.почта **Префикс набора** – пусто **Dial Plan** – пусто **Шифрование медиа** – отключить **Транспорт** – UDP **Публичный адрес** – авто **Обновление регистрации** - 60 **Keep-Alive** - 3 сек. **Публиковать присутствие** – включите данную функцию если хотите, чтобы ваши контакты могли видеть ваш текущий статус (свободен, занят, выключен). Нажмите на кнопку **Сохранить** для сохранения настроек. Если все настройки введены верно, то в левом нижнем углу появится зеленая иконка   ## **Добавление контактов** **MicroSIP** позволяет создавать свой список контактов.\ Для добавления контакта в верхней панели выберите **Контакты**  В окне **Контакты**, нажмите правую кнопку мышки – «Добавить».  В открывшемся окне задайте **Имя** и **Номер** чтобы можно было отслеживать по ним информацию на сервере.
 Включите **Подписка на присутствие** если хотите видеть статус контакта. Доступные статусы: Свободен и доступен для звонка.  Абонент разговаривает  Абонент не в сети и не доступен  ## **Основные функции программы**   – не беспокоить  – автоматическое поднятие трубки – конференция  - запись разговора  **-** Включить/выключить звук  **-** Включить/выключить микрофон  – повторный вызов  – функция сброса  – кнопка вызова ## **Работа с программой** **Прием вызова** При входящем вызове отобразится диалоговое окно **Входящий вызов**.  Для принятия вызова кнопку **Ответить**. Чтобы отклонить вызов, нажмите на кнопку **Отклонить** или на крестик в верхнем правом углу, тогда звонок будет проигнорирован. **Совершение вызова** Для совершения вызова наберите номер телефона абонента и нажмите на кнопку **Вызов**. 
Если вы хотите позвонить внутреннему абоненту компании, достаточно набрать трехзначный номер сотрудника. Если внешний номер, то сначала нужно набрать код 375 или 80, затем номер телефона начиная с кода города.\ Например:\ 375 17 237-98-90\ 80 17 237-98-90
После того как Вы нажмете на кнопку вызов, программа откроет диалоговое окно, в котором будет отображаться ход выполнения вызова до завершения звонка.  Для завершения звонка нажмите на кнопку **Завершить**.  **Перевод звонка без сопровождения** Перевод звонка без сопровождения — это так называемый "Слепой перевод". Клиент А сразу переводится на сотрудника С без помещения в режим ожидания. Во время разговора нажмите на кнопку **Перенаправить** и в контекстном меню выберите **Перевод звонка**.
 В открывшемся окне введите номер абонента, на которого нужно перевести звонок и нажмите кнопку **ОК**.  После успешного соединения ваша линия будет освобождена, а первый абонент будет соединен с абонентом, на которого его переключили.  Если абонент, на которого переводится звонок занят, то звонок вернется к вам обратно. Если после переключения вы положили трубку, то не зависимо произойдет ли коммутация между абонентами, звонок к вам не вернется. **Перевод звонка с сопровождением** Перевод звонка с сопровождением — это переключение с предварительным соединением.\ Во время разговора нажмите на кнопку  (hold). В этом режиме абонент слышит мелодию ожидания, а Вы можете совершить вызов другому абоненту.  После успешного соединения со вторым абонентом, Вы можете: Нажмите на кнопку **Перенаправление**, далее выберите в контекстном меню **Перевод звонка с сопровождением** и абонента на которого нужно переключить.  Вы можете переключаться между абонентами в окне вызова не соединяя их между собой (один всегда будет на удержании).  **Конференция** Чтобы организовать конференцию во время разговора нажмите кнопку Конференция > Пригласить в конференцию.  В открывшемся окне укажите номер абонента, которого вы хотите пригласить и нажмите на кнопку ОК.  В уже имеющуюся конференцию можно пригласить новых участников, разделить звонивших или разъединить вызов.  # Защита оборудования и рабочего места В данной статье мы расскажем о базовых мерах защиты сетевого оборудования для работы с SIP. Почему нужно соблюдать меры безопасности при работе с сетевым оборудованием и SIP-телефонией? Получив доступ к вашему оборудованию или одному из сегментов сети, злоумышленники могут нанести различный вред вашему бизнесу: * Прослушивание разговоров * DDoS-атаки направленные на временное прекращение работоспособности системы * Перепродажа трафика использую подменные шлюзы для увеличения стоимости разговоров. Мы рекомендуем следующие меры для снижения риска атаки: 1. Обязательное использование стойких паролей.\ Пароль должен содержать не менее восьми символов состоящий букв различного регистра, цифр и других символов.
2. Необходимо в обязательном порядке использовать сетевой экран (Firewall) на пограничном маршрутизаторе.\ Выделить отдельный сегмент сети для устройств IP-телефонии, строго разграничить политиками Firewall доступ к/из сегмента телефонии от общей корпоративной сети организации.
3. Заменить стандартный sip-порт (5060) на любой случайный.\ При ответе на любой SIP-запрос IP-телефон в большинстве случае подставляет название своей микропрограммы в поле Contact. Злоумышленник может воспользоваться одной из уязвимостей микропрограммы оборудования для взлома устройства.
4. Разрешить внешние соединения только с серверов «Аксата»
5. Предоставлять доступ к IP-АТС только с определенных рабочих мест/адресов.
6. Ограничить возможность совершения международных звонков в страны, заведомо не востребованные в рабочей практике клиента (например, разрешить звонки за пределы Республики Беларусь только на номера польских и российских операторов), либо разрешать вызов абонентов зарубежных сетей только после прохождения дополнительной авторизации: набора четырехзначного пин-кода.
7. Не реже одного раза в неделю проверять логи вызовов CDR для определения возможно нелегитимных вызовов.
8. При задействовании на рабочих местах сотрудников софтфонов – использовать лицензионное программное обеспечение и следить за актуальностью антивирусных баз. Обратите внимание, вопрос обеспечения клиентом должного уровня безопасности функционирования задействованного им оборудования и реализованного на его базе технического решения (в том числе – с использованием периферийных устройств) находится вне зоны ответственности Частного предприятия «Аксата». # Операторская защита Международные платные звонки – это один из наиболее популярных способов зарабатывания злоумышленниками денег.\ За рубежом или в Белоруссии регистрируется номер телефона, звонок на который является платным. Путем подбора различных вариантов набора номера атакующие совершают звонки на свой платный номер, счет за разговор будет выставлен вам оператором за услуги связи в конце месяца.\ Поэтому если вы не используете международные звонки и другие любые платные направления связи, мы рекомендуем запретить их на уровне оператора связи. Узнайте у вашего оператора связи, как он может поспособствовать защите от звонков на международные направления. Напишите заявление на фирменном бланке компании в свободной или по форме требуемой оператором для запрета всех международных вызовов и вызовов на платные номера. Данные действия уберегут вас от дополнительных расходов и сделают вашу систему менее интересной для злоумышленников. Пример заявления Вы можете посмотреть в прикрепленном файле ниже. {% file src="/files/-MHtfkbNzwBNZPF1n2ya" %} Пример заявления {% endfile %} # Подготовка аудио файла для Axatel В данной статье мы расскажем какие аудио файлы поддерживаются системой Axatel.\ Как создать свое голосовое приветствие с помощью Yandex speechKit.\ Как переконвертировать файл с помощью онлайн конверторов.\
## Поддерживаемые типы файлов Система Axatel поддерживает загрузку следующих звуковых файлов: * WAV файлы в кодировках: PCM Стерео, Моно, 16 бит, 8000, 11025 16000, 22050, 24000, 32000, 44100, 48000 Гц\ G.711 alaw, mulaw, 8000 Гц\ MS GSM, 65 бит, 8000 Гц * MP3 файлы любой bitrate * Другие форматы звуковых файлов не поддерживаются. ## Создание голосового приветствия 1. Перейдите по следующей ссылке:\
2. В открывшемся окне пролистайте страницу в низ до раздела **Попробуйте Yandex SpeechKit API**
3. Введите нужный текст, выберите звукового помощника и другие параметры.
 4\. После прослушивания файла, нажмите на кнопку скачивания.  5\. На компьютер будет загружен файл с названием tts.ogg.\ Поскольку формат \*.ogg не поддерживается, нам нужно будет произвести конвертацию аудиофайла. ## Конвертация аудио файла 1. Перейдите по следующей ссылке:\
2. В открывшемся окне нажмите на кнопку Открыть файл и выберите файл **tts.ogg**
 3\. Выберите требуемое качество для mp3 файла или Wav и нажмите на кнопку **Конвертировать**. {% hint style="info" %} Мы рекомендуем оставить стандартное качество для mp3 - 128 kbs\ Для Wav установить 8000 Khz и Каналы - 1 {% endhint %}   4\. Дождитесь завершения процесса конвертации, после чего вы сможете скачать файл.  # API # API управление файлами домена Содержит информация по работе с файлами коммуникационного домена через Публичный канал интеграции. ## Публичный канал интеграции Настраивается в Web-интерфейсе администрирования. Тип канала - **Публичный**.\ Признак "Разрешить работу с файлами через этот публичный канал" должен быть включен.  ## API управления \ \ Внешние системы должны обращаться на адрес http(s)://fqdn\_ws\_role/api/token/v1/{token}/files/{command} * **fqdn\_ws\_role** - адрес URL роли WS (Веб-сервера управления) * **{token}** - значение локального токена из созданного публичного канала * **{command}** - команда управления (описаны ниже) ## Команды управления ### Загрузка файлов в домен #### upload  http(s)://fqdn\_ws\_role/api/token/v1/{token}/files/upload\ Метод - POST\ Content-Type - multipart/form-data\ Body - Form\ \[File] = выберите файл\ \ В ответе json приходит результат загрузки файла. \ \ Успешный ответ содержит "resultcode": 0, "resultmsg": "OK". \ \ Пример успешного ответа: ``` { "resultcode": 0, "resultmsg": "OK", "data":{ "upload":[ { "name": "205-a10-02.zip", "res": "ok" } ] } } ``` Неуспешный ответ содержит код ошибки и ее описание. Пример неуспешного ответа: ``` { "resultcode": 1501, "resultmsg": "Not enough free disk space" } ``` ### Скачивание файла в браузере. #### download  http(s)://fqdn\_ws\_role/api/token/v1/{token}/files/download?file={filename} Метод - GET\ {filename} - имя файла для скачивания ### Получение списка файлов. #### list  http(s)://fqdn\_ws\_role/api/token/v1/{token}/files/list Метод - GET В ответе json с полным списком файлов следующего вида ``` { "resultcode": 0, "resultmsg": "OK", "data": { "files": [ { "file": { "name": "205-a10-02.zip" } }, { "file": { "name": "queue_wait_sgk.mp3" } } ] } } ``` ### Удаление файла. #### delete  http(s)://fqdn\_ws\_role/api/token/v1/{token}/files/delete?file={filename}
Метод - GET\ {filename} - имя файла для удаления Хранение файла и получение доступа из сценариев Файл хранится в директории **fsync** домена в поддиректории **/data/tokens/**. Пример ...**/syncfolder/domains/domain.demo.axatell/data/tokens/205-a10-02.zip**\ Для получения доступа к файлу в IVR/SVC сценарии можно через формирования пути к файлу следующего вида: путь = syn\_domain()\ файл = tokens/205-a10-02.zip Пример получения файла в Выражениях Сценария: makepath(syn\_domain(),"tokens/002.mp3") * 002.mp3- имя файла * tokens - константа имени каталога # FAX API Обработка факса сервисом Аксател  ## API управления \ \ Внешние системы должны обращаться на адрес http(s)://fqdn\_ws\_role/api/token/v1/{token}/files/{command} * **fqdn\_ws\_role** - адрес URL роли WS (Веб-сервера управления) * **{token}** - значение локального токена из созданного публичного канала * **{command}** - команда управления (описаны ниже) ## Команды управления ### Загрузка файлов в домен #### upload  http(s)://fqdn\_ws\_role/api/token/v1/{token}/files/upload\ **Метод** - POST\ **Content-Type** - multipart/form-data\ **Body** - Form \ \ В ответе json приходит результат загрузки файла. \ \ Успешный ответ содержит "resultcode": 0, "resultmsg": "OK". \ \ Пример успешного ответа: ``` { "resultcode": 0, "resultmsg": "OK", "data":{ "upload":[ { "name": "002.mp3", "res": "ok" } ] } } ``` Неуспешный ответ содержит код ошибки и ее описание. Пример неуспешного ответа: ``` { "resultcode": 1501, "resultmsg": "Not enough free disk space" } ``` ### Получение списка файлов. #### list  http(s)://fqdn\_ws\_role/api/token/v1/{token}/files/list Метод - GET В ответе json с полным списком файлов следующего вида ``` { "resultcode": 0, "resultmsg": "OK", "data": { "files": [ { "file": { "name": "205-a10-02.zip" } }, { "file": { "name": "queue_wait_sgk.mp3" } } ] } } ``` ### Скачивание файла в браузере. #### download  http(s)://fqdn\_ws\_role/api/token/v1/{token}/files/download?file={filename} Метод - GET\ {filename} - имя файла для скачивания Пример успешного ответа:  {% hint style="info" %} Скачанный файл будет иметь название **download** и не будет иметь расширения.\ Чтобы открыть этот файл нужно будет изменить его расширение на указанное в запросе. {% endhint %} ### Удаление файла. #### delete  http(s)://fqdn\_ws\_role/api/token/v1/{token}/files/delete?file={filename}
Метод - GET\ {filename} - имя файла для удаления Хранение файла и получение доступа из сценариев Файл хранится в директории **fsync** домена в поддиректории **/data/tokens/**. Пример ...**/syncfolder/domains/domain.demo.axatell/data/tokens/205-a10-02.zip**\ Для получения доступа к файлу в IVR/SVC сценарии можно через формирования пути к файлу следующего вида: путь = syn\_domain()\ файл = tokens/205-a10-02.zip Пример получения файла в Выражениях Сценария: makepath(syn\_domain(),"tokens/002.mp3") * 002.mp3- имя файла * tokens - константа имени каталога Результат успешного выполнения: ``` { "resultcode": 0, "resultmsg": "OK" } ``` ### Отправка факса #### sendfax  http(s)://fqdn\_ws\_role/api/token/v1/{token}\ \ Метод - POST\ Content-Type - application/json * **action** - действие, которое нужно совершить над списком факсов (sendfax — отправить) * **recipient** - получатель факса * voiceDocumentSID- <необязательный параметр> — идентификатор предварительно загруженного голосового файла * **terminalId** - идентификатор телефонного номера, который будет назначен в качестве номера-отправителя * **attachment** - идентификатор предварительно загруженного файла в формате TIF * **sip** - ответ провайдера описан в соответствии с стандартом {% content-ref url="/pages/-MIpci293tLiPPzTIj\_\_" %} [SIP ответы и их значения](/sip-otvety-i-ikh-znacheniya) {% endcontent-ref %} * **status** - статус отправки факса * **error** - содержит описание ошибок при отправке факса: "файл не найден", "номер не соответствует маске" Пример: ``` { "action":"sendfax", "recipient": 375291554499, "voiceDocumentSID":"002.mp3" "terminalId": 301 "attachment":"123123.tif" } ``` Пример успешной отправки: ``` "sip_code": "200", "success": "true", "error": "null", "status": "sent" } ``` Допускается отправка сообщения через pop протокол.\ Для реализации требуется передавать сообщение с темой письма содержащий номер телефона и 1 приложением файла в формате TIF.\ На сервере предварительно настраивается маска с именем отправителя с которым разрешена отправка сообщения **user{mask}@fqdn**\ После отправки приходить ответное сообщение с статусом отправки на обратный e-mail адрес. ### Инициализация базы данных #### init\_fax  {% hint style="info" %} Требуется выполнить для первично инициализации {% endhint %} http(s)://fqdn\_ws\_role/api/token/v1/{token}\ **Метод** - POST\ **Content-Type** - application/json\ **Body** - Text * **action** - константа * **domain** - имя текущего домена * **drop** - true = удалить если ранее было созданы схемы и таблицы, false = не удалять ничего Пример: ``` { "action":"init_fax", "domain":"domain.a1.axatel.by", "drop":"true" } ``` Ответ успешного выполнения: ``` { "received": true } ``` ### Запрос информации по факсам #### fax\_history  http(s)://fqdn\_ws\_role/api/token/v1/{token}\ \ Метод - **POST**\ Content-Type - **application/json** **Body:** * **action** - константа * "**type-** тип incoming | outgoing * **from\_dt**:"2020-12-16 20:00", //время UTC начала списка. Может быть дата или дата-время * **till\_dt**- время UTC окончания списка. Может быть дата или дата-время * **fields**- *список полей, которые выводить, можно указывать через запятую.* * **\*** - вывести все поля * id * type * remotenum * start\_dt * stop\_dt * result * url Пример запроса: ``` { "action":"history", "type":"outgoing", "from_dt":"2020-12-16 20:00", "till_dt":"2020-12-20 23:30", "fields":"*" } ``` Пример успешного вывода: ``` { "data":[ { "id": "940fbbf2-0176-81d6-990b-005056011d6c", "type": "outgoing", "remotenum": "3880456", "start_dt": "2020-12-20T20:28:13.84", "stop_dt": "2020-12-20T20:28:30.38", "result": "success", "url": "https://domain.a1.axatel.by/callrecords/domains/demo.a1.axatel.by/data/fax/outgoing/mtu1otezoty1nw53d5.tiff" }, ] } ``` ### Описание поля Result **success** - успешная обработка\ **failed** - ошибка \ **receiving** - в процессе приемки \ **dialing** - набор номера \ **sending** - процесс отправки # voicebot  [http://demo.a1.axatel.by/api/token/v1/b3eb7f02cd2afb37882045c6dbdbd128
](
### **Выбор вектора** {% hint style="info" %} Файл route\_data\_table .csv с заранее созданными векторами для совершения различных вариантов исходящих и входящих звонков, вы можете скачать по ссылке ниже.\ В данном разделе мы лишь опишем принцип создания вектора. {% endhint %} {% file src="/files/-MG0H2NslNMwZ8TndIhm" %} Нажмите на кнопку **Новый объект** для создания вектора.\ В новом окне нужно прописать Маску номера назначения.\ В нашем примере мы разрешаем все исходящие звонки на белорусские номера.  Таким же образом нужно создать правило для входящих звонков.\ В нашем примере мы разрешаем любые входящие с внешней линии.  ### **Выбор правила** {% hint style="info" %} Файл vectorrule\_data\_table .csv с заранее созданными правилами для совершения различных вариантов исходящих и входящих звонков, вы можете скачать по ссылке ниже.\ В данном разделе мы лишь опишем принцип создания правила. {% endhint %} {% file src="/files/-MGIPHJhWNFoaUf1dp3n" %} Создайте новое правило для исходящих звонков.\ Выберите нужный вектор и укажите Оператор SIP для исходящих звонков.  Таким же образом нужно создать правило для входящих звонков.\ Выберите нужный вектор.\ В поле Действие укажите Код абонентских функций, для того чтобы входящие звонки поступали на IVR.  ### **Коды абонентских функций** Создайте новый объект.\ В поле Префикс укажите Yeastar.\ Типа сценария - IVR\ Дополнительный параметр - 001IVR.  ### **Нормализация номеров** {% hint style="info" %} Файл provider\_callerid\_data\_table.csv с заранее созданными правилами для совершения различных вариантов исходящих и входящих звонков, вы можете скачать по ссылке ниже.\ В данном разделе мы лишь опишем принцип создания правила нормализации звонка. {% endhint %} {% file src="/files/-MGIPMCG1IEXksbC50k7" %} Откройте раздел Нормализация номеров внешних и создайте новый объект.  В нашем примере правило создано для исходящих на внешнюю линию.\ Основные параметры: Направление источника - Исходящий на внешнюю линию\ Изменение номера источника - Номер телефона предоставляемый Anitex\ Изменение номера назначения - 80/xxx/\* Теперь нужно создать правило для входящих звонков.
 Основные параметры: Направление источника - Направление с внешней линии\ Изменение номера источника - 375/xx/\*\ Изменение номера назначения - Yeastar # Подключение внешних провайдеров # Подключение городских SIP номеров у компании «ANITEX» РБ Напишите заявление на фирменном бланке компании и отправьте его на электронный адрес: (
* Указать, что номера должны быть ранее неиспользуемые
* Используемый внешний статический IP-адрес
* Реквизиты организации
* Тип требуемой связи - городские\мобильные\международные Ответное письмо от компании Анитекс будет содержать следующую информацию и документы: * Список доступных номеров. * Трехсторонний договор (Белтелеком, Анитекс, Заказчик), * Доверенность (для получения паролей к номерам), * Счет. Необходимо распечатать и подписать 3 экземпляра договора. Все три экземпляра выслать: ООО "Анитэкс" по адресу 220004, г. Минск, ул. Кальварийская, 1-424 Для получения регистрационной карты, необходимо заполнить и прислать доверенность. {% hint style="info" %} Доверенность можно прислать по электронной почте. {% endhint %} После подключение номеров нужно написать заявление для отключения возможности совершения международных вызовов своему оператору связи.\ Подробнее об этом вы можете почитать по ссылке ниже: {% content-ref url="/pages/-MBuw533dLAc\_syQv52f" %} [Операторская защита](/bezopasnost-ip-telefonii/operatorskaya-zashita) {% endcontent-ref %} Oфис (абонентский отдел):\ г. Минск, ул. Кальварийская 1-424 (ст. метро "Фрунзенская")\ Тел/факс: +375 17 388 00 05\ E-mail:
**Выбор вектора** Нажмите на кнопку **Новый объект** для создания вектора.\ В новом окне нужно прописать Маску номера назначения.\ В нашем примере мы разрешаем все исходящие звонки на белорусские номера.  Таким же образом нужно создать правило для входящих звонков.\ В нашем примере мы разрешаем любые входящие с внешней линии.  **Выбор правила** Создайте новое правило для исходящих звонков.\ Выберите нужный вектор и укажите Оператор SIP для исходящих звонков.  Таким же образом нужно создать правило для входящих звонков.\ Выберите нужный вектор.\ В поле Действие укажите Код абонентских функций, для того чтобы входящие звонки поступали на IVR.  **Коды абонентских функций** Создайте новый объект.\ В поле Префикс укажите ANITEX.\ Типа сценария - IVR\ Дополнительный параметр - 001IVR.  **Нормализация номеров** Откройте раздел Нормализация номеров внешних и создайте новый объект.  В нашем примере правило создано для исходящих на внешнюю линию.\ Основные параметры: Направление источника - Исходящий на внешнюю линию\ Изменение номера источника - Номер телефона предоставляемый Anitex\ Изменение номера назначения - 80/xxx/\* Теперь нужно создать правило для входящих звонков.
 Основные параметры: Направление источника - Направление с внешней линии\ Изменение номера источника - 375/xx/\*\ Изменение номера назначения - Anitex # Основные термины **IP-телефония** - общее название для технологии телефонной связи через протокол IP (Internet Protocol - дословно "межсетевой протокол"). VoIP-телефония, SIP-телефония – синонимы IP-телефонии. ## **1.** **Используемые и интегрируемые сети** **Сеть IP** - это сеть, построенная на базе протоколов TCP/IP, с помощью которых можно создать как локальные, так и глобальные сети. К таким сетям относятся Интернет, любая локальная компьютерная сеть, локальная сеть с выделенной телефонной сетью. Именно по таким сетям происходит передача данных в IP-телефонии. **OSI (Open Systems Interconnection basic reference model)** – это модель, которая показывает, как связано между собой сетевое оборудование компании: в него входит маршрутизатор, сетевая карта, SIP-телефон и т. д. Оборудование может взаимодействовать на 7 уровнях: физический, канальный, транспортный, сеансовый, сетевой, уровень приложений, уровень представления. **VoIP (Voice over IP - дословно "голос по интернет протоколу")** - более частное название технологии, включает все варианты передачи голоса и видео по сети (в том числе и просмотр фильмов онлайн, видео наблюдение, вебинары и прочее). **PDN, или СПД ОП (сеть общего пользования)** – это любая сеть общего доступа, которую может создать как, например, администрация города, так и крупная частная компания. В эту категорию сетей входит и IP-телефония. **PSTN, или ТфОП** – телефонная сеть общего пользования, которая работает с помощью обычных аналоговых телефонов. Ее легко подключить к IP-сети через VoIP-шлюз. Большинство компаний именно так и подключает IP-телефонию. **ISDN, или ЦСИО** – цифровая сеть. Это многоканальная телефония, которая передает цифровой сигнал через телефонную сеть со скоростью до 64 кбит/с. Объединяет в себе телефон, факс, передачу изображений и видео. У этой сети есть 2 интерфейса – BRI и PRI. В бизнесе чаще всего используют вариант PRI, он же поток Е1. **AVVID (Architecture for Voice, Video and Integrated Data)** – это решение Cisco, архитектурная модель построения сетей IP-телефонии. Она нужна, чтобы создать цифровую телефонию на базе корпоративной IP-сети или чтобы подключить IP-телефонию компании к телефонной сети общего пользования. А также для создания сети видеотелефонии внутри компании. В этой модели построения сети есть 4 уровня: инфраструктура, приложения, клиентский уровень и уровень обработки вызовов. **FMC (Fixed Mobile Convergence)** – технология, которая позволяет сотрудникам звонить по коротким внутренним номерам на мобильные и офисные телефоны внутри сети компании. **CTI (Computer Telephony Integration)** – технология, которая подключает компьютеры и ноутбуки к обычной телефонной сети. ## **2.** **Протоколы и их элементы** **IP (Internet Protocol)** – маршрутизируемый межсетевой протокол, обеспечивающий соединение с помощью коммутации каналов. Именно он объединяет все компьютеры в единую всемирную сеть Интернет. Находится на сетевом уровне модели OSI. Этот протокол осуществляет обмен пакетами данных между различными узлами сети, независимо от количества промежуточных узлов. **UDP (User Datagram Protocol)** – протокол транспортного уровня OSI, базирующийся на IP-протоколе и позволяющий осуществлять передачу данных, не устанавливая при этом соединения. Он не потребляет много трафика, так как не способен обеспечить корректность или подтверждение передачи данных и не может отправить их повторно. **RTP (Real-time Transport Protocol)** – еще один из протоколов транспортного уровня, работающий поверх UDP-протокола. Осуществляет передачу данных в режиме реального времени. С его помощью можно присваивать временные метки каждому исходящему пакету данных, благодаря чему можно контролировать их передачу, принимать их в правильном порядке, а также синхронизировать аудио и видео данные. **SIP (Session Initiation Protocol)** – протокол, обеспечивающий установку связи между абонентами IP-сети для обмена мультимедийными данными. Может работать поверх других транспортных протоколов. Отвечает за процедуру регистрации, установление и завершение пользовательского сеанса связи с соответствующей сигнализацией. **SIP-провайдер** - компания, предоставляющая услуги связи и телефонные номера для IP-телефонии. **SIP-номер** – это телефонный номер в IP-сети, который выдает провайдер IP-телефонии. С него можно звонить и передавать мультимедийные данные. **SIP-адрес** – уникальный адрес абонента внутри IP-сети, который строится по типу SIP\_ID\@domain. Он позволяет зайти в сеть с ноутбука, мобильного или планшета и звонить, принимать звонки через внешние IP-сети на свой номер, данный провайдером. **SIP-порт** – традиционно это порт 5060 TCP или UDP. Он соединяет элементы в SIP-сети, передает и принимает данные. **SIP-сигнализация** – передается по SIP-порту и отвечает за обмен данными. **SIP-сервер** – сервер, связывающий все SIP-оборудование (маршрутизатор, плату, телефоны). В настройках его можно увидеть под значком «SIP-сервер» или Proxy. **H.323** – протокол на уровне модели OSI. Он содержит стандарты для передачи мультимедиа в сетях с пакетной передачей. **MGCP** – протокол, который управляет VoIP-шлюзами. **Megaco/H.248** – протокол, который можно считать новой версией MGCP. Он связывает шлюз и контроллер шлюза в сетях с коммутацией каналов. **SIGTRAN** – группа из семи протоколов для связи традиционной телефонной сети и VoIP. **SCTP (Stream Control Transmission Protocol)** – протокол транспортного уровня. Относится к новым протоколам и гарантированно доставляет данные по IP-сети, а еще дает синхронное соединение между хостами и защиту от DDoS-атак. **SCCP (Skinny Client Control Protocol)** – это закрытый протокол. По сути, он аналогичен протоколу SIP. Отличается лишь закрытостью, потому что используется только в шлюзах и IP-телефонах производителя CISCO. **IAX2** – протокол, который отвечает за обмен данными между корпоративными IP-сетями на Asterisk. **SRTP (Secure Real-time Transport Protocol)** – протокол, который шифрует и защищает передаваемые данные в режиме реального времени. **ZRTP** – протокол, который согласует ключи шифрования по методу Диффи – Хеллмана в VoIP-системах. После завершения соединения ключ уничтожается, и это гарантирует полную секретность данных и позволяет обнаруживать атаки. **TCP (Transmission Control Protocol)** – основной протокол передачи данных в сетях, в том числе и в интернете. Отличается надежностью: устанавливает соединение, повторно запрашивает данные, убирает дубли, гарантирует целостность данных. **ATM** – высокоскоростная технология коммутации и мультиплексирования для асинхронной передачи данных. Нужна там, где передаются данные с отличающимся битрейтом. **NАТ (Network Address Translation)** – преобразователь, который пересылает внутренние IP-адреса во внешние. Нужен для защиты локальной (внутренней) сети с выходом в интернет. Решает проблему нехватки реальных IP-адресов. **Кодек** – программа, которая сжимает видео и аудио для быстрой и легкой передачи их по сети. В VoIP используют кодеки G.711, G.726-32, G.726-16 и др. **VAD (Voice Activity Detector)** – детектор в кодеке, который сжимает звуковой сигнал и определяет промежутки времени, в которые абонент говорит. ## **3.** **Системы и оборудование** **Виртуальная АТС** – комплекс программ, с помощью которого можно реализовать функции АТС и организовать удобную корпоративную офисную связь. Такое программное обеспечение устанавливается на любой компьютер, ноутбук или удаленный сервер, а связь осуществляется через интернет. **IP-PBX (Private Branch eXchange)** – офисная IP-АТС, ориентированная на использование внутри компании и работает на основе IP-протокола. Такие АТС бывают трех типов: аппаратные, программные и виртуальные. IP-PBX может объединять в единую интеллектуальную сеть офисные телефоны, либо сочетать локальную сеть и телефонную сеть общего пользования. **Прокси-сервер** – сервер, который выступает посредником между основным сервером и пользователями. Он позволяет им выполнять непрямые запросы к другим сетевым службам и получать ответы. Такие сервера применяются для обеспечения доступа локальных компьютеров к сети интернет, для кэширования и сжатия данных, для защиты локальной сети, а также для ограничения ее доступа во внешнюю сеть. **IP-телефон, VoIP-телефон, SIP-телефон** – это телефонный аппарат, с помощью которого можно организовать голосовое общение пользователей по IP-сетям. **VoIP-шлюз** – устройство, благодаря которому к сетям IP-телефонии можно подключить офисные мини-АТС и обычные телефонные аппараты. **Маршрутизатор (Router)** – специализированное устройство, которое пересылает пакеты данных между различными сетевыми точками. Как правило, на всем пути передачи пакетов встречается несколько таких точек, где также установлены роутеры. **Коммутатор (свитч)** – устройство, соединяющее несколько сетевых узлов в одном или нескольких сетевых сегментах. **Gatekeeper диспетчер (гейткипер)** – дополнительное устройство, подключаемое исключительно к IP-сети и позволяющее выполнять различные базовые функции сети IP-телефонии: аутентификацию и авторизацию пользователей, распределение вызовов между шлюзами, регистрацию оборудования, взаимодействие с другими гейткиперами и другое. **Порты: FXO, FXS, E\&M, BRI, PRI.** Порт FXO используется для подключения аналоговых телефонов к IP-АТС. Шлюз FXO эмулирует работу телефонного аппарата. Порт FXS – это голосовой интерфейс, который эмулирует работу АТС, позволяющий подключить обычный телефонный аппарат или шлюз FXO. E\&M представляет собой двухпроводной или четырехпроводной интерфейс, аналогичный по функционалу порту FXS. BRI – базовый интерфейс доступа к сети, состоящий из 3 каналов, чаще всего используется для домашнего пользования или небольших компаний. PRI – первичный или основной интерфейс доступа к сети. Состоит из 31 канала и используется в основном для подключения к телефонии крупных предприятий. **Аналоговый адаптер** - адаптер для подключения аналоговых телефонов к сети IP телефонии. От шлюзов отличается отсутствием возможности подключения к ТФОП. Синонимы: АТА адаптер, VoIP адаптер, SIP адаптер, SIP ATA. ## **4.** **Программы и приложения** **CRM (Customer Relationship Management** - система управления взаимоотношений с клиентами) - система организации отношений с клиентами, как правило, содержит контактные данные, историю взаимоотношений, переговоров и покупок клиента. Интеграция СRM-систем и IP-телефонии на сегодняшний день – один из основных инструментов для бизнеса. **Биллинговая система (Billing System)** – программное обеспечение, предназначенное для учета, аналитики, тарификации расходов за телефонные переговоры и выставление счетов. Чаще всего идет в связке с IP-телефонией. **Софтфон** – программный продукт, предназначенный для совершения видео- и голосовых звонков посредством Интернета. Для полноценной работы программного телефона необходима гарнитура, веб-камера, если планируется видеосвязь, колонки и микрофон. **Softswitch** – программный коммутатор, использующийся для обеспечения полноценной работы услуг аналоговой и IP-телефонии. Поддерживает работу всех протоколов, необходимых в работе IP-телефонии. **TAPI (Telephony Applications Programming Interface)** – стандартный интерфейс для разработки программных приложений для телефонии. Разработан на базе Microsoft Windows. Позволяет подключать персональные компьютеры к аналоговым телефонным аппаратам и офисным АТС. **API** – интерфейс прикладного программирования, представляющий собой описание различных способов, с помощью которых возможно взаимодействие двух компьютерных программ. Используется разработчиками софта для написания приложений. **Least Cost Routing System (LCR)** – функция, отслеживающая в режиме реального времени изменения тарифов, что позволяет проложить маршрут между двумя абонентами по пути наименьшей стоимости телефонного соединения. ## **5.** **Сервисы** **IVR (Interactive Voice Response - интерактивный голосовой ответ)** - система голосовых сообщений в ответ на действия пользователя. Для взаимодействия используется тональный набор на телефоне. Может применяться, например, для перевода звонка определенному абоненту, или для голосований и оценки качества обслуживания. **Direct Dial-In (DDI)** – технология, позволяющая совершать вызовы из телефонной сети общего пользования сразу на внутренний номер абонента, минуя соединение с оператором или голосовое меню. **Call Detail Record** – CDR данные о звонке. Чаще всего используются в биллинговой программе для формирования телефонных счетов и оценки использования трафика. **Callback** – услуга, которая позволяет совершать международные звонки по тарифам IP-телефонии. Использование данной функции дает возможность клиенту соединиться с нужным абонентом так, что звонок для обоих будет квалифицироваться как входящий. **Call-tracking** – технология отслеживания звонков, с помощью которой можно выявить наиболее эффективный канал рекламы. **Номера Toll Free** – телефонные номера с кодом 8800, звонки на которые будет оплачивать принимающий абонент. Такие номера часто используются при звонках в техподдержку компании. **Номера DEF** – телефонные номера с кодами не географической нумерации, например мобильные номера: 8926…, 8958... и т.п. **WebRTC** – благодаря такой технологии можно совершать видеозвонки через браузер. Для того, чтобы присоединиться к звонку, пользователю следует лишь перейти по ссылке на нужную страницу. **DNIS (Dialed Number Identification System)** – система определения номера при входящем звонке. **Монитор (Administration manager)** – один из дополнительных модулей IP-телефонии, использующийся для удаленного администрирования различных сетевых устройств: шлюзов, диспетчеров. **PoE (англ. Power Over Ethernet)** - технология, позволяющая подавать питание устройству через сеть Ethernet (внутреннюю компьютерную сеть). Для работы нужно чтобы все устройства поддерживали эту технологию. В случае с организацией офисной АТС Komunikator - роутер и sip телефон должны поддерживать PoE. **Ethernet** - технология передачи данных в компьютерных сетях, часто LAN (локальную компьютерную сеть) называют Ethernet. **WAN (Wide Area Network)** - Глобальная Компьютерная Сеть (Интернет). Соответственно порт WAN - порт для подключения к Интернет. **LAN (Local Area Network)** - Локальная (внутренняя) Компьютерная Сеть. Порт LAN служит для подключения компьютеров и объединения их в локальную сеть. **Wi-Fi (англ. Wireless Fidelity - Беспроводное качество, беспроводная точность)** - Беспроводная сеть передачи данных стандарта IEEE 802.11, которая содержит как минимум одну точку доступа и не менее одного клиента. **Хостинг (англ. Hosting, производная от host - гость)** - услуга по размещению информации (например, сайт) на сервере, находящемся в сети Интернет. ## **6.** **Процессы и явления** **Аналого-цифровой преобразователь (АЦП)** – устройство, которое с помощью импульсно-кодовой модуляции преобразует аналоговый сигнал в цифровой. **Цифро-аналоговый преобразователь (ЦАП)** – устройство, благодаря которому можно цифровой двоичный сигнал преобразовать в аналоговый. **Коммутация пакетов (Packet Switching)** – позволяет организовать соединение при помощи дробления информации на пакеты, последующей их передачи и восстановления информации на приеме. Недостатком такой услуги является невозможность гарантирования качества обслуживания. К преимуществам можно отнести большую эффективность каналов с фиксированной полосой. **Передача данных** – это физический перенос цифровых данных от одной точки к другой или между несколькими точками в виде сигнала по каналам передачи данных для последующей обработки их средствами вычислительной техники. **Джиттер** – изменение (скачки) времени задержки при передаче пакетных данных. Это может произойти вследствие загруженности сети, нестабильной работы оборудования или ограниченной полосы пропускания. **Джиттер буфер** – временное хранилище пакетов данных, созданное на приемной стороне. Используется для борьбы с джиттером. ## **7.** **Параметры и показатели** **ASR/ABR** – статические параметры, определяющие отношение количества принятых звонков к общему числу попыток совершения звонка. Данная величина выражается в процентах и характеризует уровень дозвона. **ACD** – статическая величина, показывающая среднюю продолжительность вызова в различных направлениях. ## 8. Удовлетворенность клиентов **Abandoned Calls –** потерянные (неотвеченные) вызовы в процентном соотношении. **Answered Calls** − процент успешно отвеченных вызовов в общей очереди. **Blocked Rate** - доля обращений с отказом в обслуживании. **ATA time (Average Time to Abandon)** – среднее время ожидания клиентов, завершивших звонок до ответа оператора. **Repeat Calls** (процент повторных обращений) - количество повторных обращений в контакт-центр за некий промежуток времени. Он помогает оценить, насколько успешно операторы решают обращения клиентов во время первого контакта; **Call Transfers** (процент перенаправленных звонков) - те звонки, которые операторы передали своим более квалифицированным коллегам. Когда этот показатель слишком велик, это может означать, что выбрана неправильная стратегия обработки звонков; **FCR** (**First Call Resolution) -** процент решенных вопросов с первого обращения, число тех звонков, которые поступили в колл-центр и произошли однократно в течение определенного промежутка времени; **Hold Time (Время удержания)** — период времени, в течении которого абонент находится на удержании, в то время, как оператор ищет какие-либо данные, чтобы решить проблему абонента. **Calls (Contacts) Resolved** — отношение числа абонентов, вопросы которых были решены в контакт-центре, к общему числу обратившихся в контакт-центр абонентов. **CEA (Critical Error Accuracy)** - доля контактов без критичных ошибок: * с точки зрения конечного потребителя/клиента (**End-User CEA**); * с точки зрения бизнеса (**Business CEA**); * с точки зрения требований закона и других регулирующих норм (**Compliance CEA**); **Overall End-user Satisfaction** — индекс удовлетворенности абонентов. Отношение числа абонентов, поставивших положительные оценки обслуживанию в контакт-центре, к общему числу опрошенных абонентов **Overall End-user Dissatisfaction** — индекс неудовлетворенности абонентов. Отношение числа абонентов, поставивших наименьшую оценку обслуживанию в контакт-центре, к общему числу опрошенных абонентов **CES (Customer Efforts Score)** — индекс количества усилий, которые клиенты (по их оценке) прикладывают при обращении в контакт-центр для решения своего вопроса (в более широком контексте этот показатель используется для оценки усилий клиентов при обращении в компанию, а не только в контакт-центр) **Overall Client Satisfaction** — индекс удовлетворенности заказчиков. Отношение числа заказчиков, поставивших положительные оценки работе контакт-центра, к общему числу опрошенных заказчиков **On Time Complaint Handling** — доля жалоб заказчиков, которые были решены в установленные сроки (или на которые заказчикам поступила реакция в установленные сроки), по отношению к общему числу жалоб заказчиков. ## 9. Операционная эффективность **AHT (Average Handling Time)** **−** среднее количество времени, потраченное на обработку вызова. По умолчанию состоит из времени, потраченного на ожидание, непосредственный диалог и постобработку звонка. **ACW (After Call Work Time) −** средняя продолжительность времени на постобработку звонка. **ATT (Average Talk Time) –** среднее время разговора оператора с абонентом. **Service Level −** уровень сервиса, процент вызовов, обработанных оператором в пределах установленного времени (например, в течение не более 20 секунд ожидания в очереди). **TCV (Total Contact Volume)** - количество поступивших на очередь звонков. **ASA (Average Speed to Answer)** – средняя скорость ответа. **Average Time in Queue (ATQ) -** Общее время ожидания клиента в очереди звонков.\ \ **Average Hold Time** — среднее время удержания **AWT (Average Waiting Time)** - среднее время ожидания абонентом ответа. **MWT (Maximum Waiting Time)** – максимальное время ожидания. **ART (Average Ring Time)** - среднее время вызова оператора.\ \ **Average Wrap-Up Time** — среднее время поствызовной обработки. Поствызов начинается в момент разрыва соединения и заканчивается, когда оператор переходит в статус “готов к обработке следующего звонка” (например, если закрывает карточку контакта в CRM). **Average Connection Time** — среднее время соединения Occupancy (OCC) — коэффициент загрузки операторов. Очень важный показатель, который напрямую связан с экономикой контакт-центра. Равен отношению суммарного времени за период, которое операторы затратили на обработку контактов, к суммарному времени нахождения операторов в линии за тот же период. **Occupancy** - нагрузка операторов, отношение затрат времени на обработку контактов к сумме времени на обработку и времени в состоянии готовности к обработке. **AAT (Average Available Time)** - среднее время простоя операторов в статусе «готов». **PT (Productive Time)** - время, которое оператор обрабатывал или ожидал звонки в статусе «готов». **UR (Utilization)** – загруженность операторов, отношение суммы времени на обработку контактов и времени в состоянии готовности к обработке ко всему времени, оплачиваемому персоналу. **Phone Etiquette (Телефонный этикет)** — квалификационная метрика, иллюстрирующая вежливость оператора и показывающая, часто ли он использует такие приемы, как «приветствие клиента по имени, спокойная и понятная речь, подтверждение взаимопонимания». **Knowledge and Professionalism (Знания и профессионализм)** — другая квалификационная метрика, показывающая, насколько оператор осведомлен о товаре, услугах, процессах, предоставляемых колл-центром. **Adherence to Procedures (Следование инструкциям)** — еще одна квалификационная метрика, показывающая, насколько оператор придерживается стандартов предприятия в течении обработки звонка. Насколько его действия соответствуют сценарию разговора, а также нормам вежливости, как, например, правильное приветствие и корректное завершение разговора. **Sales Rate** — количество результатов, полученных за единицу времени (скорость получения результатов). Например, количество обработанных контактов за час или количество успешных контактов с абонентами за час (определение успешности зависит от контекста проекта). **CSS Utilization (UTZ)** — коэффициент использования персонала. Важен не менее, чем OCC, и тоже прямо связан с экономикой. ## 10. Эффективность голосового меню **IVR routing Accuracy** – число абонентов, получивших исчерпывающие ответы на свои вопросы после выбора в системе IVR. **IVR exit rate** – количество клиентов, которые после прослушивания информации в IVR перешли к диалогу со специалистом. **Abandonment Rate in IVR** - доля обращений, потерянных при обработке , когда клиент покинул голосовое меню без достижения какой-либо цели. **Self Service Rate -** как доля обращений, обработанных в режиме самообслуживания. **RA (Routing Accuracy) –** точность маршрутизации обращения, доля обращений от общего числа поступивших в IVR, корректно перенаправленных в группу операторов в соответствии с темой обращения. ## 11. Результативность **Closure Rate (процент конверсии)** - отношение числа контактов, завершившихся продажей, к общему числу обработанных контактов. **Completion Rate -** число попыток дозвона, деленное на количество записей в базе данных. **Reachability (достижимость) -** отношение числа состоявшихся контактов с лицом, принимающим решения, к числу записей в базе данных. **Sales Amount –** доход от одной продажи, либо общий доход по всем продажам за определенный период. **Conversation Rate -** % обращений, закончившихся продажей от отработанных. **Right Party Connection –** процент контактных лиц, на которых удалось выйти, по отношению к количеству обработанных позиций базы обзвона. **ER (Escalation Rate) –** процент эскалированных (переведенных) вызовов от всех инициированных. **EA (Escalation Accuracy) –** процент корректно переведенных звонков (на другую линию, в другой колл-центр, на других сотрудников) с точки зрения установленных на проекте алгоритмов. **Escalation Rate\***— доля обращений (от общего числа обращений), которые были переведены в другие группы для обработки (раньше в более узком смысле использовался **Transfer Rate)** **Escalation Accuracy** — правильность перевода — отношение числа контактов, которые были переведены правильно (в нужную группу), к общему числу контактов, которые были переведены. ## Продажи и результативность **Completion Success (CS)** — объем выручки или прибыль за определенный период **Sales** — доля продаж, в которых сумма чека не ниже плановой, по отношению к общему количеству продаж **Коэффициент выполнения плана** — например, для выполнения плана по продажам (может рассчитываться и относительно других показателей, для которых заданы допустимые и плановые значения) **Closure Rate (%CR)** — конверсия обработанных контактов в результативные — например, отношение числа контактов, завершившихся продажей, к общему числу обработанных контактов **Reachability** — достижимость (другое название — **Contact Rate**) — отношение числа состоявшихся контактов с лицом, принимающим решения (ЛПР), к числу обработанных записей из базы данных. # Администрирование ### ОмниАТС Интеграция голосовых и web (api/rest) каналов в едином клиентском домене управления и интеграции. Позволяет создавать единые правила обслуживания входящих и исходящих обращений, маршрутизацию клиента и внутренних сотрудников. * Единое управление различными типами внешних каналов * Возможность создания преднастроенных интеграций с различными сервисами и информационными системами (быстрая доставка до клиента, возможность дополнительного лицензирования) * ОмниКанальный контактный центр для обслуживания входящих обращений и исходящих кампании * Портал обслуживания клиента, установка Ролевых приложений, поддержка websocket каналов * Гибкая ролевая модель доступа к различным приложениям портала * Распределение нагрузки и отказоустойчивость за счет возможности поддержки нескольких одновременных каналов между клиентом и разными Web-серверами Аксател Содержание Продукт ОмниАТС . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3\ Web интерфейс администрирования КД . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Аутентификация . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Главная страница . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Основной экран WEB приложения Администрирование . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9\ Горячие клавиши . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12\ Общие настройки разделов. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13\ Маски и модификации. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Управление расписанием активности правил. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17\ Разделы администрирования. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Каналы коммуникаций . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21\ SIP устройства . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21\ SIP провайдеры . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28 Внешние интеграции . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Обработка звонка . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42\ IVR сценарии . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Очереди . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44 Групповые номера . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Правила переадресации . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52 Обработка сервиса . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56 Служебные сценарии . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56 Служебные задачи . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Ролевые приложения . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60 Маршрутизация. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65\ Выбор вектора . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 \ Выбор правила . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68\ Коды абонентских функций. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73\ Нормализация номеров . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Нормализация кросс-доменных звонков . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81 Нормализация номеров внешних линий . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Управление записями разговоров . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88 Правила хранения записей . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88\ Правила записей разговоров . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Настройки домена . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92\ Общие настройки . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92 Пользователи. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Рабочее расписание. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Адресная книга . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100 Подробное описание, вы найдете в прикрепленном файле ниже. {% file src="/files/-MGxCXoA5Aujdj\_exu1K" %} Администрирование Аксател {% endfile %} # Интеграции # CRM системы # АМОCRM Приложение интеграции с IP-телефонией Axatel и AMOCRM  Данная интеграция позволяет осуществлять: отображение уведомления о звонке, прикрепление звонков в карточку контакта, направление звонков ответственному в карточке, набор клиента кликом по номеру контакта. # AlfaCRM Документ в разработке, релиз 30.09.2020г. # Битрикс24 ## **Технические требования для работы с приложением Axatel** Зарегистрированный портал Битрикс24 на платформе [bitrix24.ru](https://www.bitrix24.ru) ## **Установка приложения** Зайдите в раздел **Все приложения** и в окне поиска введите Axatel. \ Нажмите на кнопку **посмотреть** приложения Axatel.
 ## **Настройка прав доступа** Настройка прав доступа производится **Установленные > Права доступа**.   В разделе Права доступа, вы можете предоставить доступ сотрудникам к управлению приложением Axatel.  ## **Настройка виждета на сайт** Настроить виджет на сайт можно в раздел **СRM > Еще > Виджет на сайт**  Выберите **Виджет на сайт** и нажмите на кнопку **Редактировать**. В открывшемся окне активируйте **Обратный звонок**  # 1С ## **Axatel Профон** ### Axatel Профон обеспечивает: * Совершение и принятие вызовов по IP-каналам; * Уведомление о заказе встречных звонков, пропущенных звонков, постановке звонка в очередь; * Запись и прослушивание разговоров; * Идентификация абонента; * Обработка и хранение информации о взаимоотношениях с клиентами; * Статистика соединений; * Управление звонком с помощью компьютера; * Автоматическое создание нового документа «Интерес» или других документов (например, «Заказ покупателя» и т. д.); * Уведомление оператора о состоянии внутренних телефонных линий АТС (свободно/занято); * Установка динамической маршрутизации звонков по правилам, загруженным из конфигурации на платформе «1С:Предприятие 8»; * Использование «черно-белых» списков для контроля за входящими звонками; * Загрузка общих адресных книг организации из «1С:Предприятие» с указанием контактной информации (внутреннего и сотового телефона), а также — фотографий сотрудников. ### Основные функции и преимущества: * Режимы доступа к 1С: RDP, Толстый клиент, тонкий клиент. * Установка на компьютер не требуется. Модуль встраивается в модификацию. * Стабильно высокое качество связи. * Единый журнал звонков. Он формируется как для каждого отдельного пользователя, так и для всей компании. В списке видны статусы вызовов, кто находится в очереди на прием звонка, и событие, введенное в системе. * Аналитика звонков представлена анализом на уровне журнала всех вызовов со всеми статусами. * Возможно получение неограниченной лицензии под индивидуальный заказ при подключении более 100 пользователей. * Отказоустойчивый кластер SLA 99,97%. * Нет ограничений по количеству пользователей. * Есть возможность доработки. Код открыт. ### Когда стоит выбрать решение Axatel Профон: * Требуется единая точка входа информации для учетных систем на платформе «1С:Предприятие 8» * Нет своей CRM, потребности закрывается функционалом Axatel Профон * Нет необходимости закупать телефонные аппараты, достаточно иметь гарнитуру. * Необходимо освободить руки менеджеров от телефонных трубок. * Нужна гибкая система с возможностью индивидуальных модификаций. ### Дорожная карта внедрения: 1. Заключение договора 2. Консультация специалиста 3. Самостоятельное или профессиональное внедрение программного решения 4. 14-дневный тестовый период 5. Эксплуатация с последующей технической поддержкой ## Объединения конфигурации «ProPhone» для типового решения «1C:CRM, редакция 2.0». Сначала в исходной конфигурации необходимо включить возможность изменения.\ Для этого необходимо выбрать пункт меню **Конфигурация** - «**Поддержка** - **Настройка поддержки**.  \ В отрывавшемся окне нажмите на **Включить возможно изменения.**  \ Подтвердите свои действия нажатием кнопки **Да**.  Закройте окно **Настройка поддержки** и перейдите в **Конфигурация > Сравнить, объединить с конфигурацией из файла...**  В открывшемся окне, выберите файл поставки. После выбора файла поставки откроется окно выбора поставщика и установки конфигурации на поддержку ProPhone: \ Необходимо нажать кнопку «Да». После этого открывается окно настройки соответствия объектов при сравнении и объединении конфигураций: В этом окне необходимо настроить следующие соответствия: * Выключить флажок в самой верхней строке иерархического дерева. * Нажать кнопку «Действия» и в открывшемся меню выбрать пункт «Отметить по подсистемам файла». * В появившемся окне включить флажок в строке ProPhone Нажать кнопку «Установить». В окне «Сравнение, объединение…» включить флажок для подсистемы ProPhone. В окне «Сравнение, объединение…» необходимо нажать кнопку «Действия», выбрать пункт меню «Установить режим для всех». В появившемся окне необходимо установить переключатели в положения, показанные на рисунке:  В окне «Сравнение, объединение…» необходимо нажать кнопку «Выполнить». \ Возможность хранить соответствия некоторой информации осуществляет объект конфигурации «Регистр сведений». В данной подсистеме «ProPhone» хранением информации служит регистр сведений «Контактная информация». Этот объект уже существует в таких типовых решениях, как «Управление производственным предприятием, Зарплата и управление персоналом и т.д. В некоторых же из них, в том числе и в типовой конфигурации «Управление торговлей» объект Регистр Сведений «Контактная информация» отсутствует. # Сквозная аналитика # Roistat # Речевая аналитика и контроля качества # COS Control Operayor System Интеграция выйдет до конца 2020г. # Dealapp DealAPP - набор инструментов для контроля качества и оценки звонков и других коммуникаций с клиентами. Сервис позволяет управлять всем процессом контроля от оценки звонков и предоставления обратной связи сотрудникам до глубокой аналитики по каждому отделу или отдельной ситуации. **С его помощью Вы легко и быстро сможете:** * оценить разные виды коммуникаций по Вашим чек-листам на разных этапах воронки продаж и обслуживания клиента; * на основании полученных оценок обнаружить проблемные области в качестве клиентского сервиса или продаж; * вовремя среагировать на проблемные ситуации с клиентами и нивелировать негативные последствия; * проследить за выполнением поставленных задач по исправлению ошибок (в знаниях либо действиях сотрудников); * собирать статистику по качеству коммуникаций с каждым клиентом; * систематизировать процесс обучения персонала;
* с помощью динамической аналитики следить за изменениями в знаниях и поведении вплоть до каждого контролируемого сотрудника; * формировать базу знаний хороших и плохих кейсов для обучения новичков.\
Используйте все возможности **бесплатного тарифного плана "Старт"** для начала работы с DealAPP.\ Подробнее о тарифах по [ссылке.](https://dealapp.io/price) ## Настройка Войдите под своей учетной записью в приложение dealapp.  В открывшемся окне, нажмите на имя учетной записи и выберите **Интеграции**.  Нажмите на кнопку **Установить** в приложении **Custom Http Telephony**.  Дождитесь установки приложения.\ Нажмите на иконку шестеренки для получения информации.  Скопируйте и сохраните данные **URL интегрируемого приложения** и **Токен интеграции.**  Перейдите в раздел администрирования Axatel > Каналы коммуникаций > Внешние интеграции.\ Нажмите на кнопку **Новый объект**.  Введите ранее сохраненные параметры **URL интегрируемого приложения** и **Токен интеграции.**\ Сохраните новый объект **axatel\_dealapp.** На этом настройка завершена.\ DealApp успешно добавлен в Axatel.
 # Speech analytics Сервис речевой аналитики Интеграция выйдет до конца 2020г. # Работа с графическим редактором сценариев Графический интерфейс создания сценариев предоставляет удобный и легкий в использовании инструментарий, отражающий концепцию Low-Code/No-Code. ## Общая логика обработки сценариев Аксател В Аксател реализовано два типа сценариев: * IVR сценарии - сценарии, участвующие в SIP диалогах и являющиеся одной из сторон разговора
* SVC сценарии - сервисные сценарии, выполняющие определённые действия и запускаемые по расписанию или по событиям. Все сценарии выполняются обработчиком, который является интерпретатором визуального кода в исполняемые действия. Каждый запуск сценария создает новый исполняемый экземпляр со своим идентификатором. Сценарий состоит из компонентов. Обработчик сценариев включает в себя алгоритмы реализации функциональности компонентов. Процесс работы обработчика сценария можно представить в следующей последовательности действий: 1\. загружает сценарий, 2\. создает области данных для хранения объявленных переменных, 3\. отыскивает в сценарии компонент Старт с типом основной ветки, 4\. сопоставляет с компонентом алгоритм его работы, 5\. передает управление алгоритму компонента, передавая на вход параметры для компонента из сценария и накопленный контекст, 6\. направляет полученные во время работы компонента события в его очередь обработки и передает ему управление на обработку этой очереди, 7\. обрабатывает ответ компонента: a. продолжение работы компонента; b. откладывание обработки очередного события; c. завершение работы компонента. По завершении работы компонента тот возвращает: i. идентификатор следующего компонента, тогда процесс повторяется с новым компонентом начиная с этапа его поиска в сценарии, расширяясь накопленным контекстом; ii. код следующего сценария (при необходимости запустить вложенный / асинхронный сценарий); iii. ошибка, тогда сценарий завершается и, возможно, производится запуск ветки пост-обработки; iv. команда возврата к предыдущему сценарию, тогда восстанавливается контекст предыдущего сценария и позиция в нем; v. команда остановки, тогда сценарий завершается, и, возможно, производится запуск ветки пост-обработки; Выполнение компонента может протекать синхронно и асинхронно. В любой момент времени обработчик может получить извне команду на завершение. В этом случае выполнение основной ветки сценария прерывается и при наличии соответствующей ветки пост-обработки управление передается на нее. Компонент при завершении работы на основании полученного результата выбирает для передачи управления ту или иную ветку перехода. Большинство компонентов разделяют успешные и неуспешные результаты работы, сопоставляя им различные ветки перехода. Если ветка перехода не задана, то переход осуществляется по основной ветке (переход по-умолчанию). Если переход по-умолчанию не задан, то происходит остановка выполнения сценария с ошибкой "Нет перехода" и возможный запуск пост-обработки. Возможные варианты пост обработки определены в компоненте Старт. Выполнение ветки пост-обработки при завершении уже не предполагает переключения на другую ветку. При запуске сценария на его вход могут передаваться начальные значения * определенные в сценарии в рамках Web интерфейса Администрирования
* передаваемые из родительского сценария дочернему (имеют приоритет над определенными через Гуи-интерфейс) В компоненте Старт всем объявленным переменным без установленных значений могут быть присвоены дефолтные нулевые значения. Это делается для того, чтобы не вызвать ошибок при работе с переменными без значений. ### IVR сценарии Сценарии голосовой обработки (IVR) используются как виртуальный SIP-телефон. По таблице маршрутизации IVR сценарий обслуживается как Код абонентских функций и может иметь множество номеров. Каждый сценарий является стороной А или стороной В разговора. IVR сценарий может быть запущен: * через таблицу маршрутизации. Выступает в качестве стороны В * через Дозвон до абонента. Выступает в качестве стороны А * переводом из другого IVR сценария. Обслуживание разговора передается от одного сценария к другому без использования SIP Re-invite или других SIP взаимодействий. ### Служебные сценарии Служебные сценарии - это алгоритмы обработки данных без обязательной привязки в каким либо активностям. Служебные сценарии могут быть запущены следующими способами: * Ручной запуск сценария из part\_title
* Периодический запуск с помощью служебных задач
* Асинхронный запуск из других сценариев
* В качестве обработчика сообщений и запросов с внешних каналов
* В качестве контекстного сценария параллельно каждому звонку ## Переменные сценариев Переменные сценария – это области данных, сохраняющие значения для работы компонентов сценариев и взаимодействия сценария с внешней средой. Переменные объявляются при редактировании сценария. Область данных выделяется только в момент выполнения сценария.\ Переменные могут передаваться между сценариями. Идентификатором переменной служит ее название. ### Области видимости | **Область видимости** | **Описание** | | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Локальные | Доступны только конкретному экземпляру сценария. Значения хранятся в его стеке. Передаются вложенным синхронным и асинхронным сценариям. | | Сессионные | Доступны внутри всех сценариев сессии. Логика обработки идентична Локальным. | | Сценарные | Доступны всем экземплярам конкретного сценария (по коду сценария) в рамках сайта. | | Сайтовые доменные | Доступны всем сценариям текущего домена, исполняемым внутри одного сайта. | | Сайтовые общие | Доступны всем сценариям всех доменов, исполняемым внутри одного сайта. | | Глобальные доменные | Доступны всем сценариям текущего домена, исполняемым на любом сайте, где обслуживается домен. | | Глобальные общие | Доступны всем сценариям всех доменов, исполняемым на любом сайте, где обслуживается домен. Использование этой переменной не рекомендуется и дополнительно регламентируется переключателем Разрешить использование глобальной переменной при создании дочернего домена. | При сохранении в переменную, слишком большого значения, оно размещается в файловой системе (категория :SYNC), а вместо переменной автоматически размещается путь к файлу. ### Типы значений | **Тип значения** | **Описание** | | ---------------- | ------------------------------------------------------------------------------- | | Число | Целое число или число с десятичной точкой. | | Строка | Строковое значение. Хранится в виде структуры, содержащей значение и кодировку. | | Дата-время | Строковое значение в формате RFC3339. | #### Преобразование значений В операциях, где важна синхронизация типов значений, значения автоматически преобразовываются из одного типа в другой. В случае возникновения ошибок преобразования поведение зависит от конкретной операции. #### Начальные значения Использование переменных в Выражениях невозможно до присвоения им значений. По-умолчанию все переменные создаются с пустым значением. Присвоение значений переменным * при старте сценария – определенные в сценарии в рамках Web интерфейса Администрирования начальных значений\ \ – передаваемые из родительского сценария дочернему (имеют приоритет над определенными через Web-интерфейс). Синхронизация по имени переменной – в компоненте Старт могут быть присвоены дефолтные нулевые значения (переключатель Инициализировать переменные) * во время работы сценария – компонентом Присвоение в режимах одиночного и множественного присвоения Зарегистрированные локальные переменные при запуске сценария создаются с пустыми значениями. Их использование в выражениях невозможно до присвоения значений. В компоненте Старт допускается установить режим присвоения начальных значений по умолчанию. Начальные значения локальных переменных могут быть также установлены при запуске обработчика сценария из настроек сущности конкретного сценария (поле opts.variables), назначены из родительских процессов, скопированы из родительских сценариев и т.д. Переменные с областью видимости, отличной от локальной, создаются только в момент непосредственного присвоения значений внутри сценария. ## Аргументы сценариев Компоненты сценариев оперируют аргументами. Аргументом сценария называется некий объект, значение которого может быть вычислено в любой момент в ходе выполнения сценария по запросу активного компонента. Вычисление значения аргумента производится по мере необходимости выполнения компонентов. Результат вычисления подставляется в качестве значения соответствующего свойства компонента. ### Типы аргументов 1\. Фиксированное значение (константа);\ 2\. Переменная;\ 3\. Выражение (арифметические и строковые операции с переменными, константами и функциями от них).\ 4\. Шаблон ### Типы значений Значение аргумента может принадлежать к одному из типов: * Число (целое или десятичное); * Строка; * Дата/время. ### Приведение типов При сопоставлении значений аргументов, происходит их приведение к одному типу по следующему правилу: * Если типы значений совпадают, то приведения не производится.
* Если оба значения могут быть представлены в виде чисел, производится приведение к числам.
* Если оба значения могут не могут быть представлены в виде чисел, то производится приведение к строке. ## Выражения сценариев Выражение – это заданная в компоненте сценария последовательность арифметических или строковых действий, оперирующая константами, переменными и функциями от них. Выражение используется для подстановки в качестве аргумента в значение компонентов сценария. Результат выражения может иметь тип сроки, числа и даты (в формате RFC3339). Значения типа bool на выходе автоматически преобразуются к строке true или false. С помощью функции ifelse(bool,any,any) результат можно привести к другим значениям, например числам 0 или 1. Чтобы в качестве аргумента выражения использовать значение переменной, следует указать ее имя в квадратных скобках, например \[var\_i]. Для явного указания строки следует заключать текст в кавычки. В противном случае, сначала будут вычислены все арифметические комбинации, доступные для расчета. В приведенных примерах 2.3 и 2.4 результат будет разный (у 2.3 результат начинается с "5", а у 2.4 с "23"). Разбиение на строки производится с помощью функции endline(). ### Примеры выражений #### Примеры числовых выражений ``` 1.1. [var_num_1] + 1 1.2. 2 ^ [var_num_2] * ( Log10 ( [var_num_3] ) + 2 ) 1.3. sin ( len ( [var_string_1] ) ) ``` #### Примеры строковых выражений ``` 2.1. [var_string_1] + [var_string_2] 2.2. "Кусок текста" + [var_string_1] 2.3. 2 + 3 + [var_string_1] 2.4. "2" + "3" + [var_string_1] 2.5. SubStr ( [var_string_1], 1, Length ( [var_string_1] ) - 1 ) 2.6. If ( num([a]) > 5, "больше", "меньше") ``` ### Операции Операции над аргументами | Функция | Тип значения | Описание | | ------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | | + | num \| str | Если аргументы могут быть приведены к числам, то результатом является сумма двух чисел. Иначе аргументы они приводятся к строке и сцепляются. | | ++ | str | Приводит аргументы к строке и сцепляет их. | | - | num | Если аргументы могут быть приведены к числам, то результатом является их разность. Иначе операция завершается с ошибкой. | | \* | num | Если аргументы могут быть приведены к числам, то результатом является их произведение. Иначе операция завершается с ошибкой. | | / | num | Если аргументы могут быть приведены к числам, то результатом является их частное. Иначе операция завершается с ошибкой. | | div | int | Если аргументы могут быть приведены к целым числам, то результатом является целая часть их частного. Иначе операция завершается с ошибкой. | | rem | int | Если аргументы могут быть приведены к целым числам, то результатом является остаток от деления. Иначе операция завершается с ошибкой. | | == | bool | Приводит значения аргументов к одному типу и сравнивает их. Равенство. | | /= | bool | Приводит значения аргументов к одному типу и сравнивает их. Неравенство. | | > | bool | Приводит значения аргументов к одному типу и сравнивает их. Больше. | | >= | bool | Приводит значения аргументов к одному типу и сравнивает их. Больше или равно. | | < | bool | Приводит значения аргументов к одному типу и сравнивает их. Меньше. | | =< | bool | Приводит значения аргументов к одному типу и сравнивает их. Меньше или равно. | ### Шаблоны Приложение редактора сценариев позволяет задавать выражения с помощью шаблонов. Шаблон представляет собой строку, в которую в фигурных скобках входят вычислимые выражения. При этом переход между вкладками задания шаблона и задания выражения производит автоматическое взаимное преобразование. Пример записи одного вычисления на закладке Выражение и Шаблон: Закладка выражения $$ "abc." + str(\[var]) + ".def" + endline() + replace(\[var],";",".") + substring(\[var2],3,5) + "zzz" $$ \ Закладка шаблона $$ abc.{str(\[var])}.def {replace(\[var1],";",".") + substring(\[var2],3,5)}zzz $$ ## Функции сценариев Функции используются при создании выражений и шаблонов. Позволяют вычислять специфические значения и проводить операции над системой. ### Каталог функций Не все функции доступны в каждом Продукте. Ниже приведен полный список функций системы по всем Продуктам. #### Математические функции | Функция | Параметры | Описание | | ------- | --------- | ------------------------------------------------------------ | | abs | num | Абсолютное значение числа | | acos | num | Арккосинус числа | | asin | num | Арксинус числа | | atan | num | Арктангенс числа | | atan2 | num, num | Арктангенс частного двух чисел | | ceil | num | Ближайшее сверху целое число | | cos | num | Косинус числа | | cosh | num | Гиперболический косинус числа | | erf | num | Функция ошибки (интеграл вероятности) | | erfc | num | Дополнительная функция ошибок | | exp | num | Экспонента числа | | floor | num | Ближайшее снизу целое число | | lg | num | Десятичный логарифм числа | | ln | num | Натуральный логарифм числа | | log | num, num | Логарифм одного числа по основанию другого | | log10 | num | Десятичный логарифм числа | | log2 | num | Двоичный логарифм числа | | max | num, num | Максимальное из двух чисел | | min | num, num | Минимальное из двух чисел | | pow | num, num | Результат возведения одного числа в степень другого | | random | | Случайное десятичное число от 0 до 1 | | random | int | Случайное целое число от 0 до указанного целого числа | | random | int, int | Cлучайное целое число в диапазоне между двумя целыми числами | | round | num | Результат округления числа до целого | | sin | num | Синус числа | | sinh | num | Гиперболический синус числа | | sqr | num | Квадрат числа | | sqrt | num | Квадратный корень числа | | tan | num | Тангенс числа | | tanh | num | Гиперболический тангенс числа | | trunc | num | Результат отбрасывания дробной части числа | #### Строковые функции | Функция | Параметры | Описание | | ------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | concat | str,str | Возвращает результат сцепления двух строк. | | equal | str,str | Результат сравнения двух строк: 0 или 1 | | indexof | str,str,int | Возвращает индекс позиции первого вхождения подстроки (п2) в строку (п1), начиная с указанной позиции (п3). Возвращает 0, если вхождений не обнаружено. | | left | str,int | Возвращает левую часть строки не более чем указанной длины. | | len | str | Возвращает длину строки в символах. | | lower | str | Возвращает строку в нижнем регистре. | | modify\_json | str,json,json | Возвращает измененную json-структуру. Подробнее в Функция modify json | | newid | | Возвращает сгенерированный UUID-идентификатор. | | regexreplace | str,str,str | Возвращает результат замены с помощью регулярного выражения. п1 - значение, п2 - паттерн, п3 - замена. | | regexreplaceg | str,str,str | Возвращает результат замены с помощью регулярного выражения с опцией global. п1 - значение, п2 - паттерн, п3 - замена. | | remove | str,int | Возвращает строку после удаления из нее подстроки с указанной позиции (п2) до конца. | | remove | str,int,int | Возвращает строку после удаления из нее подстроки с указанной позиции (п2) указанной длины (п3). | | replace | str,str,str | Возвращает результат замены в строке (п1) вхождения (п2) на значение (п3). | | reverse | str | Возвращает перевернутую строку. | | right | str,int | Возвращает правую часть строки не более чем указанной длины. | | rstr | str,str | Возвращает индекс позиции последнего вхождения подстроки (п2) в строку (п1). Возвращает 0, если вхождений не обнаружено. | | str | str,str | Возвращает индекс позиции первого вхождения подстроки (п2) в строку (п1). Возвращает 0, если вхождений не обнаружено. | | substr | str,int | Возвращает подстроку с указанной позиции (п2) до конца. | | substr | str,int,int | Возвращает подстроку с указанной позиции (п2) не более чем указанной длины (п3). | | trim | str | Возвращает строку, избавленную от пустых символов в начале и в конце (пробел, табуляция и т.д.). | | trimend | str | Возвращает строку, избавленную от пустых символов в конце (пробел, табуляция и т.д.). | | trimstart | str | Возвращает строку, избавленную от пустых символов в начале (пробел, табуляция и т.д.). | | upper | str | Возвращает строку в верхнем регистре. | #### Функции по работе с датами/временем | Функция | Параметры | Описание | | ------------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | date | | Возвращает текущую дату в локальном часовом поясе сервера без указания часового пояса. Формат YYYY-MM-DD. | | date | dt | Возвращает дату из указанной даты/времени. | | dateadd | atom,int,dt |
Возвращает дату после добавления указанного количества (п2) указанных единиц времени (п1) к указанной дате/времени (п3). Параметр указывается в виде атома (не строки), например dateadd('mi',120,"2019-10-06T13:05:28")
Возможные виды единиц по убыванию:
yy, yyyy, q, qq, m, mm, ww, wk, d, dd, h, hh, mi, n, s, ss, ms
| | datediff | atom,dt,dt |Возвращает число указанных единиц времени между двумя датами. Параметр указывается в виде атома (не строки), например datediff('dd',"2019-10-06","2019-10-05")
Возможные виды единиц по убыванию:
yy, yyyy, q, qq, m, mm, ww, wk, d, dd, h, hh, mi, n, s, ss, ms
| | dateformat | str, dt |Возвращает строку с представление даты (п2) по указанному формату (п1). Например: yyyy-MM-dd. Возможные значения форматирующей строки:
yyyy, yy, MM, d, dd, h, HH, MMM, mm, ss, ffff, fff, ff, f, zzz.
| | datetime | int,int,int | Возвращает дату/время на основе переданных п1 - года, п2 - месяца, п3 - дня. | | datetime | int,int,int,int,int | Возвращает дату/время на основе переданных п1 - года, п2 - месяца, п3 - дня, п4 - часа, п5 - минуты. | | datetime | int,int,int,int,int,int | Возвращает дату/время на основе переданных п1 - года, п2 - месяца, п3 - дня, п4 - часа, п5 - минуты, п6 - секунды. | | datetime | int,int,int,int,int,int,int | Возвращает дату/время на основе переданных п1 - года, п2 - месяца, п3 - дня, п4 - часа, п5 - минуты, п6 - секунды, п7 - миллисекунды. | | datetime | str | Возвращает дату/время, сформированную по строке. Строка может содержать различные представления даты/времени, в том числе и RFC3339. | | datetimelocal | dt | Возвращает дату/время приведенную к локальному часовому поясу сервера. Числовые значения даты/времени не изменяются, однако абсолютная точка времени может быть сдвинута после изменения тайм-зоны на локальную. | | datetimeutc | dt | Возвращает дату/время приведенную к UTC. Числовые значения даты/времени не изменяются, однако абсолютная точка времени может быть сдвинута после изменения тайм-зоны на нулевую. | | day | dt | Возвращает текущий день (1-31) указанной даты/времени. | | dayofweek | dt | Возвращает номер дня недели (1-7) для указанной даты/времени. | | dayofyear | dt | Возвращает номер дня в году для указанной даты/времени. | | hour | dt | Возвращает текущий час (0-23) указанной даты/времени. | | isleapyear | int | Возвращает true, если указанная дата/время представляет високосный год. | | localtoutc | dt | Возвращает UTC дату/время для указанной даты/времени, рассматриваемой в локальном часовом поясе сервера. | | millisecond | dt | Возвращает текущую миллисекунду (0-999) указанной даты/времени. | | minute | dt | Возвращает текущую минуту (0-59) указанной даты/времени. | | month | dt | Возвращает текущий месяц (1-12) указанной даты/времени. | | now | | Возвращает текущую дату и время в локальном часовом поясе сервера в формате RFC3339. Например, 2019-10-06T16:43:30.46+03:00. | | nowgregsecond | | Возвращает количество секунд по григорианскому календарю, с 0 года н.э. | | nowtick | | Возвращает число, представляющее абсолютное значение в миллисекундах с 01.01.1970 года до текущего времени сервера. | | nowutc | | Возвращает текущую дату и время в UTC в формате RFC3339. | | second | dt | Возвращает текущую секунду (0-59) указанной даты/времени. | | ticktolocal | int | Возвращает дату в локальном часовом поясе сервера по абсолютному значению tick. | | ticktoutc | int | Возвращает дату в UTC по абсолютному значению tick. | | time | | Возвращает текущее время в локальном часовом поясе сервера без указания часового пояса. Формат HH:mm:ss.fff. | | time | dt | Возвращает время из указанной даты/времени. | | utctolocal | dt | Возвращает локальную дату/время для указанной даты/времени, рассматриваемой как UTC. | | valid\_date | dt | Возвращает true, если указанная строка содержит корректную дату/время, иначе false. | | weekofyear | dt | Возвращает номер недели в году для указанной даты/времени. | | year | dt | Возвращает текущий год указанной даты/времени. | #### Функции преобразования | Функция | Параметры | Описание | | ------------ | ------------ | ----------------------------------------------------------------------------------------------------------------------- | | base64decode | str | Возвращает строку, полученную в результате распаковки из Base-64 представления. | | base64encode | str | Возвращает строку, полученную в результате упаковки в Base64 представление. | | char | str | Возвращает строку с одним символом по его числовому коду. | | dechex | int | Возвращает строку с HEX-представлением числа. | | escape | str | Возвращает строку, полученную в результате преобразования к escape-последовательности. Применяется для вставки в JSON. | | hexdec | str | Возвращает число на основе его HEX-представления. | | htmldecode | str | Возвращает строку, раскодированную c помощью Unicode Hex Character Code | | htmlencode | str | Возвращает строку, закодированную c помощью Unicode Hex Character Code. | | ifelse | bool,any,any | Если значение первого параметра true, то возвращает п2, иначе возвращает п3. | | num | str | Преобразует строку к числу. При неудаче завершается с ошибкой. | | numval | str | Преобразует строку к числу, отрезая с конца неподходящие символы. В пределе возвращает 0. | | str | int | Преобразует числовое значение к строке. | | translit | str | Возвращает результат транслитерации строки. | | unescape | str | Возвращает строку, полученную в результате распаковки из escape-последовательности. Применяется для очистки после JSON. | | urldecode | str | Возвращает строку, раскодированную с помощью UrlEncode. | | urlencode | str | Возвращает строку, закодированную с помощью UrlEncode. | #### Хеш-суммы | Функция | Параметры | Описание | | ------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | adler32 | any | Хеш от любого значения по алгоритму Adler-32. | | adler32 | num,any | Новое значение хеша от предыдущего значения, скомбинированного с новой порцией. п1 - предыдущее значение хеша, п2 - новая порция данных. По алгоритму Adler-32. | | crc32 | any | Хеш от любого значения по алгоритму CRC32 (IEEE 802.3). | | crc32 | num,any | Новое значение хеша от предыдущего значения, скомбинированного с новой порцией. п1 - предыдущее значение хеша, п2 - новая порция данных. По алгоритму CRC32 (IEEE 802.3). | | md5 | str | Хеш от строки по алгоритму MD5. | | phash2 | any | Хеш-сумму от любого значения по внутреннему алгоритму. | #### Функции по работе с файловыми путями | Функция | Параметры | Описание | | ------------------ | ----------- | ----------------------------------------------------------------------------------------------------------------------------- | | filedir | str | Возвращает название каталога. Для пути к файлу - это имя каталога, для пути к каталогу - это название родительского каталога. | | fileext | str | Возвращает расширение файла, выделенное из указанного пути. | | filename | str | Возвращает имя файла, выделенное из указанного пути. | | gs\_domain | | Возвращает :GLOBALSHARE\_DOMAIN\_DATA - префикс категории сетевого межсайтового каталога текущего домена. | | gs\_public | | Возвращает :GLOBALSHARE\_PUBLIC - префикс категории сетевого межсайтового каталога общего назначения. | | gs\_script | | Возвращает :GLOBALSHARE\_SCRIPT\_DATA - префикс категории сетевого межсайтового каталога текущего сценария (по коду). | | makepath | str,str | Возвращает путь, сформированный в результате сцепки двух частей. | | makepath | str,str,str | Возвращает путь, сформированный в результате сцепки трех частей. | | pathtype | str | Возвращает тип пути (префикс категории из указанного пути). | | relpath | str | Возвращает относительный путь (указанный путь без префикса категории). | | ss\_domain | | Возвращает :SITESHARE\_DOMAIN\_DATA - префикс категории сетевого внутрисайтового каталога текущего домена. | | ss\_public | | Возвращает :SITESHARE\_PUBLIC - префикс категории сетевого внутрисайтового каталога общего назначения. | | ss\_script | | Возвращает :SITESHARE\_SCRIPT\_DATA - префикс категории сетевого внутрисайтового каталога текущего сценария (по коду). | | syn\_domain | | Возвращает :SYNC\_DOMAIN\_DATA префикс категории синхронизирующегося каталога данных домена. | | syn\_media | | Возвращает :SYNC\_COMMON - префикс категории синхронизирующегося каталога общего назначения. | | syn\_script | | Возвращает :SYNC\_SCRIPT\_DATA префикс категории синхронизирующегося каталога данных текущего сценария (по коду). | | syn\_script\_media | | Возвращает :SYNC\_SCRIPT\_STATIC префикс категории синхронизирующегося каталога статических файлов сценария (по коду). | | temp | | Возвращает :TEMP - префикс временного локального каталога сценария. | #### Служебные функции | Функция | Параметры | Описание | | ------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | getscriptref | | Возвращает строку с идентификатором текущего обработчика сценариев. По этому идентификатору обработчику могут отправлять сообщения другие обработчики сценариев, например с помощью компонента Взаимодействие сценариев. | | startparam | int | Возвращает значение входного параметра с указанным индексом. Сценарии могут принимать до 20 входных параметров. | #### Функции Доступа | Функция | Параметры | Описание | | -------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | check\_variable | str | Возвращает true, если переменная c указанным именем существует и содержит значение. | | get\_variable\_id | str | Возвращает строку с идентификатором переменной по её имени. | | get\_variable\_orig | str | Возвращает значение переменной по её имени, причем, если значение строковое, то оно возвращается в исходной кодировке без преобразования. | | get\_variable\_value | str | Возвращает значение переменной по её имени. | | var | str | Возвращает значение переменной по её имени. | #### Функции конфигурации | Функция | Параметры | Описание | | ------- | --------- | ------------------------------------------------------------------------------------------------------ | | wsurl | | Возвращает URL ближайшего доступного сервера с логической ролью ws. В формате proto://ip-address:port. | #### Константы | Функция | Параметры | Описание | | ------- | --------- | ----------------------------------------- | | e | | Возвращает число e (2.718281828459045). | | phi | | Возвращает число phi (1.618033988749895). | | pi | | Возвращает число pi (3.141592653589793). | #### Символы | Функция | Параметры | Описание | | ------------------------------------------ | --------- | --------------------------------------------- | | dblquot | | Возвращает строку с символом двойной кавычки. | | | endline | | | Возвращает строку с символом конца строки. | quot | | | Возвращает строку с символом кавычки. | tab | | #### Функции сценариев IVR | Функция | Примечание | Описание | | ------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | calledext() | только для вызовов, поступивших в IVR | Возвращает строку с расширением КАФ, по которому звонок поступил в IVR. | | callednum() | только для вызовов, поступивших в IVR | Возвращает строку с набранным абонентом номером. | | callid() | | Возвращает строку со значением заголовка CallId плеча b2b - ivr текущего разговора | | huntid() | только для сценариев Прекоммутации и Ожидания в очереди обработки очередей | Возвращает строку с идентификатором сущности hunt-группы, на которую направлен вызов. | | huntobjid | только для сценариев Прекоммутации и Ожидания в очереди обработки очередей | Возвращает строку с идентификатором текущего абонента очереди hunt-группы. | | ivrparam(str) | только для вызовов, поступивших в IVR. | Возвращает значение указанного параметра из заголовка X-R-Ivr, который формируется ролью b2b. Например, from, to, by. | | q\_displayname | только для сценария Прекоммутации обработки очередей | Возвращает displayname абонента, ожидающего коммутации с вызываемым оператором | | q\_domain | только для сценария Прекоммутации обработки очередей | Возвращает domain абонента, ожидающего коммутации с вызываемым оператором | | q\_username | только для сценария Прекоммутации обработки очередей | Возвращает username абонента, ожидающего коммутации с вызываемым оператором | | queueestimatedsec() | только для сценария Ожидания в очереди обработки очередей | Предполагаемое время ожидания в очереди | | queueposition() | только для сценария Ожидания в очереди обработки очередей | Возвращает текущую позицию в очереди. | | queuepriority() | только для сценария Ожидания в очереди обработки очередей | Возвращает текущее числовое значение приоритета в очереди. | | queuepriority(int) | только для сценария Ожидания в очереди обработки очередей | Устанавливает новое числовое значение приоритета в очереди, автоматически производится перемещение. | | queuerescount() | только для сценария Ожидания в очереди обработки очередей | Возвращает количество операторов в хант-группе. | | queuerescount(str) | только для сценария Ожидания в очереди обработки очередей |Возвращает количество операторов в хант-группе, находящихся в указанном в переменной str состоянии. Возможные варианты:
- online
- free
* prepend - для массива. Добавляет новый элемент в начало. В опциях значение элемента по ключу value
* insert - для массива. Добавляет новый элемент в указанную позицию. В опциях значение элемента по ключу value, позиция по ключу index.
* replace - для массива. Заменяет элемент в указанной позиции на новый. В опциях значение нового элемента по ключу value, позиция по ключу index.
* replace\_auto - для массива. Заменяет все элементы массива на указанное значение. В опциях значение по ключу value.
* delete - для массива. Удаляет элемент из указанной позиции. В опциях значение позиции по ключу index.
* keystore - для объекта. Сохраняет элемент по указанному ключу, в зависимости от наличия ключа добавляет или изменяет значение. В опциях значение элемента по ключу value, значение ключа по ключу key.
* keyreplace - для объекта. Заменяет элемент по указанному ключу, а если ключ отсутствует, то оставляет без изменений. В опциях значение элемента по ключу value, значение ключа по ключу key.
* keyinsert - для объекта. Сохраняет элемент по указанному ключу, если он отсутствует, а иначе завершается с ошибкой. В опциях значение элемента по ключу value, значение ключа по ключу key.
* keydelete - для объекта. Удаляет элемент по указанному ключу. В опциях значение ключа по ключу key. **Примеры.** Исходная переменная x ```typescript { "name": "Андрей Васильев", "id": "1377340472378151" } ``` Пример 1. Keyinsert Добавлено в json ключа "channel" со значением "test". ```typescript modify_json( "", [x], "{\"action\":\"keyinsert\", \"key\":\"channel\", \"value\":\"\\\"test\\\"\"}" ) ``` Результат ```typescript { "channel":"test", "name":"Андрей Васильев", "id":"1377340472378151" } ``` Если Key channel существует до выполнения modify\_json, то результат будет Ошибка Пример 2. Keyreplace Заменена значения у поля name. ```typescript modify_json( "", [x], "{\"action\":\"keyreplace\", \"key\":\"name\", \"value\":\"\\\"test\\\"\"}" ) ``` Результат ```typescript { "name":"test", "id":"1377340472378151" } ```
## Взаимодействие сценариев Каждый сценарий в процессе своего выполнения может запускать другие сценарии в двух режимах * Вложенное (синхронное) выполнение. Родительский сценарий ждет завершения дочернего для продолжения своей работы.
* Асинхронное выполнение. Родительский сценарий не ждет завершения дочернего, а продолжает свою работу. ### Варианты вызова сценариев #### IVR → IVR Вызов дочернего IVR осуществляется через Запуск сценария по имени или по коду. Вызов возможен только во Вложенном (синхронном) режиме. Все Локальные переменные родительского IVR наследуются дочерним сценарием. Для возврата управления в родительский IVR, дочерний сценарий необходимо завершить компонентом Стоп с включенным признаком возврата управления. Вместе с управлением в родительский вернутся изменения в значениях локальных переменных, если таковые были сделаны в дочернем сценарии. Обычно применяется для * разбиения больших сценариев на более понятные; * для выделения идентичной логики несколькими сценариями; #### IVR → Служебный сценарий Вызов служебного сценария из IVR-сценария осуществляется через Запуск сценария по имени или по коду. Вызов возможен только в Асинхронном служебном режиме. Все Локальные переменные родительского IVR наследуются служебным сценарием. Обычно применяется для асинхронной обработки данных, полученных из IVR сценария (которая может занять длительное время и не должна влиять на голосовое взаимодействие с абонентом) #### Служебный → IVR сценарий Для вызова IVR-сценария из служебного сценария используется Исходящий звонок. Происходит инициация исходящего звонка от имени IVR на указанный номер и при поднятии трубки запускается указанный IVR сценарий. Обычно используется для автоматических задач дозвона и оповещения. #### Служебный → Служебный сценарий Для вызова служебного сценария из служебного сценария используется Запуск сценария . Вызов возможен в обоих режимах - вложенного и асинхронного. В режиме вложенного будет ожидать завершения вызываемого сценария. Локальные переменные наследуются в дочерний. В режиме асинхронного запускает параллельное выполнение сценария. Родительский сценарий не ждет завершения дочернего. Даже если родительский сценарий завершится, асинхронный служебный сценарий продолжит свою работу пока не завершится сам.\ Используется для параллельной обработки больших объемов данных. Все сценарии настраиваются в модуле Редактор сценариев (scripteditor). Модуль предоставляет возможность с помощью графического интерфейса визуально программировать сценарии и имеет все требуемые компоненты для решения большинства задач.  ## Верхняя панель  | **Название** | **Описание** | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Имя сценария | Отображается имя сценария | | Код сценария | Отображается заданный код сценария | | Тип сценария |
- Служебный сценарий
- IVR сценарий
Переход в случае успешного завершения операции.
Переход в случае ошибки выполнения операции.
При работе с получением файлов возможно указать вид получаемого ответа
- Да = имя файла с расширением
- Нет = имя файла без расширения
- Путь источника
- Путь назначения
- Путь источника
- Путь назначения
- Путь источника
- Путь назначения
- Путь
- Путь
- Путь
- Путь
- Путь
- Путь
- Путь
- Отрезать расширение
– Да
– Нет
| | | Расширение | Определение расширение файла из строки полного пути |- Путь
- Путь
- Тип каталога
- Относительный путь
- Путь
- Имя файла
- Расширение
Создание всех каталогов из переменной, включая последний отрезок.
Необходимо передавать без имени файла.
- Путь
- Путь
- Путь источника
- Путь назначения
- Путь источника
- Путь назначения
- Путь источника
- Путь назначения
- Путь
- Путь
- Путь
- Путь
• Кодировка
• Содержимое
| | Записать файл | Запись данных в указанной кодировке в файл (перезаписывает существующий файл) |- Путь
- Кодировка
- Содержимое
- Путь
- Кодировка
- Содержимое
- Путь
- Кодировка
БД для подключения.
- CDR – Собственная событийной потоковой БД домена.
- Journal – Собственная журнальная БД домена.
- Report – Собственная отчетная БД домена.
- Другая – Другая БД.
(если База Данных = Другая)
- ODBC – подключение через драйвер ODBC.
- PSQL – одключение через внутренний адаптер к PostgreSQL.
Пример для odbc драйвера
Driver={SQL Server Native Client 11.0};
Server=192.168.0.73,14350;
Database=testbase;
UID=test;
PWD=123;
Пример для psql драйвера
Driver={PostgreSQL Unicode(x64)};
Server=127.0.0.1;
Port=5433;
Database=r\_cdr\_central\_common;
Uid=rostellpgadmin;
Pwd=123456;
Тело SQL запрос, который будет отправлен в БД.
INSERT INTO EMPLOYEE (NR, FIRSTNAME, LASTNAME, GENDER)
VALUES (?, ?, ?, ?)
Списочное значение, устанавливающее параметры для запроса.
pKey="sql\_integer", pValue=\[2,3],
pKey="sql\_varchar, 20", pValue=\["Sergey", "Alina"],
pKey="sql\_varchar, 20", pValue=\["Ivanov","Gallyamova"],
pKey="sql\_char, 1", pValue=\["M","F"].
Кодировка, в которой следует сохранить строковые значения в переменных.
- UTF-8
- cp1251 – Кодовая страница windows-1251 (кириллица)
Использовать ли прокси сервер для подключения:
• Нет. Прямой запрос
• Да. Запрос через прокси сервер. Дополнительно надо определить:
\* Адрес прокси - IP/fqdn прокси сервера
\* Порт прокси - Port прокси сервера
\* Аутентификация:
\*\* Да - необходима аутентификация на прокси
\*\*\* Логин прокси
\*\*\* Пароль прокси
\*\* Нет - прокси без аутентификации
Способ выбора канала интеграции, через URL которого отправлять HTTP-запрос.
- Из списка - необходимо в поле Канал интеграции выбрать канал
- По коду - необходимо в поле Код канала интеграции ввести аргументом Код канала интеграции, который настроен в системе.
Адрес сервера, с которого необходимо отправить запрос. По умолчанию запрос отправляется с сервера, где обработчик выполняет сценарий. Возможные форматы указания:
\* RoleId
\* RoleId:Iface
,где
- RoleId – идентификатор роли в конфигурации, по роли определяется нода;
- Iface – адрес сетевого интерфейса на сервере.
- POST
- GET
- PUT
- HEAD
- DELETE
- PATCH
- TRACE
- OPTIONS
- Да - необходима базовая аутентификация (дополнительно надо ввести аргументы для полей Логин и Пароль)
- Нет - без базовой аутентификации
Позволяет переопределить некоторые стандартные заголовки, а также установить новые персональные заголовки.
Вид:
HeaderName1: Value1
HeaderName2: Value2
Позволяет установить дополнительные cookie значения.
Строковый аргумент, подразумевающий присутствие одного или нескольких дуплетов "ключ=значение", разделенных переводом строки (вид аналогичный “Заголовки”).
Режим работы компонента после отправки запроса. Возможные варианты:
- Ожидание результата – Ожидание ответа от удаленной стороны без ограничения по времени.
- Асинхронный запуск – Управление сразу передается следующему компоненту.
- Обрыв по таймауту – Ожидание ответа в течение установленного времени, по истечению которого HTTP-подключение разрывается и управление передается следующему компоненту.
- Выход по таймауту – Ожидание ответа в течение установленного времени, по истечению которого управление передается следующему компоненту без разрыва подключения и прерывания процесса отправки.
(для всех режимов кроме Асинхронный)
- Авто из заголовка
- Авто из тела
- Unicode
- UTF-8
- UTF-7
- Windows-1251
- Указать название – Задать название кодировки вручную.
- Парсер JSON – Применяет алгоритм поиска в JSON структуре.
- Парсер XML - Применяет алгоритм поиска в XML документе.
- Регулярные выражения – Применяет стандартный алгоритм регулярных выражений. Осуществляет поиск элементов по поисковому шаблону. В общем случае обнаруживает несколько элементов. Для выдачи содержимого необходимо указать номер элемента и номер группы (если в шаблоне используется захват групп).
- Парсер HTML – Применяет алгоритм поиска в HTML документе. Синтаксис описан в . Допускает отсутствие закрывающих тегов (в отличие от XML).
\[
{
"msgId": 8256,
"msgDt": 1491292391,
"msgData": {
"type": "buttons",
"data": "Связаться с usr 6"
},
"msgSender": "ab"
},
{
"msgId": 8257,
"msgDt": 1491292392,
"msgData": {
"type": "buttons",
"data": "Связаться с usr 8"
},
"msgSender": "ab"
}
]
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
\
Значение атрибута.
Имя атрибута: "type"
Имя атрибута.
Номер атрибута: 1
* Последовательность тегов формируется разделителем |, например "html"|"head"|"title"
* Получения одного из одинаковых тегов производится добавлением индекса после разделителя тега (начиная с нуля), например "html"|"br"|1|"title"
* По умолчанию переход к поиску следующего тега происходит с выбором нулевого тега.
* Запрос "html"|0|"head"|0|"title"|0 равносилен запросу "html"|"head"|"title", т.е запрос по имени тега всегда возвращает список.
* Запрос можно строить по индексам, например "0|0|1"
* Для обращений к атрибутам тега используется скобки.
* Запрос "html"|"head"|("charset") выдаст список родительских тегов "head" в которых присутствует атрибут "charset".
* Запрос "html"|"head"|("type="test/css") выдаст список родительских тегов "head" в которых атрибут "type" равен "test/css". Пример документа HTML: ```markup
abc abc
link
zxcv zxcv
``` | **Запрос** | **Функция** | **Результат** | | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ("id"="x1") | Документ |\
| | Содержимое | | | | Количество элементов | 1 | | |Значение атрибута.
Имя атрибута: id
\
| | "p"\|0 | Документ |\
| | "p"\|1 | Документ | \zxcv zxcv\
| | "BODY"\|"p"\|("v") | Содержимое | zxcv zxcv | ### Генератор событияИмя пользователя, по которому производится фильтрация при подписке. Значение представляется в виде структуры
{"sipuser":"login or number"}.
| | Имя События | Имя события, содержащее класс и тип через точку в формате CLASS\_NAME.TYPE\_NAME | | Тело события | Пересылаемая информация от Аксател на сторону внешней системы в формате JSON | | Переход | Компонент, которому передается управление при успешном завершении. | | Переход,Ошибка | Компонент, на который передается управление, в случае ошибки | | Причина ошибки | Переменная, в которую будет сохранена причина ошибки | | Описание | Описание компонента | ### LDAP-интеграцияНазвание домена, в котором производится операция. Например,
ou=AD-TEST,dc=Siberia,dc=ttt
Выбор охвата для операции поиска. Возможные варианты:
• Базовый объект – Только внутри объекта.
• Только уровень – По указанному уровню списка, то есть без рекурсии.
• Ветвь целиком – По всему дочернему дереву.
| | Атрибуты |Атрибуты для поиска. Например,
objectGUID,cn,telephoneNumber,mobile
Строка поиска в службе каталогов. Подробнее в Поиск LDAP. Например,
present("cn") and present("telephoneNumber") and present("objectGUID") and substrings("mobile",5551234)
present("cn")
present("telephoneNumber")
present("ou")
equalityMatch("sn","Ivanov")
equalityMatch("instanceType","4")
substrings("sn","vano")
substrings(initial,"sn","Iva")
substrings(any,"sn","va","no")
substrings(any,"sn","I","v","a","n","o","v")
substrings(final,"sn","nov")
substrings(initial,"objectGUID",10)
Название объекта, которй необходимо создать. Например,
cn=User,ou=AD-TEST,dc=Siberia,dc=ttt
Атрибуты создания объекта в формате JSON. Например,
{"mobile": \["111 11 11"]}
Название объекта, который необходимо удалить. Например,
cn=User,ou=AD-TEST,dc=Siberia,dc=ttt
Название объекта, который необходимо изменить. Например,
cn=User4,ou=AD-TEST,dc=Siberia,dc=ttt
Атрибуты изменения объекта в формате JSON. Например,
{"mobile": \["111 11 11"]}
Ссылка на объект, у которого необходимо изменить пароль. Например,
cn=User7,ou=AD-TEST,dc=Siberia,dc=ttt
Название объекта, который необходимо изменить. Например,
cn=User7,ou=AD-TEST,dc=Siberia,dc=ttt
Новое имя для объекта. Например,
\`cn=User8'
Название домена, в котором будет распологаться объект. Например,
ou=CITY,dc=NorthWest,dc=ttt
- Разместить – Размещает файл в хранилище.
- Скачать – Возвращает содержимое файла, либо скачивает в локальный каталог и возвращает путь к нему.
- Удалить – Удаляет файл из хранилища.
- Размер – Возвращает размер файла в хранилища.
Определяет способ обмена данными сценария с хранилищем
- Массив байтов – Использует бинарные данные через аргумент или переменную.
- Файл данных – Использует путь к файлу в локальном каталоге.
Определяет тип запуска
- Асинхронный запуск – Сразу после запуска процесса передает управление следующему компоненту.
- Ожидания завершения – Передает управление следующему компоненту только после завершения процесса или таймаута ожидания.
Если выбрать ДА, то все локальные переменные получат стартовые значения (числа - 0, строки - "", даты - 01.01.2000 00:00:00, остальное - "undefined").
Если Нет, то первоначальные значения не будут инициализированы (получат стартовое значение - "undefined").
По-умолчанию = Да
Причина завершения основной ветки выполнения сценария, по возникновению которой в рамках пост-обработки будет выполнена цепочка компонентов, следующих за текущим компонентом СТАРТ. Возможные значения:
- Все – любая причина завершения сценария.
- Корректное завершение – сценарий завершен корректно компонентами, не имеющими веток перехода (Стоп, Переводы и т.д.).
- Нет ветки перехода – не назначено необходимое свойство перехода у компонента основной ветки сценария.
- Внешняя остановка – сценарий принудительно завершен (через API или монитор запрос).
- Ошибка компонента – критическая ошибка выполнения компонента.
- Падение владельца – завершение связанного процесса владельца, например FSM диалога звонка для IVR сценария.
- Лимит числа компонентов – достижение ограничения по количеству выполненных компонентов, установленного для домена.
- Лимит времени выполнения – достижение ограничения по времени выполнения сценария, установленного для домена.
- Да - будет возвращено управление в сценарий, который вызвал текущий.
- Нет - цепочка выполнения сценариев будет завершена. Возврат в родительский сценарий не будет
Время в мс, которое будет выполняться текущий элемент до передачи управления по свойству Переход.
В случае 0 компонент работает в синхронном режиме.
| | Переход | На какой компонент будет переход действия | | Описание | Описание компонента | ### Сравнение- < меньше
- <= меньше или равно
- == равно
- => больше или равно
- > больше
- =/= не равно
* Асинхронный. Будет запущен новый сценарий, в него будут скопированы все текущие переменные и их значения. Текущий сценарий продолжит работы не дожидаясь завершения асинхронного. Переменные текущего сценария не зависят от изменений значений в асинхронном сценарии. В качестве Асинхронного можно запустить только Служебный сценарий.  | **Название** | **Описание** | | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Режим |
- Вложенный - Запускается в том же обработчике, приостанавливая выполнение текущего сценария и передавая вложенному сценарию весь набор переменных и их значений.
После завершения вложенного сценария может быть осуществлен возврат управления на следующий компонент ветки Переход
Допускается каскадная вложенность сценариев глубиной до 100 уровней. - Асинхронный служебный - Запускается новый экземпляр обработчика служебного сценария. Исполнение производится на произвольной Роли SCR текущего сайта. Запущенный сценарий получает весь набор переменных и их значений на вход.
- Из списка - выбор вложенного сценария из списка Сценарии.
- Код сценария - указание кода сценария с помощью аргумента в Код сценария.
Параметр 1
\~
Параметр 5
(только для синхронного режима). Разрешает или запрещает возврат управления из вложенного сценария и продолжение работы по ветке дальше.
- Да - вложенный сценарий вызывается как функция и после его завершения происходит возврат в точку вызова (с учетом значения свойства Возврат управления у компонента Стоп).
- Нет - выполнение текущего сценария прекращается и запускается вложенный сценарий
Компонент, которому передается управление при неудачном запуске сценария.
Среди причин могут быть:
- отсутствие сценария по коду
- отсутствие доступа к доменному центру
- отсутствие роли scr
- превышение допустимых лимитов
- другое
* Дождаться предварительного ответа (1XX). Текущий сценарий ожидает получения SIP ответа 1XX в инициированном звонке
* Дождаться окончательного ответа (2XX-6XX). Текущий сценарий ожидает получения SIP ответа с кодами 2ХХ (удачного завершения попытки вызова) или 4ХХ-6ХХ (неудачного завершения попытки вызова).
* Дождаться остановки IVR. Текущий сценарий ожидает завершения сценария, управляющего исходящим звонком (синхронный режим работы). Обработка исходящего звонка осуществляет другой IVR сценарий. На его вход подаются данные о Номере назначения, Номере источника, Имени источника и дополнительный необходимый параметр (формат json в поле Входящий параметр компонента Старт дочернего IVR сценария).  | **Название** | **Описание** | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Режим |
Свойства вариантов выбора описано выше
- Асинхронный
- Дождаться предварительного ответа (1ХХ)
- Дождаться окончательного ответа (2ХХ-6ХХ)
- Дождаться остановки IVR
Аргумент номера инициатора (Номер А), подставляемый в качестве username в заголовок From отправляемого SIP-запроса INVITE.
Обязателен к указанию. Применяется в процессе маршрутизации звонка.
Аргумент имени (DisplayName) источника звонка
Если значение не указано, то URI не содержит DisplayName.
Выбор правила указания сценария IVR, который будет выступать виртуальным сотрудником от Номера А
- Сценарий IVR - выбор сценария из выпадающего списка.
- Код сценария IVR - необходимо запустить сценарий по указанному коду.
Появляется поле Код сценария - аргумент, в который необходимо передать Код IVR сценария, который будет запущен
Аргумент, содержащий JSON-структуру со списком начальных значений для локальных переменных сценария (упакованный в строку JSON-объект).
Ключи и значения объекта соответствуют именам переменных и их начальным значениям. Таким образом, сопоставление происходит по именам переменных, значения присваиваются только тем переменным, которые определены в запускаемом сценарии.
Установленные таким образом значения приоритетный перед значениями по умолчанию внутри сценария IVR (Поле инициализация компонента Старт.
Выбор охвата для запроса.
- Сайт – Ограничивает выдачу текущим сайтом.
- Система – Возвращает данные по всей системе.
Используется только для Категория = Звонки И Метод = Диаграмма активности
Аргумент, содержащий JSON-структуру описывающую
{
"callid":"...", //CallID звонка, по цепочке которого собрать логи
"mode":"svg | plantuml", //формат выдачи
"file":"true | false" //формат выдачи (файл или ссылка на файл)
}
Выбор домена, в котором проводится операция.
- Сценария – Домен текущего сценария.
- Другой – При выборе этого значения нужно указать название домена.
Аргумент, содержащий логин пользователя в домене.
У пользователя с этим Логином должна быть включена опция "CRUD операция".
Если Выбор домена = Другой, то в обоих доменах должны быть идентичные настройки для логин, пароль, включена опция CRUD операция
Выбор операции.
- Создать – Создание сущности.
- Получить – Получение набора сущностей.
- Обновить – Изменение сущности.
- Удалить – Удаление сущности.
(для Операция = Создать, Обновить, Удалить). Содержит JSON структуру для выбранной Сущности и Операции (например для Удалить должен содержать только
{"id":"id\_element"}
| | Фильтр |(для Операция = Получить). Поисковый запрос для получения данных в JSON структуре в виде
{"id":"some\_id","name":"some\_name"}
| | Сортировка |(для Операция = Получить). Сортировка результата по указанным полям. Задается в JSON структуре в виде массива
\[{"priority":"desc"},{"name":"asc"}]
или
\["priority","name"]
(для Операция = Получить). Указывается какие поля выбранной сущности необходимо получить. Задается в виде списка, например
id,name,ext.title
| | Доп.параметры |Определяет дополнительные режимы выполнения запроса в JSON структуре
- offset - (только для Получить) Определяет сдвиг от нулевой записи в отфильтрованном и отсортированном списке.
- limit - (только для Получить) Максимальное количество выдаваемых записей в отфильтрованном, отсортированном и смещенном списке
- countonly - (только для Получить) Вернет вместо списка записей их количество
- flat - (для всех Операций) Позволяет работать с одноуровневым JSON во всех полях
Выбор операции.
- Добавить – Добавляет метку.
- Удалить – Удаляет метку.
- Изменить – Заменяет метку на новую.
- Очистить – Очищает метку.
- Проверить – Проверяет наличие указанной метки и возвращает 1 или 0.
- Получить – Возвращает метки
- Лог-журнал. Подробнее в Уведомление Лог-журнал
- Уведомление API. Подробнее в Уведомление API
- Сообщение SIP. Подробнее в Уведомление Сообщение SIP
- Авто – Способ уведомления на усмотрение приложения.
- WebKit – Уведомление с помощью WebKit.
- HTML – Уведомление с помощью средств HTML.
- Инфо – Способ уведомления на усмотрение приложения.
- Успех – Уведомление с помощью WebKit.
- Предупреждение – Уведомление с помощью средств HTML.
- Ошибка – Уведомление с помощью средств HTML.
* файл trn в директории /usr/lib/rostell/\_workdir/sg/log/sip/ При необходимости дополнительного логирования рекомендуется использовать Уведомление в режиме Лог журнал Свойства режима Сообщение SIP | **Название** | **Описание** | | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | Сообщение |
SIP Method при отправке сообщения
- NOTIFY
- INFO
- MESSAGE
- Да - использовать SSL протокол
- Нет - не использовать шифрование
- Нет - без перекодирования
- Utf-8
- Utf-16
- Utf-32
- cp-1251
- koi8-r
- Указать название - ввести название кодировки в поле Название кодировки.
- Да - необходимо распарсить письмо и получить Заголовки. В переменную из поля Заголовки в переменную
- Нет - не сохранять (не нужна дополнительная обработка)
- Да - необходимо распарсить письмо и получить MIME-части с Content-Type: text/plain. В переменную из поля Текст в переменную.
- Нет - не сохранять (не нужна дополнительная обработка)
- Да - необходимо распарсить письмо и получить MIME-части с Content-Type: text/html. В переменную из поляе HTML в переменную
- Нет - не сохранять (не нужна дополнительная обработка)
- Да - необходимо распарсить письмо и получить первое тело. В переменную поля Тело(1) в переменную
Будет сохранен текст из первой текстовой части MIME-содержимого письма (text/plain, text/html, …). - Нет - не сохранять (не нужна дополнительная обработка)
- Да - необходимо распарсить письмо и получить исходный текст сообщения. В переменную поля Исходный текст в переменную (MIMIE формат)
- Нет - не сохранять (не нужна дополнительная обработка)
- Да - необходимо распарсить письмо и сохранить прикрепленные файлы. В результате в поле Каталог с вложениями в переенную вернется путь с сохраненными файлами.
- Нет - не сохранять (не нужно сохранение файлов)
- Да - удалять письмо с сервера
- Нет - оставлять письмо на сервере
- Да - использовать SSL протокол
- Нет - не использовать шифрование
Вложение. Добавляется как одна из частей MIME-содержимого в бинарном формате. Может быть выбран в одном из режимов:
- статический файл, приложенный к сценарию
- сформированный путь к файлу
При добавлении первого файла, появляется возможность добавить второй и т.д. Ограничение - 5 файлов.
| | Режим |- Синхронный - компонент передает управление после получения ответа от сервера
- Асинхронный - компонент передает управление сразу по ветке Переход без ожидания ответа от сервера
- Отправка сообщения – Отправляет сообщение другому обработчику сценариев.
- Прием сообщения – Достает из очереди сообщений очередное сообщение от другого обработчика сценариев. В случае, если очередь пуста, встает в ожидание с установленным таймаутом.
- Проверка доступности – Проверяет доступен/существует ли сценарий по данному ID
(для режима = Отправка) Выбор категории отправителя сообщения
- Script
- B2B
- Авто – Сначала производится попытка переключиться в протокол T38, а при отказе удаленной стороны производится переключение в T30.
- T30 – Переключение в T30 и ожидание переключения в T30 удаленной стороны.
- T38 – Переключение в T38, а при отказе удаленной стороны, завершение работы с ошибкой.
- Не сохранять
- С ключом папки – Значение включает категорию папки, относительный путь и имя файла.
- Только имя файла – Значение содержит только имя файла.
- Авто – Сначала производится попытка переключиться в протокол T38, а при отказе удаленной стороны производится переключение в T30.
- T30 – Переключение в T30 и ожидание переключения в T30 удаленной стороны.
- T38 – Переключение в T38, а при отказе удаленной стороны, завершение работы с ошибкой.
Файл для отправки факсимильным сообщением. Может быть выбран в одном из режимов:
- статический файл, приложенный к сценарию
- сформированный аргументами путь к файлу
Формат файла: tiff – одностраничное или многостраничное битовое изображение.Отправка сообщения осуществляется сервером с ролью MG, обслуживающим текущий звонок на сайте, где выполняется сценарий.
| | Переход | Компонент, которому передается управление при корректной отправки факса. Переход по-умолчанию. | | Переход, время | Компонент, которому передается управление в случае, если за отведенное время компонент не завершил свою работу | | Переход, ошибка | Компонет, которому передается управление в случае, если возникла ошибка отправки факса | | Описание | Текст | ## # Блок Телефония ### Воспроизведение- Да-значение переменной Буфер для DTMF будет очищен перед выполнением текущего компонента
- Нет-полученные DTMF символы будут дописаны в конец переменной Буфер для DTMF
Файл для воспроизведения.Может быть выбран в одном из режимов:
- статический файл, приложенный к сценарию;
- сформированный аргументами путь к файлу или каталогу.
Файл для воспроизведения.Может быть выбран в одном из режимов:
- статический файл, приложенный к сценарию;
- сформированный аргументами путь к файлу или каталогу.
Файл для воспроизведения.Может быть выбран в одном из режимов:
- статический файл, приложенный к сценарию;
- сформированный аргументами путь к файлу или каталогу.
Файл для воспроизведения.Может быть выбран в одном из режимов:
- статический файл, приложенный к сценарию;
- сформированный аргументами путь к файлу или каталогу.
Выбор языкового алгоритма. Возможные варианты:
- RUS - Русский язык. (123 звучит как "Сто Двадцать Три")
- ENG – Английский язык. (123 звучит как "One Hundred and Twenty Three")
(формат = «По формату», «Количество», «Порядковое числительное»)
- Мужской (один, сто пятый)
- Женский (одна, сто шестая)
- Средний (одно, сто седьмое)
Выбор формата построения фразы по значению. Возможные способы разбиения (значение поля Тип проигрывания
- Посимвольно – Каждая цифра числа проговаривается отдельно.(один ноль два три семь…)
- По 2 символа – Цифры объединяются парами(двадцать два сорок четыре…)
- По 3 символа – Цифры объединяются в группы по три (триста пять двести тридцать четыре…)
- Целиком – Число проговаривается целиком. (Двести тридцать четыре триллиона пятьсот двадцать…)
- Буквы и числа посимвольно – Значение проговаривается в виде отдельных букв (аббревиатур) и чисел.(один а б в тире слэш.. )
- Слова и фразы – Проговариваются отдельные слова, разделенные пробелами, заранее озвученные и представленные в каталоге озвучки.
- Да - значение переменной Буфер для DTMF будет очищен перед выполнением текущего компонента
- Нет - полученные DTMF символы будут дописаны в конец переменной Буфер для DTMF
- Да - удалит символы прерывания из переменной Буфер для DTMF
- Нет- не удалит символы прерывания из переменной Буфер для DTMF
Выбор режима записи. Доступен единственный вариант
- Синхронная запись
- Да - путь к записанному файлу необходимо сохранить в переменную
- Нет - путь сохранять не надо
Переменная для сохранения пути к файлу с записанным голосом. Файл размещается во временном каталоге сценария и будет удален после завершения работы сценария. Для длительного сохранения файла требуется дальнейшее перемещение файла сценарием в место стационарного хранения.
Запись осуществляется на сервере с ролью MG, обслуживающим текущий звонок, а затем переносится на сервер с ролью IVR, обслуживающей текущий сценарий.
| | Кодек |Формат записываемого файла.
- PCM
- PCMa
- PCMu
- GSM
- MP3 8-bit
- MP3 16-bit
- MP3 24-bit
- Да - значение переменной Буфер для DTMF будет очищен перед выполнением текущего компонента
- Нет - полученные DTMF символы будут дописаны в конец переменной Буфер для DTMF
- Да - удалит символы прерывания из переменной Буфер для DTMF
- Нет- не удалит символы прерывания из переменной Буфер для DTMF
Выбор режима предварительного преобразования медиа-сессии текущего диалога перед отправкой SIP-запроса REFER. Возможные варианты:
- Не использовать – Не производит преобразования.
- Авто – По текущим настройкам системы аналогично режиму inactive.
- sendonly – Переводит медиа-сессию в режим удержания путем отправки re-INVITE с SDP, где у медиа-стримов выставлен атрибут a=sendonly.
- inactive – Переводит медиа-сессию в режим удержания путем отправки re-INVITE с SDP, где у медиа-стримов выставлен атрибут a=inactive (не соответствует RFC-6337 п.5.3.).
Вызов абонента может быть осуществлен с любыми параметрами, в том числе и без последующего выполнения IVR-сценария. После успешного завершения операции выполнение основной ветки сценария прерывается. На любом шаге процесса может произойти плановый отказ, тогда управление передается следующему компоненту по соответствующей ветке перехода. Компонент выполняется до момента получения Notify сообщения об установке соединения или ошибки (например, вызываемый абонент не снял трубку). Общее время процесса перевода складывается из времени ответа на REFER, набора указанного номера и ожидания ответа. Суммарно ограничено 60 секунд (при наступлении сработает Переход, время подписки При переводе используется стандартный процесс маршрутизации от имени текущего сценария IVR.  Перевод с сопровождением | **Название** | **Описание** | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Номер | Номер назначения | | Исходящий номер | Аргумент, содержащий CallerId – значение username для подстановки в URI заголовка From отправляемого SIP-запроса INVITE. | | Исходящее имя | Аргумент, содержащий CallerName – значение displayname для подстановки в URI заголовка From отправляемого SIP-запроса INVITE. | | Время набора, сек | Максимальное время от начала набора до получения SIP 200 OK | | Источник сценария |
Способ выбора IVR-сценария. Возможные значения:
- Не использовать – Не использовать сценарий, только осуществить дозвон, проконтролировать ответ и переключить.
- Из списка – Выбор сценария в поле Сценарий. Применяет значение свойства Сценарий.
- По коду – Указание кода сценария с помощью аргумента в поле Код сценария. Применяет значение свойства Код сценария.
Выбор режима предварительного преобразования медиасессии текущего диалога перед отправкой SIP-запроса REFER.
- Не использовать – Не производит преобразования.
- Авто – По текущим настройкам системы аналогично режиму inactive.
- sendonly – Переводит медиа-сессию в режим удержания путем отправки re-INVITE с SDP, где у медиастримов выставлен атрибут a=sendonly.
- inactive – Переводит медиа-сессию в режим удержания путем отправки re-INVITE с SDP, где у медиастримов выставлен атрибут a=inactive (не соответствует RFC-6337 п.5.3.).
Переменная для сохранения кода внутренней ошибки. Возможные варианты:
"001" – Ошибка инициации вызова.
"002" – Неудача вызова.
Режим работы компонента после получения ответа от сервиса TTS Yandex Cloud SpeechKit.
• Воспроизведение – Воспроизведение синтезированной речи абоненту с последующим удалением файла.
• Генерация файла – Сохранение аудио-файла в локальный временный каталог и возврат пути к файлу в переменную.
| | Текст | Текст, подлежащий синтезу и последующему воспроизведению. | | Язык |Параметр сервиса TTS Yandex Cloud SpeechKit: язык синтеза.
- ru-RU – Русский язык
- en-US – Английский язык
Параметр сервиса TTS Yandex Cloud SpeechKit: голос синтезируемой речи.
- Alyss (ж)
- Jane (ж)
- Oksana (ж)
- Omazh (ж)
- Zahar (м)
- Ermil (м)
- Другой – Указание произвольного голоса через аргумент в поле Другой голос.
Параметр сервиса TTS Yandex Cloud SpeechKit: эмоциональный эффект синтезируемой речи.
- Good
- Evil
- Neutral
- Да - значение переменной Буфер для DTMF будет очищен перед выполнением текущего компонента
- Нет - полученные DTMF символы будут дописаны в конец переменной Буфер для DTMF
Параметр сервиса распознавания Yandex Cloud SpeechKit: тема распознавания. Возможные варианты:
- general - общая тема
- maps - адреса
- dates - даты
- names - имена и названия
- numbers - числа
- Другая – Указание произвольной темы через аргумент в поле Пользовательская тема.
Параметр сервиса распознавания Yandex Cloud SpeechKit: язык распознавания. Возможные варианты:
- ru-RU – Русский язык
- en-US – Английский язык
- Да - значение переменной Буфер для DTMF будет очищен перед выполнением текущего компонента
- Нет - полученные DTMF символы будут дописаны в конец переменной Буфер для DTMF
Звуковой файл предварительного воспроизведения абоненту, во время которого также активирован голосовой детектор. При отсутствии голоса от абонента (с учетом шумового порога VAD-детектора), отправка данных на сервис распознавания не производится. Может быть выбран в одном из режимов:
\* статический файл, приложенный к сценарию \* сформированный аргументами путь, который должен включать одну из файловых категорий.
При обнаружении голосоа со стороны абонента воспроизведение останавливается
| | Переход | Компонент, которому передается упраление в случае успешного завершения операции. Переход по-умолчанию | | Переход, время | Компонент, которому передается управление в случае истечения времени ожидания HTTP-ответа от сервиса распознавания. | | Переход, ошибка | Компонент, которому передается управление в случае возникновения ошибки. | | Описание | Описание компонента | ### Управление голосовой почтой* Прослушанные. В этой папке хранятся прослушанные записи, к которым абонент всегда может обратиться. Файлы автоматически удаляются из папки Новые, если они не были прослушаны в течении 3-х месяцев. У компонента есть несколько режимов работы: * Положить сообщение. Размещает новое записанное сообщение в указанный почтовый ящик
* Получить количество сообщений. Результат - количество новых и прослушанных сообщений
* Достать сообщение по индексу. Получение пути до файла записи и ID сообщения по его индексу. Индекс - порядковый номер сообщения в папке ящика, где 1 - самое старое.
* Достать новое сообщение. Получение ссылка на запись и ID самого нового сообщения в папке Новые или Прослушанные.
* Достать старое сообщение. Получение ссылка на запись и ID самого старого сообщения в папке Новые или Прослушанные.
* Достать следующее сообщение. Позволяет получить более новое или более старое сообщение относительно текущего индекса. Также возвращает ссылку на него.
* Переместить в прослушанные. Переместить текущее сообщение в папку Прослушанные.
* Удалить сообщение. Удалить текущее сообщение из голосовой почты.
* Очистить ящик. Очищает все сообщения в папке Новые или Прослушанные. #### Общие свойства: | **Название** | **Описание** | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Операция |
- Положить сообщение.
- Получить количество сообщений.
- Достать сообщение по индексу.
- Достать новое сообщение.
- Достать старое сообщение.
- Достать следующее сообщение.
- Переместить в прослушанные.
- Удалить сообщение.
- Очистить ящик
Выбор папки, с которой необходимо работать. Две папки в каждом ящике
- Новые.
- Прослушанные.
Выбор папки, с которой необходимо работать. Две папки в каждом ящике
- Новые.
- Прослушанные.
Выбор папки, с которой необходимо работать. Две папки в каждом ящике
- Новые.
- Прослушанные.
Выбор папки, с которой необходимо работать. Две папки в каждом ящике
- Новые.
- Прослушанные.
- Новее. Получаем данные по более новому сообщению относительно текущего ID
- Старее. Получаем данные по предыдущему сообщению относительно текущего ID
Выбор папки, с которой необходимо работать. Две папки в каждом ящике
- Новые.
- Прослушанные.
Выбор папки, с которой необходимо работать. Две папки в каждом ящике
- Новые.
- Прослушанные.
- Разместить на парковке – Осуществляет размещение на указанный номер парковки и дальнейший переход (ветка Переход при успешном размещении или ветка Переход, занято если место не свободно).
- Взять с парковки – Осуществляет взятие абонента с указанного парковочного места. Если место было занято, то происходит соединение звонящего в парковку и припаркованного абонента и прерывание текущего сценария. Если место свободно, то переход по ошибке (Переход, не найдено).
Аргумент, содержащий номер парковки, с которым связана текущая операция.
Операция размещения может быть успешно проведена только если парковочное место свободно.
Отображает информацию по сработавшим маршрутам.  С помощью кнопки **Перейти к маршрутам** дает возможность сделать прямую выборку в разделе маршруты для анализа частоты/количества срабатываний определенного маршрута или вектора. ### Экспорт таблицы в CSV Нажмите на кнопку **Экспорт в CSV** для сохранения таблицы успешных звонков за все время.  После того как таблица будет сформирована, начнется автоматическое скачивание файла **error-calls\_data\_table.csv** # Маршруты звонков ## Просмотр использованных маршрутов После входа в раздел **Маршруты звонков** отображается информация по сработавшим маршрутам успешных / неуспешных звонков.  ### Описание полей таблицы маршруты звонков: * id — Идентификатор звонка * time — Время срабатывание правила * vectorecode — Код вектора из настроек crud-объекта (код сработавшего вектора) * ruleid — Ссылка на vectorrule (id сработавшего правила) * action — Действие по правилу. Возможные значения: * internal - Внутренний абонент * internalpbx - Абонент за сторонней IP-АТС * crossdomain - В другой КД * external - Внешняя линия * featurecode - Код абонентских функций * denied - Запретить * routedomain — Домен, в котором сработал текущий маршрут * sipoperatorcode — Код оператора из provider если действие = outer * featurecodeid — Ссылка на запись в crud-объекте featurecode. Идентификатор записи в объекте Коды абонентских функций. * featurecodetype — Тип КАФ. Возможные значения: * ivr - Сценарий IVR * conference - Конференция * pickup - Перехват звонка * grouppickup - Перехват звонка по групповым номерам * voicemail - Голосовая почта * parking - Парковка * parking\_get - Взятие с парковки * intercom - Интерком * barge - Вторжение * voicemail\_send - Отправка голосовой почты. * featurecodenumber — Номер после КАФ. Номер, который остался после преобразования через таблицу featurecode * storagesite — Название сайта ### Описание доступных фильтров Для раскрытия полного списка фильтров нажмите кнопку "Еще".  * Время срабатывания правила - временной интервал фильтра * Действие - одно из действий action (см. выше) * Код оператора SIP - код провайдера, если звонок был отправлен на внешнюю линию * КД маршрута - коммуникационный домен, в котором был выполнен маршрут * Код вектора - код использованного вектора * Тип КАФ - один из кодов абонентских функций featurecodetype (см.выше) * Номер после КАФ - номер, который использовался в качестве аргумента при вызове КАФ * ID звонка - идентификатор звонка * ID маршрута - идентификатор маршрута * ID КАФ - идентификатор кода абонентских функций ### Детальный просмотр информации о звонке Для детального просмотра информации о звонке дважды кликните по любой строке нужного звонка. В окне содержится полная информация по маршруту, по которому успешный/ не успешный звонок прошел.  ### Экспорт таблицы в CSV Нажмите на кнопку **Экспорт в CSV** для сохранения таблицы успешных звонков за все время.  После того как таблица будет сформирована, начнется автоматическое скачивание файла routes\_data\_table.csv # История вызова Б ## Просмотр вызовов форков номеров Раздел **История вызова Б** отображает информацию по попыткам вызова стороны Б (forking).  ### Описание полей таблицы "История вызова Б": * id — Идентификатор звонка * connecttousername — Номер абонента Б * connecttotd — КД, в котором находится абонент Б * connecttoipport — Сетевой адрес номера Б * todirection — Местонахождение номера Б (Внешняя/ внутренняя линия) * sipoperatorcode — Код оператора SIP, если местонахождение = outer * preanswered — Получен предварительный ответ (18X). Возможные значение true - Да / false - Нет * answered — Получен ответ (200). Возможные значение true - Да / false - Нет * time — Время когда был отправлен Invite на сторону Б по текущему форку * preansweredtime — Дата/Время получения предварительного ответа * answeredtime — Дата/Время получения ответа (200) * sipcode — SIP Код в финальном ответе на сторону А о причине невозможности вызова набранного номера * reason — Причина. Текстовое описание причины невозможности вызова набранного номера. Этот текст также отправлен в SIP пакете инициатору. * storagesite — Название сайта ### Описание доступных фильтров Для раскрытия полного списка фильтров нажмите кнопку "Еще".  * Время вызова - временной интервал фильтра * Сетевой адрес Б - IP адрес форка стороны Б * Код оператора SIP - код оператора SIP, в случае * Получен предварительный ответ (18X) - введите true, для вывода звонков, в которых был получен ответ 18X, false - для тех, где этот ответ получен не был * Получен ответ (200) - введите true, для вывода звонков, в которых был получен ответ 200, false - для тех, где этот ответ получен не был * SIP код ответа - код SIP-ответа * SIP Reason - значение SIP-ответа * ID звонка - идентификатор звонка ### Детальный просмотр информации о звонке Для детального просмотра информации о звонке дважды кликните по любой строке нужного звонка. В окне содержится полная информация по истории вызова абонента Б.  ### Экспорт таблицы в CSV Нажмите на кнопку **Экспорт в CSV** для сохранения таблицы успешных звонков за все время.  После того как таблица будет сформирована, начнется автоматическое скачивание файла side-b\_data\_table.csv # ПР: Мониторинг содержит информацию по мониторингу Аксател из рабочего коммуникационного домена ## Мониторинг коммуникационного домена  Осуществляется мониторинг домена, текущего состояния объектов и пользователей, разговоров а также сценариев. Имеет возможность сбора необходимых лог-файлов. Основные предназначения: * отслеживание текущего состояния различных сущностей * сбор необходимых логов по звонкам и сценариям * моделирование работы маршрутизации и нормализации * возможность остановки выполнения служебных сценариев\\
## Рабочее окно Монитора
 Общий вид раздела Запрос к мониторингу формируется из заполнения полей: 1\. Объект. Выбирается из списка доступных объектов 2\. Метод. Выбирается из списка доступных методов для выбранного объекта. Если у Объекта один метод, то он выбирается автоматически 3\. Дополнительные поля для метода. Большинство полей являются опциональными. Если поле обязательное и не заполнено, то система не позволит получить данные и выдаст ошибку. Для выполнения запроса необходимо нажать по кнопке . По выполнению в основном окне сформируется результат запроса или будет предложено сохранить сформированный файл (для получения логов).\ Доступные форматы просмотра результата: * JSON * Список * Таблица * Формированная таблица ### Формат результата в JSON Результат запроса выводится в виде структурированной JSON структуры  В структуру JSON возможно вносить изменения (в любом месте Результата можно кликнуть и внести текст). Кнопка  позволяет "восстановить" структуру - убрать комментарии, незначащие символы, исправить кавычки, встроить объекты JavaScript ### Формат результата в списке Результат запроса выводится в виде массива данных  Кнопки  и  в правом верхнем углу позволяют развернуть и свернуть сформированный список ### Формат результата в таблице Результат запроса выводится в виде таблицы данных  Таблица строится на базе сформированного списка и может содержать объединяющие ячейки в строках и столбцах. ### Формат результата в формированной таблице Результат запроса выводится в виде таблицы данных без объединяющих ячеек. Позволяет copy/paste данные напрямую в другие приложения, работающие с таблицами (например, MS Excel). Позволяет посмотреть состояние объектов и событий в реальном времени для коммуникационного домена. # Трассировка звонков и сценариев Данный объект предназначен для сбора логов по звонкам и сценариям.\ Для звонков возможен сбор логов в форматах SVG, PlantUML, ZIP архив. Сбор логов осуществляется по любому звонку, последний SIP пакет в котором был менее 10 минут назад. Система автоматически включает в выборку все связанные звонки (правое/левое плечо, переводы и т.д.) ## Метод calls Данные отображаются по всем звонкам (активным и завершенным), в рамках которых **за последние 10 минут** были SIP пакеты. Это основной метод получения информации по звонкам от системы, вне зависимости от того, был звонок успешным (разговор абонента А с абонентом B состоялся) или неуспешным.  В ответе выводятся данные по каждой ноде, которая обслуживает звонок. Основные ключи Результата: | **Название** | **Описание** | | ----------------------- | --------------------------------------------------------------------------------- | | srvidx | Идентификатор роли (roleid). | | role | Тип роли. | | node | Нода на которой запущена роль. | | addr | Адрес ноды. | | online | Доступность ноды для сбора статистики. | | calls | Плечи звонков обслуживаемые ролью. | | calls.callid | callid стороны А. Поле часто используется для последующего сбора логов по звонку. | | calls.from | uri стороны А | | calls.remoteip | Адрес стороны Б. | | calls.tick | Timestamp (в мс) получения запроса. | | calls.time | Время получения запроса. | | calls.to | uri стороны Б. | | calls.media | Данные об использовании медиа. | | calls.media.mgc | Ключ роли mgc обслуживающей стороны звонка | | calls.media.mgc\_srvidx | Идентификатор роли (roleid) mgc. | | calls.media.mgc\_node | Нода mgc. | | calls.media.mg | Ключ используемой роли mg. | | calls.media.msid | Идентификатор sip-владельца медиа. | | calls.media.ctx | Номер контекста. | ## Метод trn Собирает все SIP пакеты по звонку (все форки и плечи звонка).\ Основной метод получения лог-файлов по звонкам от системы.\ Результат может быть выведен в: * zip архив * визуальную диаграмму uml (SVG файл) * uml файл (plantUml файл)  | **Название** | **Описание** | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Сallid для сбора логов | callid по которому происходит поиск соответствий trn | | Список CallID для которых собрать логи | список callid по которому происходит поиск соответствий и сбор trn-логов всех звонков | | Формат ответа |
- SVG диаграмма – страница содержащая plantuml диаграмма в формате svg.
- файл в формате plantuml - текстовый файл формата UML для дальнейшего построения диаграммы
- zip-архив trn-логов - сбор файлов лога, упаковка в zip-архив и загрузка в браузер.
Тип сценария по которому необходимо собрать логи.
Возможные значения:
- IVR - сбор логов по IVR сценариям
- SVC - сбор логов по SVC сценариям
Продолжительность лога для сборки в минутах.
Возможные значения от 1 до 1440.
Код сценария по которому необходимо собрать логи.
Если не указан, то сбор по всем сценариям указанного типа
Направление источника звонка. Возможен выбор источника звонка из 2-х вариантов:
- Внутренний абонент - инициатор звонка является абонентом домена
- Внешняя линия - звонок пришел в Аксател через Оператора SIP телефонии
Имя пользователя (логин) или номер источника звонка (абонента А).
- Для Направление источника = Внутренний абонент система определит sipuser, кто инициировал звонок.
- Для Направление источника = Внешняя линия, система возьмет за номер источника, который пришел в Invite.
Выбор источника звонка из 2-х вариантов:
- Внутренний абонент - инициатор звонка является абонентом домена Аксател
- Внешняя линия - звонок пришел в Аксател через Оператора SIP телефонии
Имя пользователя (логин) или номер источника (абонента А).
- Для Направление источника = Внутренний абонент система определит sipuser, кто инициировал звонок.
- Для Направление источника = Внешняя линия, система возьмет за номер источника, который пришел в Invite.
Режим отображения. Возможные значения:
- active - текущие состояния объектов в домене(по умолчанию).
- count - количество резервированных состояний.
Домен, в котором будет выполнен запрос.
Применяется если вход выполнен в Мастер-Домене, а получить данные надо по-одному из рабочих КД.
| Основные поля в ответе: **username** - имя пользователя учетной записи SIP\ **state** - текущее состояние учетной записи SIP ### Метод details Отображает информацию по одному пользователю.  | **Название** | **Описание** | | ------------------------ | ------------------------------------------------------- | | Название Домена | Домен, в котором будет выполнен запрос | | Номер или Логин абонента | Номер или логин, по которому необходимо получить данные | # Активные регистрации SIP-устройств Данный объект отображает статистику по регистрациям учетных записей SIP и предоставляет возможность удалить (сбросить) определенную регистрацию. ### Метод active Отображает учетные записи SIP, которые в данный момент зарегистрированы в запрашиваемом КД.  | **Название** | **Описание** | | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Название Домена |Домен, в котором будет выполнен запрос.
Применяется если произведен вход в Мастер-Домен, а сбросить регистрацию надо в каком-то дочернем КД.
Либо если вход в КД, а получить данные надо по одному из его дочерних КД.
| Основные поля в ответе: • **username** - имя пользователя учетной записи SIP • **addr** - IP-адрес SIP-клиента, если SIP-клиент за NAT, то отображается локальный внутренний адрес. • **expires** - время до момента перерегистрации • **path.domain** - IP-адрес SG • **path.port** - порт назначения, который использует SG для приема пакетов • **path.proto** - внутренний транспортный протокол между SG и B2BUA, всегда = TCP • **path.user** - внутренний идентификатор учетной записи SIP • **port** - исходящий порт, с которого SIP-клиент отправляет пакеты • **proto** - транспортный протокол, используемый между SIP-клиентом и SG ### Метод unregistered Позволяет отобразить все незарегистрированные учетные записи по КД. Если в запросе не указан desttd, то domain = домен,в котором делается запрос. Если desttd указан, то значение подставляется в поле domain  | **Название** | **Описание** | | --------------- | --------------------------------------------------------------------------------------------------------------------------------- | | Название Домена | Домен, в котором будет выполнен запрос. Применяется если вход в Мастер-Домен, а сбросить регистрацию надо в каком-то дочернем КД. | Основные поля в ответе: * **sipusers: username** - имя пользователя учетной записи, которая в данный момент не зарегистрирована в КД. ### Метод count Отображает количество всех зарегистрированных учетных записей у запрашиваемого КД и всех его дочерних доменов.  | **Название** | **Описание** | | --------------- | --------------------------------------------------------------------------------------------------------------------------------- | | Название Домена | Домен, в котором будет выполнен запрос. Применяется если вход в Мастер-Домен, а сбросить регистрацию надо в каком-то дочернем КД. | Основные поля в ответе: * **total** - общее количество зарегистрированных учетных записей SIP * **domains** - распределение регистраций по доменам ### Метод delete Позволяет удалить все регистрации конкретной учетной записи SIP user\@domain или определенные регистрации пользователя udp:192.168.10.18:5062 у user\@domain Если в запросе не указан desttd, то domain = домен,в котором делается запрос.\ Если desttd указан, то значение подставляется в поле domain  | **Название** | **Описание** | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Название Домена |Домен, в котором будет выполнен запрос.
Применяется если произведен вход в Мастер-Домен, а сбросить регистрацию надо в каком-то дочернем КД.
Режим отображения. Возможные значения:
- active - текущие подписки на состояния в домене (по умолчанию)
- count - количество активных подписок
Домен, в котором будет выполнен запрос.
Применяется если вход выполнен в Мастер-Домене, а получить данные надо по одному из рабочих КД.
Тип сценария для удаления. Возможные варианты:
- SVC
- ICR
Показывать количество использованных лицензий в домене. Возможные значения:
- Нет
- Да
Показывать количество использованных лицензий в поддоменах. Возможные значения:
- Нет
- Да
Нажмите на кнопку **Сохранить** для сохранения настроек. # О качестве связи # О переводах звонков # SIP ответы и их значения Определено шесть типов ответов, несущих разную функциональную нагрузку.\ Тип ответа кодируется трехзначным числом. Самой важной является первая цифра, которая определяет класс ответа, остальные две цифры лишь дополняют первую. Все ответы делятся на две группы: **информационные** и **финальные**.\ \ Информационные ответы показывают, что запрос находится в стадии обработки. \ Они кодируются трехзначным числом, начинающимся с единицы, - 1хх.\ \ Финальные ответы кодируются трехзначными числами, начинающимися с цифр 2, 3, 4, 5 и 6. Они означают завершение обработки запроса и содержат, когда это нужно, результат обработки запроса. ### 1xx = информационные ответы SIP/2.0 100 Trying - запрос обрабатывается\ SIP/2.0 180 Ringing - местоположение вызываемого пользователя определено. Выдан сигнал о входящем вызове\ SIP/2.0 181 Call is Being Forwarded - прокси,сервер переадресует вызов к другому пользователю\ SIP/2.0 182 Call is Queued - вызываемый абонент временно не доступен, вызов поставлен в очередь\ SIP/2.0 183 Session Progress - используется для того, чтобы заранее получить описание сеанса информационного обмена от шлюзов на пути к вызываемому пользователю ### 2xx = ответы о завершении запроса SIP/2.0 200 OK - успешное завершение\ SIP/2.0 202 Accepted - запрос принят для обработки Используется для справки о состоянии обработки ### 3xx = сообщения о переадресации SIP/2.0 300 Multiple Choices - указывает несколько SIP-адресов, по которым можно найти вызываемого пользователя\ SIP/2.0 301 Moved Permanently - вызываемый пользователь больше не находится по адресу, указанному в запросе\ SIP/2.0 302 Moved Temporarily - пользователь временно сменил местоположение\ SIP/2.0 305 Use Proxy - вызываемый пользователь не доступен непосредственно, входящий вызов должен пройти через прокси-сервер\ SIP/2.0 380 Alternative Service - запрошенная услуга недоступна, но доступны альтернативные услуги ### 4xx = невозможность обработать запрос SIP/2.0 400 Bad Request - запрос не понят из-за синтаксических ошибок в нем, ошибка в сигнализации, скорее всего что-то с настройками оборудования\ SIP/2.0 401 Unauthorized - нормальный ответ сервера о том, что пользователь еще не авторизировался; обычно после этого абонентское оборудование отправляет на сервер новый запрос, содержащий логин и пароль\ SIP/2.0 401 Expired Authorization - время регистрации истекло\ SIP/2.0 402 Payment Required - требуется оплата (зарезервирован для использования в будущем)\ SIP/2.0 403 No Such User - нет такого пользователя, ошибка в номере, логине или пароле\ SIP/2.0 403 User Disabled - пользователь отключен\ SIP/2.0 403 Wrong Guess - ошибка в пароле\ SIP/2.0 403 Conflict - такой SIP-номер уже используется\ SIP/2.0 403 Forbidden - абонент не зарегистрирован\ SIP/2.0 403 Empty Route Set - нет ни одного шлюза в роутинге\ SIP/2.0 403 Caller Not Registered - нет такого пользователя\ SIP/2.0 403 Out of Look-Ahead Retries - перебор узлов закончен\ SIP/2.0 403 Invalid Phone Number - нет такого направления\ SIP/2.0 403 No Money Left on RFC Account - на счету нет денег для совершения звонка\ SIP/2.0 404 Not found - вызываемый абонент не найден, нет такого SIP-номера\ SIP/2.0 404 Undefined Reason - неопределенное направление\ SIP/2.0 404 Unknown user account - логин и пароль не найдены\ SIP/2.0 404 Out of Order - в заявке на маршрутизацию по этому направлению нет ни одного шлюза, проверьте настройку маршрутизации по этому направлению.\ SIP/2.0 405 Method Not Allowed - метод не поддерживается, может возникать если пользователь пытается отправлять голосовую почту и т.п.\ SIP/2.0 406 No codecs match - неправильная конфигурация кодеков\ SIP/2.0 406 Not Acceptable - пользователь не доступен\ SIP/2.0 407 Proxy Authentication Required - необходима аутентификация на прокси-сервере\ SIP/2.0 408 Request Timeout - время обработки запроса истекло: Абонента не удалось найти за отведенное время\ SIP/2.0 408 Login timed out - за отведенное время не получен ответ от сервера на запрос авторизации\ SIP/2.0 410 No Route - вариант \ SIP/2.0 403 Empty Route Set; нет доступа к ресурсу: Ресурс по указанному адресу больше не существует\ SIP/2.0 413 Request Entity Too Large - размер запроса слишком велик для обработки на сервере\ SIP/2.0 415 No Media - звонок совершается неподдерживаемым кодеком\ SIP/2.0 416 Unsupported Scheme - сервер не может обработать запрос из-за того, что схема адреса получателя ему непонятна\ SIP/2.0 420 Bad extension - неизвестное расширение: Сервер не понял расширение протокола SIP\ SIP/2.0 421 Extension Required - в заголовке запроса не указано, какое расширение сервер должен применить для его обработки\ SIP/2.0 423 Interval Too Brief - сервер отклоняет запрос, так как время действия ресурса короткое\ SIP/2.0 480 Invalid Phone Number - неправильный номер телефона, не соответствует к-во цифр или неправильный код страны или города\ SIP/2.0 480 Destination Not Found In Client Plan - направления нет в тарифном плане абонента\ SIP/2.0 480 Wrong DB Response - проблемы с центральной базой сети\ SIP/2.0 480 DB Timeout - проблемы с центральной базой сети\ SIP/2.0 480 Database Error - проблемы с центральной базой сети\ SIP/2.0 480 Codec Mismatch - несоответствие кодеков\ SIP/2.0 480 No Money Left on RFC Account - нет денег на счету, обратитесь к администратору сети!!!\ SIP/2.0 480 Empty Route Set - пустое направление, нет принемающих шлюзов\ SIP/2.0 480 No money left - недостаточно денег на счете\ SIP/2.0 480 Temporarily Unavailable - временно недоступное направление попробуйте позвонить позже\ SIP/2.0 481 Call Leg/Transaction Does Not Exist - действие не выполнено, нормальный ответ при поступлении дублирующего пакета\ SIP/2.0 482 Loop Detected - обнаружен замкнутый маршрут передачи запроса\ SIP/2.0 483 Too Many Hops - запрос на своем пути прошел через большее число прокси-серверов, чем разрешено\ SIP/2.0 484 Address Incomplete - принят запрос с неполным адресом\ SIP/2.0 485 Ambiguous - адрес вызываемого пользователя не однозначен\ SIP/2.0 486 Busy Here - абонент занят\ SIP/2.0 487 Request Terminated - запрос отменен, обычно приходит при отмене вызова\ SIP/2.0 488 Codec Mismatch - нет шлюзов с поддержкой заказанного кодека\ SIP/2.0 488 Private IP Address - адрес RTP media из сетей RFC1918\ SIP/2.0 491 Request Pending - запрос поступил в то время, когда сервер еще не закончил обработку другого запроса, относящегося к тому же диалогу\ SIP/2.0 493 Undeciperable - сервер не в состоянии подобрать ключ дешифрования: невозможно декодировать тело S/MIME сообщения\ SIP/2.0 499 Codec Mismatch - отсутствует кодек ### 5xx = ошибки сервера SIP/2.0 500 Internal Server Error - внутренняя ошибка сервера\ SIP/2.0 500 DB Timeout - нет ответа от базы данных\ SIP/2.0 500 Database Error - то же самое, но в другой момент\ SIP/2.0 500 Wrong DB Response - неправильный ответ базы данных, редкая ошибка\ SIP/2.0 500 Undefined Reason - неопределенная причина\ SIP/2.0 500 account has been moved to a remote system - аккаунт перенесен в удаленную систему (дословно)\ SIP/2.0 501 Method Not Supported Here - в сервере не реализованы какие-либо функции, необходимые для обслуживания запроса: Метод запроса SIP не поддерживается\ SIP/2.0 502 Bad Gateway - сервер, функционирующий в качестве шлюза или прокси-сервера, принимает некорректный ответ от сервера, к которому он направил запрос\ SIP/2.0 503 Service Unavailable - сервер не может в данный момент обслужить вызов вследствие перегрузки или проведения технического обслуживания\ SIP/2.0 504 Server time-out - сервер не получил ответа в течение установленного промежутка времени от сервера, к которому он обратился для завершения вызова\ SIP/2.0 505 SIP Version not supported - версия не поддерживается: Сервер не поддерживает эту версию протокола SIP\ SIP/2.0 513 Message too big - сервер не в состоянии обработать запрос из-за большой длины сообщения ### 6xx = глобальная ошибка SIP/2.0 600 Busy everywhere - вызываемый пользователь занят и не желает принимать вызов в данный момент\ SIP/2.0 603 Decline - вызываемый пользователь не желает принимать входящие вызовы, не указывая причину отказа\ SIP/2.0 604 Does Not Exist Anywhere - вызываемого пользователя не существует\ SIP/2.0 606 Not Acceptable - соединение с сервером было установлено, но отдельные параметры, такие как тип запрашиваемой информации, полоса пропускания, вид адресации не доступны # Список изменений # Ролевые приложения Ролевое приложение представляет собой Web-приложение, которое загружается в домен Аксател. Права доступа пользователей определяются ролевыми политиками безопасности в рамках Домена. {% content-ref url="/pages/-MGK8TxSHaT5gXzzsItf" %} [Создание ролевого приложения](/razrabotchikam/sozdanie-rolevogo-prilozheniya) {% endcontent-ref %} {% content-ref url="/pages/-MGKXlin4dyNJtSvcr1h" %} [Установка ролевых приложений](/razrabotchikam/ustanovka-rolevykh-prilozhenii) {% endcontent-ref %} {% content-ref url="/pages/-MGrY0KIE\_Gez0UsSf\_I" %} [Канал статистики](/razrabotchikam/untitled) {% endcontent-ref %} # Создание ролевого приложения в статье содержится инструкция и пример по созданию Ролевого приложения и загрузки его в домен. ## Введение Ролевое приложение представляет собой Web-приложение, которое загружается в домен Аксател. Права доступа пользователей определяются ролевыми политиками безопасности в рамках Домена. Каждое Ролевое приложение имеет связанный SVC сценарий, который выполняет задачи вычислений и предоставления данных для отображения в Ролевом приложении конечному пользователю. Запуск сценария происходит через выполнение REST запроса /exec Ролевое приложение работает после успешной аутентификации пользователя в домене Аксател. ## Файл ролевого приложения Ролевое приложение представляет из себя zip-архив, который будет распакован на сервере при установке. Архив содержит в себе две значимые части: 1. Файл **roleapp.json** 2. Непосредственно web-приложение, выполняемое на стороне браузера Пример структуры файлов Ролевого приложения  {% file src="/files/-MGsZjv5LoQ0XnAHl1-3" %} Пример ролевого приложения {% endfile %} Файл **roleapp.json** в корне архива содержит описание приложения. Как правило все файлы приложения находятся также в корне архива (index.html и другие). ### Файл roleapp.json Должен быть валидным json файлом, размер которого не превышает 10Kb.\ Пример json файла. ``` { "name": "Roleapp Sample", "description": "Monitor (old) as RoleApp description", "order": 5000, "fa-icon": "fa-paw", "iconPath": "assets/desktop.svg" } ``` | Название | Описание | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | name |
Название ролевого приложения. Значение поля будет использовано для названия ролевого приложения в списке если администратор оставил поле "title" объекта ролевого приложения пустым.
Тип поля – строка
Обязательная переменная
| | description |Описание ролевого приложения. Значение будет доступно через /rest/v1/iam/sessions/current.
Тип поля – строка
Обязательная переменная
| | order |Порядок ролевого приложения при сортировке для отображения в списке. Администратор может принудительно его задать в поле ext.order объекта roleapp.
Тип поля – число
Необязательная переменная
| | fa-icon |имя класса иконки Font Awesome.
Необязательная переменная
| | iconPath |путь до иконки для списка приложений относительно папки ролевого приложения.
Обязательная переменная
| | folder |Подпапка внутри архива в качестве папки с web-документами (по-умолчанию используется весь архив от корня)
Необязательная переменная
Если указан, то в результате по url’у установленного приложения будет доступен не корень архива, а эта подпапка (в url не появляется).
Например, если “folder”:”dist”, то index.html должен быть размещен в подпапке dist и файл roleapp.json нельзя будет получить из прямого URL (/app/appname/roleapp.json )
├── dist
│ └── index.html
└── roleapp.json
| ## Установка ролевого приложения 1. Необходимо создать **SVC сценарий** 2. Создать **RoleApp** приложение * Раздел «Обработка сервиса» - «Ролевые приложения» * Новый объект * Путь приложения – уникальный путь в рамках текущего домена * Название приложения – как приложение будет отображаться на главной странице после авторизации * Права доступа – указать все права (роли) которым разрешен доступ к этому приложению * **SVC сценарий** – выбрать необходимый SVC сценарий 3. Загрузить zip архив с **RoleApp** * Получить ID Ролевого приложения (после создания открыть карточку на редактирование и скопировать id) * Открыть Talend API Tester (Restlet) addon в браузере и методом PUT загрузить файл  * * **Method** = put * **URL** = [http://demo.axatel.ru/rest/v1/domain/roleapps/daee4ff3-0170-4032-d6ca-fa163eec3818/attachment](http://demo.rostell.ru/rest/v1/domain/roleapps/daee4ff3-0170-4032-d6ca-fa163eec3818/attachment) * [http://demo.axatel.ru](http://demo.rostell.ru/) = URL WS * **/rest/v1/domain/roleapps/** = constant * **daee4ff3-0170-4032-d6ca-fa163eec3818** = RoleApp ID * **/attachment** = constant * **Content-Type** = multipart/form-dataТакже загрузить файл можно через curl (нужна сессионная куки) curl -b curl-worker.cookies \ -X PUT \ -F 'file=@roleapp\_sample.zip'
Role Application "Def2".
```
# Установка ролевых приложений
Установка ролевого приложения на примере приложения **Журнал звонков**.
1. Авторизуйтесь в домене на который будет устанавливаться приложение.
2\. Откройте в соседней вкладке браузера приложение [**Talend API Tester (Restlet) addon**](https://chrome.google.com/webstore/detail/talend-api-tester-free-ed/aejoelaoggembcahagimdiliamlcdmfm?hl=ru)**.**\
Выполните POST-запрос.
**Method** - POST\
**URL** - http\://\/rest/v1/domain/roleapps \
**Content-type** - application/json
**Body** - Text
```
{
"folder": "bizstat",
"id": "feaa6bae-0172-337f-c5fb-005056011d6",
"roles": ["stat"],
"svcscriptcode": "core_statistic_channel",
"title": "Журнал звонков"
}
```
3\. Если все данные указаны верно в ответ будет получен Response **200 OK**.
4\. Таким же образом выполните PUT-запрос.
**Method** - Put\
**URL** = http\://\/rest/v1/domain/roleapps/feaa6bae-0172-337f-c5fb-005056011d6c/attachment\
**Content-type** - multipart/form-data\
**Body** - Form\
Задайте любое имя и прикрепите файл приложения.
5\. Если все данные указаны верно в ответ будет получен Response **204 No Content**.
6\. Проверить корректность загруженного файла можно с помощью запроса GET.\
В результате будет предложено скачать файл который будет равен первоначальному загруженному файлу.
{% hint style="info" %}
Таким же образом вы можете скачать любое установленное приложение с одного домена и загрузить его в другой домен
{% endhint %}
7\. Через несколько минут, приложение появится на главной странице Axatel.
# Канал статистики
Содержит описание канала статистики для Ролевого приложения Аксател
## **Концепция решения**
Ролевое приложение или внешний сервис (далее Визуальный Интерфейс) делает запрос по http методом POST на получение данных для хронологических отчетов и оперативных дашбордов.\
Все запросы обрабатываются служебным сценарием и возвращаются данные.\
Задачи отображения данных лежат на визуальном интерфейсе.
## **Протокол взаимодействия**
Все запросы инициируются только Визуальным Интерфейсом. На каждый запрос возвращается один и только один ответ, содержащий запрашиваемую информацию или отчет об ошибке.
### **Запрос**
Все запросы делаются на адрес
• для Ролевого Приложения описано в администрировании
• для Внешнего сервиса через token интеграционного канала
Метод запроса POST Content-type application/json; charset=utf-8 Body содержит сам запрос в формате json в виде
```
{
"entity":"text",
"action":"text",
"options": {"key":"value"}
}
```
| **Поле** | | **Описание** |
| -------- | - | -------------------------------------------------------------------------------------------------------------------------- |
| entity | | определяет раздел запроса. |
| action | | определяет действие внутри entity. |
| options | | содержит дополнительные параметры запроса в зависимости от entity и action и детально описан в разделе по каждому запросу. |
### **Ответ**
Ответ в формате json.
```
{
"success":true/false,
"error":null/"text",
"data": null/"text"
}
```
| **Поле** | **Описание** |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| success | возвращает признак корректности выполнения запроса
• true = запрос выполнен без ошибок, результат в поле data
• false = запрос выполнен с ошибкой. Текст ошибки в поле error
|
| error | Поле содержит описание ошибки (если success == false) или констрантно равно null (если success == true) |
| data | Поле содержит запрашиваемые данные (если success == true) или констрантно равно null (если success == false). При корректном выполнении запроса формат зависит от запроса и детально описан в разделе по каждому запросу. |
## **Запросы хронологиской статистики**
### **Запрос данных для отображения**
Выполняет команду Select для получения блока данных из таблиц (подробно в Структура хронологических таблиц) Может содержать любые агрегации выборки в формате языка postgre sql.
**Body** **запроса**
```
{
"entity":"chronological",
"action":"data",
"options": {"psql":"тело запроса выборки в psql формате"}
}
```
{% hint style="info" %}
Поле **options.psql** должно начинаться с **Select**. Иначе будет возвращена ошибка выполнения.
{% endhint %}
**Успешный** **ответ**
```
{
"success":true,
"error":null,
"data": []
}
```
В поле **data** будет возвращен массив запрашиваемых данных
**Пример**
**Запрос**
```
{
"entity":"chronological",
"action":"data",
"options": {"psql":"select
inviteid,anumber,acallednum,bnumber,duration,stopreason from calls.success limit
2"}
}
```
**Ответ**
```
{
"success":true,
"error":null,
"data":
[
{
"inviteid": "a72866b5-0631-87dd-2624-0900000334b5",
"anumber": "205",
"acallednum": "375291831767",
"bnumber": "375291831767",
"duration": 19,
"stopreason": "<<\"Bye from side a\">>"
},
{
"inviteid": "cb1a456e-0631-883c-c444-5c00000334b5",
"anumber": "205",
"acallednum": "375291831767",
"bnumber": "375291831767",
"duration": 22,
"stopreason": "<<\"Bye from side a\">>"
}
]
}
```
### **Запрос количества данных**
Для получения количество строк удовлетворяющих **Select** необходимо выполнить запрос получения количества строк.
**Body** **запроса**
```
{
"entity":"chronological",
"action":"quantity",
"options": {"psql":"тело запроса получения количества строк выборки в psql
формате"}
}
```
{% hint style="info" %}
Поле **options.psql** должно начинаться с **select** count. Иначе будет возвращена ошибка выполнения
{% endhint %}
**Успешный** **ответ**
```
{
"success":true,
"error":null,
"data": number
}
```
В поле **data** будет возвращено количество найденных строк в **int**
**Пример**
Запрос
```
{
"entity":"chronological",
"action":"data",
"options": {"psql":"select count (inviteid) from calls.success"}
}
```
Ответ
```
{
"success":true,
"error":null,
"data": 835
}
```
Для получения количества строк можно использовать action=data. В этом случае в поле data ответа будет **\[{"count":835}]**
## **Запрос файла записи разговора**
Запись разговора запрашивается напрямую из системы без сценария-обработчика.
#### **Инфо по записи разговора**
> method = HEAD\
> url = \[fqdn]/rest/v1/journal/calls/\/attachment1 \ = inviteid звонка
**Успешный ответ**
> SIP Code = 200
В заголовках ответа содержится информация
content-type: audio/mpeg \
content-length: 50 kilobytes
Неуспешный ответ
| SIP Code | Причина |
| -------- | --------------- |
| 404 | Файл не найден |
| 403 | Доступ запрещен |
**Получение записи разговора**
> method = GET\
> url = \[fqdn]/rest/v1/journal/calls/\/attachment1?attachment=true/false\
> **<**id> = inviteid звонка\
> attachment=true\
> ответ выдается с заголовком\
> Content-Disposition: attachment; filename\*=UTF-8''FILENAME.EXT\
> , где FILENAME.EXT – имя и расширение файла в UrlEncoding,\
> сделано для скачивания браузером\
> attachment=false\
> выдается с Content-Type, соответствующим mime-type расширения файла.\
> сделано для проигрывания средствами браузера
{% hint style="info" %}
Если запрос без **?attachment**, то поведение аналогичное **?attachment=false**
{% endhint %}
**Успешный ответ**
**Для \`attachment=false'**
> SIP Code = 200
В заголовках ответа содержится информация
> content-type: audio/mpeg\
> content-length: 50 kilobytes
В body возвращается файл записи
**Для** **\`attachment=true'**
> SIP Code = 200
В заголовках ответа содержится информация
> content-length: 50 kilobytes\
> content-type: audio/mpeg \
> content-disposition: attachment; filename=mg1\_1711382410-1589448421120.mp3
В body возвращается файл записи
Неуспешный ответ
| SIP Code | Причина |
| -------- | --------------- |
| 404 | Файл не найден |
| 403 | Доступ запрещен |
## **Структура хронологических таблиц**
Для составления хронологических отчетов доступны следующие схемы
| **Схема** | **Описание** |
| --------------- | ---------------------------------------------- |
| alertcallevents | События по системе обзвона и оповещения |
| calls | События по звонкам |
| ivrhuntq | События по обработке звонков в очередях |
| ivrhuntqevents | События по состоянию объектов очередей |
| products | Дополнительные продуктовые данные |
| providerevents | События по состояниям внешних линий связи (SIP |
| scriptevents | События по сценариям |
| selectorevents | События по селекторным совещаниям |
| sipuserevents | События по сотояниям sip абонентов |
| sipusers | События по активностям sip абонентов |
| userevents | События по активностям пользователей |
### **Схема alertcallevents**
Позволяет получить все события по системе оповещения и массового автоматизированного обзвона.
Состоит из таблиц
| Таблица | Описание |
| --------------- | -------- |
| callinited | |
| callpreanswered | |
| callapproved | |
| statechanged | |
| prepared | |
| callrejected | |
| callstarted | |
| callanswered | |
| callfailed | |
| callfinished | |
### **Схема calls**
Позволяет получить статистические данные по звонкам. Состоит из таблиц
| **Таблица** | **Описание** |
| ----------- | ---------------------------------------------------------------------------------------- |
| success | Записи по успешным звонкам (был разговор) |
| cancelled | Записи по звонкам, у которых разговор не состоялся (пропущенные, не дозвонился и прочее) |
| failed | Записи у которых не было вызова стороны В |
| holds | Информация по постановке и снятию с удержания |
| routes | Информация по сработавшим правилам таблицы маршрутизации |
| forks | Информация по вызовам стороны В (дозвоны) |
Основными идентифкатора связи между таблицами является пара полей inviteid и invitedt.\
Связать цепочку коммутаций можно при инициализации звонка с внешней линии по полю esgdlg.\
На каждый вызов может быть несколько записей в таблице forks (количество одновременно зарегистрированных устройств абонента В) и в таблице routes (количество успешно сработавших правил маршрутизации).
### **Таблица success**
Содержит агрегирующую информацию по всем успешным звонкам. Успешным считается звонок, у которого сторона В поднял трубку (т.е. состоялась коммутация).
| **Поле** | **Тип** | **Описание** |
| --------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| inviteid | uuid | Основной идентификатор по звонку |
| invitedt | timestamp without time zone | Время инициации первичного звонка в UTC |
| acallid | character | CallId стороны А |
| bcallid | character | CallId стороны B |
| anumber | character | Номер А |
| ausername | character | Имя пользователя стороны А |
| adomain | character | Домер стороны А |
| adisplayname | character | Имя отображения стороны А |
| anetworkaddr | character | IP адрес стороны А |
| acallednum | character | Номер, который пришел от А при инициации |
| arepresentative | character | Номер представления стороны А (при кроссдоменных звонках) |
| aouter | boolean | Битовый признак что сторона А является внешней линией |
| aprovidercode | character | Код провайдера стороны А |
| bnumber | character | Номер B |
| busername | character | Имя пользователя стороны B |
| bdomain | character | Домен стороны B |
| bdisplayname | character | Имя отображения стороны B |
| bnetworkaddr | character | IP адрес стороны B |
| bouter | boolean | Битовый признак что сторона B является внешней линией |
| bprovidercode | character | Код провайдера стороны B |
| dial\_dt | timestamp without time zone | Время инициации вызова в UTC |
| start\_dt | timestamp without time zone | Время начала разговора в UTC |
| stop\_dt | timestamp without time zone | Время окончания разговора в UTC |
| dial\_duration | integer | Продолжительность вызова в сек (кол-во секунд между dial\_dt и start\_dt) |
| duration | integer | Продолжительность разговора в сек (кол-во секунд между start\_dt и stop\_dt) |
| stopreason | character | Текстовая причина завершения звонка |
| isrec | boolean | Битовый признак, что разговор был записан |
| callrecpath | character | Относительный путь записи разговора |
| callstoragecode | character | Имя хранилища записи разговора |
| callrecsize | bigint | Размер файла в байтах |
| callrecdel\_dt | timestamp without time zone | Время (UTC) когда запись разговора была удалена по правилам хранения записей |
| recordruleid | uuid | идентификатор правила записи разговоров |
| storageruleid | uuid | идентификатор правила хранения записей разговоров |
| recdomain | character | Домен, в котором велась запись звонка |
| recexpirets | timestamp withouttime zone | Время в UTC когда запись разговора будет удалена |
| recexpirets | timestamp withouttime zone | Время в UTC когда запись разговора будет удалена |
| sys\_recdelts | bigint | системное поле |
| dlgbinding | character | Текстовое поле всех меток звонка |
| esgdlg | character | CallID внешнего абонента. Может служить единым признаком цепочки коммутаций при инициации звонка с внешней линии |
| isreplacing | boolean | признак что текущий звонок был переведен от другого |
### **Таблица cancelled**
Содержит агрегирующую информацию по всем звонкам без ответа (звонок у которых найдена сторона В, на сторону В отправлен вызов, но диалог / разговор не был начат). Примеры звонков - В не взял трубку или отменил вызов или занят и т.д.
| **Поле** | **Тип** | **Описание** |
| --------------- | --------------------------- | ----------------------------------------------------- |
| inviteid | uuid | Основной идентификатор по звонку |
| invitedt | timestamp without time zone | Время инициации первичного звонка в UTC |
| dial\_dt | timestamp without time zone | Время инициации вызова в UTC |
| stop\_dt | timestamp without time zone | Время окончания дозвона в UTC |
| fromnumber | character | Номер А |
| fromusername | character | Имя пользователя стороны А |
| fromdomain | character | Домер стороны А |
| fromouter | boolean | Битовый признак что сторона А является внешней линией |
| fromprovidercod | character | Код провайдера стороны А |
| callednum | character | Номер, который пришел от А при инициации звонка |
| networkaddr | character | IP адрес стороны А |
| stoptype | character | SIP код ответа завершения звонка |
| stopreason | character | Текстовая причина завершения звонка |
### **Таблица failed**
Содержит агрегирующую информацию по всем неуспешным попыткам вызова.\
Неуспешная попытка - сторона В не найдена.\
Примеры ситуации - В не зарегистрирован, недоступна внешняя линия, набор запрещен по таблице маршрутизации и т.д.
| **Поле** | **Тип** | **Описание** |
| --------------- | --------------------------- | ----------------------------------------------------- |
| inviteid | uuid | Основной идентификатор по звонку |
| invitedt | timestamp without time zone | Время инициации первичного звонка в UTC |
| fromnumber | character | Номер А |
| fromusername | character | Имя пользователя стороны А |
| fromdomain | character | Домер стороны А |
| fromouter | boolean | Битовый признак что сторона А является внешней линией |
| fromprovidercod | character | Код провайдера стороны А |
| callednum | character | Номер, который пришел от А при инициации звонка |
| networkaddr | character | IP адрес стороны А |
| sipcode | character | SIP код причины |
| reason | character | Текстовая причина неуспешного звонка |
### **Таблица holds**
Содержит информацию по постановке/снятию с удержания звонка.
| **Поле** | **Тип** | **Описание** |
| ---------- | --------------------------- | ----------------------------------------------------- |
| inviteid | uuid | Основной идентификатор по звонку |
| invitedt | timestamp without time zone | Время инициации первичного звонка в UTC |
| side | character | Сторона кто поставил на удержание. Может быть a или b |
| hold\_dt | timestamp without time zone | Время (UTC) постановки на удержание |
| unhold\_dt | timestamp without time zone | Время (UTC) снятия с удержания |
| eventid | uuid | уникальный идентификатор события |
### **Таблица routes**
Содержит информацию по сработавшим маршрутам таблицы маршрутизации для каждого звонка в таблицах success, cancelled, failed.
Окончательно сработавшее правило всегда последнее в списке. Если несколько правил на один вызов, то значит все, кроме последнего, не смогли быть применены.
| **Поле** | **Тип** | **Описание** |
| --------------- | --------------------------- | -------------------------------------------------------------------------------- |
| inviteid | uuid | Основной идентификатор по звонку |
| invitedt | timestamp without time zone | Время инициации первичного звонка в UTC |
| event\_dt | timestamp without time zone | Время срабатывания правила в UTC |
| eventid | uuid | уникальный идентификатор события |
| vectorcode | character | Код вектора |
| ruleid | uuid | идентификатор правила |
| routeaction | character | Событие правила |
| routedomain | character | Домен правила |
| providercode | character | Код провайдера (если событие правила = outer) |
| featurecodeid | uuid | Идентификатор правила featurecode (если событие правила = featurecode) |
| featurecodetype | character | Тип кода абонентских функций (если событие правила = featurecode) |
| featurenumber | character | номер после обработки правилами featurecode (если событие правила = featurecode) |
### **Таблица forks**
Содержит Информацию по вызовы сторон В для всех звонков в таблицах success, cancelled.
Если на один вызов несколько записей форков, то значит сторона В имеет несколько одновременно зарегистрированных аппаратов.
| **Поле** | **Тип** | **Описание** |
| --------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| inviteid | uuid | Основной идентификатор по звонку |
| invitedt | timestamp without time zone | Время инициации первичного звонка в UTC |
| busername | character | Имя пользователя стороны B |
| bdomain | character | Домер стороны B |
| bnetworkaddr | character | IP адрес стороны B |
| bouter | boolean | Битовый признак что сторона B является внешней линией |
| bprovidercode | character | Код провайдера стороны B |
| ispreanswered | boolean | Битовый признак был ли предварительный ответ SIP 18x от этого форка |
| isanswered | boolean | Битовый признак был ли окончательный ответ SIP 200 от этого форка. У каждого вызова таблицы success существует одна и только одна запись где данное поле == true |
| forkstart\_dt | timestamp withouttime zone | Время инициации вызова на этот форк в UTC |
| forkpreansw\_dt | timestamp without time zone | Время предварительного ответа в UTC |
| forkansw\_dt | timestamp without time zone | Время окончательного ответа в UTC |
| sipcode | integer | Конечный результат вызова форка (SIP Code окончательного ответа) |
| reason | character | Конечный результат вызова форка (текстовое поле) |
| eventid | uuid | Уникальный идентифкатор данного форка |
### **Схема ivrhuntq**
```
huntq_calls
inviteid uuid NOT NULL,
huntq_id uuid,
callid character varying COLLATE pg_catalog."default",
esgdlg character varying COLLATE pg_catalog."default",
from_user character varying COLLATE pg_catalog."default",
from_displayname character varying COLLATE pg_catalog."default",
qid character varying COLLATE pg_catalog."default",
enqueue_result character varying COLLATE pg_catalog."default",
start_call_uid uuid,
dequeue_result character varying COLLATE pg_catalog."default", dequeue_reason character varying COLLATE pg_catalog."default", banned_user uuid,
final_stopreason character varying COLLATE pg_catalog."default", dt_greet timestamp without time zone, dt_enqueue timestamp without time zone,
dt_start_call timestamp without time zone,
dt_dequeue timestamp without time zone,
dt_preivr timestamp without time zone,
dt_userban timestamp without time zone,
dt_quit timestamp without time zone,
dt_final timestamp without time zone
```
### **Схема** **ivrhuntqevents**
```
final
huntq_id character varying COLLATE pg_catalog."default",
callid character varying COLLATE pg_catalog."default",
inviteid uuid,
esgdlg character varying COLLATE pg_catalog."default",
stopreason character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
queue_dequeue
qid character varying COLLATE pg_catalog."default",
huntq_id character varying COLLATE pg_catalog."default",
from_user character varying COLLATE pg_catalog."default",
from_displayname character varying COLLATE pg_catalog."default",
callid character varying COLLATE pg_catalog."default",
inviteid uuid,
esgdlg character varying COLLATE pg_catalog."default",
result character varying COLLATE pg_catalog."default",
reason character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
queue_enqueue
qid character varying COLLATE pg_catalog."default",
huntq_id character varying COLLATE pg_catalog."default",
callid character varying COLLATE pg_catalog."default",
inviteid uuid,
esgdlg character varying COLLATE pg_catalog."default",
from_user character varying COLLATE pg_catalog."default",
result character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
queue_greeting
huntq_id character varying COLLATE pg_catalog."default",
qivrscript character varying COLLATE pg_catalog."default",
callid character varying COLLATE pg_catalog."default",
inviteid uuid,
esgdlg character varying COLLATE pg_catalog."default",
from_user character varying COLLATE pg_catalog."default",
from_displayname character varying COLLATE pg_catalog."default",
sys_iscopied boolean DEFAULT false,
sys_copyid bigint,
eventts timestamp without time zone
queue_preivr_start
qid character varying COLLATE pg_catalog."default",
userid character varying COLLATE pg_catalog."default",
callid character varying COLLATE pg_catalog."default",
inviteid uuid,
esgdlg character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
queue_quit
qid character varying COLLATE pg_catalog."default",
from_user character varying COLLATE pg_catalog."default",
callid character varying COLLATE pg_catalog."default",
inviteid uuid,
esgdlg character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
queue_start_call
qid character varying COLLATE pg_catalog."default",
userid character varying COLLATE pg_catalog."default",
callid character varying COLLATE pg_catalog."default",
inviteid uuid,
esgdlg character varying COLLATE pg_catalog."default", eventts timestamp without time zone
queue_userban
qid character varying COLLATE pg_catalog."default",
huntq_id character varying COLLATE pg_catalog."default",
callid character varying COLLATE pg_catalog."default",
inviteid uuid,
esgdlg character varying COLLATE pg_catalog."default",
userid character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
```
### **Схема** **products**
```
filter_intervals
filter_id interval,
filter_text character varying COLLATE pg_catalog."default"
ref_huntblock_reasons
title character varying COLLATE pg_catalog."default", event_key character varying COLLATE pg_catalog."default", duration bigint,
type character varying COLLATE pg_catalog."default", is_allowed boolean
```
### **Схема** **providerevents**
```
provider_state_changed
code character varying COLLATE pg_catalog."default",
objid character varying COLLATE pg_catalog."default",
state character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
```
### **Схема** **scriptevents**
```
script_start
type character varying COLLATE pg_catalog."default",
scrcode character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
script_stop
type character varying COLLATE pg_catalog."default",
scrcode character varying COLLATE pg_catalog."default",
stoptype character varying COLLATE pg_catalog."default",
stopreason character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
```
### **Схема** **selectorevents**
```
sel_abon_state_changed
id character varying COLLATE pg_catalog."default",
num character varying COLLATE pg_catalog."default",
name character varying COLLATE pg_catalog."default",
selid character varying COLLATE pg_catalog."default",
state character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
sel_create
id character varying COLLATE pg_catalog."default",
opts character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
sel_delete
id character varying COLLATE pg_catalog."default",
reason character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
sel_state_changed
id character varying COLLATE pg_catalog."default",
state character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
sel_update
id character varying COLLATE pg_catalog."default",
opts character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
sel_voting_state_changed
id character varying COLLATE pg_catalog."default",
name character varying COLLATE pg_catalog."default",
selid character varying COLLATE pg_catalog."default",
state character varying COLLATE pg_catalog."default",
info character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
```
### **Схема** **sipuserevents**
```
sipuser_state_changed
login character varying COLLATE pg_catalog."default" NOT NULL,
state character varying COLLATE pg_catalog."default" NOT NULL,
sys_iscopied boolean DEFAULT false, sys_copyid bigint,
eventts timestamp without time zone NOT NULL
sipuser_transtate_set
login character varying COLLATE pg_catalog."default" NOT NULL,
state character varying COLLATE pg_catalog."default" NOT NULL,
ttl bigint,
strategy character varying COLLATE pg_catalog."default",
xinfo character varying COLLATE pg_catalog."default",
sys_iscopied boolean DEFAULT false, sys_copyid bigint,
eventts timestamp without time zone NOT NULL
```
### **Схема** **sipusers**
```
states
eventid bigint,
event_name character varying COLLATE pg_catalog."default",
login character varying COLLATE pg_catalog."default",
state character varying COLLATE pg_catalog."default",
dt_start timestamp without time zone,
dt_stop timestamp without time zone,
len bigint,
xinfo character varying COLLATE pg_catalog."default",
strategy character varying COLLATE pg_catalog."default"
```
### **Схема** **userevents**
```
usr_state_changed
user_id character varying COLLATE pg_catalog."default" NOT NULL,
state character varying COLLATE pg_catalog."default",
changed_by character varying COLLATE pg_catalog."default",
eventts timestamp without time zone
```
возвращает признак корректности выполнения запроса
• true = запрос выполнен без ошибок, результат в поле data
• false = запрос выполнен с ошибкой. Текст ошибки в поле error
| | error | Поле содержит описание ошибки (если success == false) или констрантно равно null (если success == true) | | data | Поле содержит запрашиваемые данные (если success == true) или констрантно равно null (если success == false). При корректном выполнении запроса формат зависит от запроса и детально описан в разделе по каждому запросу. | ## **Запросы хронологиской статистики** ### **Запрос данных для отображения** Выполняет команду Select для получения блока данных из таблиц (подробно в Структура хронологических таблиц) Может содержать любые агрегации выборки в формате языка postgre sql. **Body** **запроса** ``` { "entity":"chronological", "action":"data", "options": {"psql":"тело запроса выборки в psql формате"} } ``` {% hint style="info" %} Поле **options.psql** должно начинаться с **Select**. Иначе будет возвращена ошибка выполнения. {% endhint %} **Успешный** **ответ** ``` { "success":true, "error":null, "data": [] } ``` В поле **data** будет возвращен массив запрашиваемых данных **Пример** **Запрос** ``` { "entity":"chronological", "action":"data", "options": {"psql":"select inviteid,anumber,acallednum,bnumber,duration,stopreason from calls.success limit 2"} } ``` **Ответ** ``` { "success":true, "error":null, "data": [ { "inviteid": "a72866b5-0631-87dd-2624-0900000334b5", "anumber": "205", "acallednum": "375291831767", "bnumber": "375291831767", "duration": 19, "stopreason": "<<\"Bye from side a\">>" }, { "inviteid": "cb1a456e-0631-883c-c444-5c00000334b5", "anumber": "205", "acallednum": "375291831767", "bnumber": "375291831767", "duration": 22, "stopreason": "<<\"Bye from side a\">>" } ] } ``` ### **Запрос количества данных** Для получения количество строк удовлетворяющих **Select** необходимо выполнить запрос получения количества строк. **Body** **запроса** ``` { "entity":"chronological", "action":"quantity", "options": {"psql":"тело запроса получения количества строк выборки в psql формате"} } ``` {% hint style="info" %} Поле **options.psql** должно начинаться с **select** count. Иначе будет возвращена ошибка выполнения {% endhint %} **Успешный** **ответ** ``` { "success":true, "error":null, "data": number } ``` В поле **data** будет возвращено количество найденных строк в **int** **Пример** Запрос ``` { "entity":"chronological", "action":"data", "options": {"psql":"select count (inviteid) from calls.success"} } ``` Ответ ``` { "success":true, "error":null, "data": 835 } ``` Для получения количества строк можно использовать action=data. В этом случае в поле data ответа будет **\[{"count":835}]** ## **Запрос файла записи разговора** Запись разговора запрашивается напрямую из системы без сценария-обработчика. #### **Инфо по записи разговора** > method = HEAD\ > url = \[fqdn]/rest/v1/journal/calls/\