Подключение, настройка и управление модулями
Дополнительные модули позволяют расширить возможности функционала основной системы. В данной инструкции вы сможете найти информацию про управление модулями, а так же про установку приложений с помощью встроенного Marketplace.
Подробные инструкции по настройке и эксплуатации каждого модуля вы можете найти здесь.
Найти раздел Управления модулями вы можете в "Модули" -> "Маркетплейс модулей".
В данном разделе происходит основное управление модулями: их подключение, настройка, а так же загрузка своих, "кастомных" модулей. Документацию по разработке своих модулей вы можете найти здесь.
Все установленные модули находятся в списке, в одноимённой вкладке:
Есть возможность загрузить свой модуль, используя кнопку "Загрузить новый модуль". Необходимо загружать файлы .zip. После загрузки модуль появится в списке на вкладке "Установленные модули"
Так же есть возможность перейти в настройки любого модуля для дальнейшей его конфигурации:
Помимо этого, можно включить/отключить модуль.
Из интерфейса установленного модуля можно быстро перейти к его документации, нажав на знак вопроса справа от короткого описания модуля:
Существует возможность вынести любой модуль в боковое меню для быстрого доступа к нему, что может быть полезно, если вам требуется постоянный доступ к настройки модуля для изменения параметров или его состояния.
Для того, чтобы это сделать - выполните дальнейшую инструкцию:
Перейдите в настройки модуля, который Вы хотите вывести в боковое меню, нажав на элемент редактирования справа от версии модуля:
Нажмите на значок настроек справа от статуса состояния модуля для перехода к настройкам отображения модуля в боковом меню:
В данном разделе вы можете:
Переключить отображение модуля в боковом меню - "Показывать модуль в боковом меню".
Выбрать раздел в котором он будет отображаться - в примере выбран раздел "Модули".
Так же можно указать произвольное название модуля.
После завершения настройки - нажмите "Сохранить".
В данном разделе вы можете установить модули от MIKO, а так же от производителей-партнеров.
Напротив каждого модуля есть кнопка для его скачивания и установки. Так же здесь отображена базовая информация по модулю с коротким описанием каждого модуля.
Слева от названия модуля вы можете найти значок, по которому можно понять платный ли он или бесплатный. Например, на изображении выше модуль "REST API Автоинформатор" - платный, а модуль "Генератор SSL сертификатов через Let's Encrypt" - бесплатный.
Существует возможность перейти в карточку модуля, нажав на его название в интерфейсе маркетплейса.
Здесь вы можете найти версию актуального релиза, информацию про разработчика, платный ли модуль или бесплатный. Тут же находятся 3 раздела:
Здесь вы можете найти изображения про функционал и настройки модуля. Помимо этого - базовое описание модуля, а так же раздел "Полезные ссылки", где располагается ссылка на подробную документацию по настройке и эксплуатации модуля.
В данном разделе вы можете найти историю версий модуля, с подробным описанием изменений, а также минимально совместимой версии MikoPBX для корректной его работы. Так же вы можете установить конкретную версию модуля, нажав на синий элемент под общим ее описанием.
Здесь вы можете ознакомиться с пользовательским лицензионным соглашением для каждого модуля расширения.
В случае покупки модуля, вам будет выдан купон. Для его активации перейдите в Модули -> Маркетплейс модулей:
Далее перейдите в раздел "Управление лицензией"
В поле "Активация купона" введите ваш купон, далее нажмите "Активировать купон"
Описание процесса регистрации
Регистрация в Маркетплейсе MikoPBX не влияет на базовый функционал системы. Вы можете использовать MikoPBX для работы со звонками без регистрации и установки дополнительных модулей. Однако, Мы рекомендуем пройти процедуру регистрации в маркетплейсе для получения возможности расширения функционала системы.
Регистрация даст вам доступ к дополнительным модулям и расширениям. Есть бесплатные модули, который мы вынесли из базового функционала для упрощения первоначальной настройки, а также платные модули от нас и других разработчиков. Если вы разработчик, то можете связаться с нами, написав на почту [email protected] для получения инструкций о том, как разработать собственный модуль и добавить его в Marketplace.
Сама MikoPBX - бесплатное решение и не требует никакой регистрации. Отсутствие лицензии никак не влияет на звонки. Вы в любой момент можете зарегистрироваться, а также отменить регистрацию в Marketplace.
Для начала регистрации в маркетплейсе вам необходимо перейти во вкладку "Модули" -> "Маркетплейс модулей":
В случае, если у Вас не выполнена регистрация в Маркетплейсе, раздел будет выглядеть вот так:
В случае переноса MikoPBX на другой хост или восстановлении из бекапа, необходимо выполнить сброс привязок лицензий на модули в личном кабинете lm.mikopbx.com
Нажмите синюю кнопку "Регистрация в маркетплейсе" для начала регистрации:
Лицензионный ключ используется для хранения всех ваших лицензий от любых продуктов МИКО. Если у вас уже есть ключ, вы можете просто вписать его в одноименное поле. Если ключ у вас был, но вы его забыли, вы можете поискать письмо в вашей электронной почте входящие письма по адресу [email protected]
Получить новый ключ можно автоматически, заполнив регистрационную форму ниже:
Название организации - введите имя вашей компании/организации.
Адрес электронной почты контактного лица - введите адрес электронной почты вышей компании/организации.
Контактное лицо - введите данные контактного лица.
Телефон контактного лица (необязательно).
Уникальный идентификатор компании (ИНН, ИИН, УНП и т.д.) (необязательно).
Нажмите "Зарегистрироваться"
В случае успешной регистрации, вы увидите следующий экран:
Уведомление об успешной регистрации системы.
Наведите курсор на поле с лицензионным ключом, если вам необходимо его увидеть или скопировать. По умолчанию значение ключа размыто.
Для управления лицензией перейдите в раздел Маркетплейс -> Управление лицензией. Нажмите на одноименный элемент:
Вы попадете на сайт SaaS сервер лицензирования:
Для управления лицензией введите ваш лицензионный ключ в поле "Введите ваш лицензионный ключ или активированный ранее купон":
Нажмите "Login"
Вы попадете в систему, где находятся 9 секций:
Перейдите в раздел "Монитор сессий":
Слева для каждой привязки в колонке Информация есть кнопка i, которая позволяет посмотреть подробную информацию о хосте, к которому привязана лицензия.
Для каждой привязки в колонке "Действие" есть кнопка "Сброс", которая позволяет сбросить активную привязку лицензии от хоста.
При регистрации может возникать проблема отсутствии у MikoPBX связи с интернетом, а именно с отсутствием связи с серверами lic.miko.ru и lic.mikopbx.com по порту 443(https)
Решение: проверить доступ к станции из интернета, проверить настройки firewall и общего доступа к вышеупомянутым ресурсам.
MikoPBX переодически обращается к серверам лицензирования для проверки установленных модулей. Если лицензия на модуль недоступна, то он будет отключен, а рядом с названием модуля появится соответствующая иконка в виде перечеркнутого ключа.
Описание раздела Модули в MikoPBX
Раздел «Модули» в MikoPBX — это интерфейс для управления дополнительными функциональными компонентами системы, который включает два подраздела: «Управление модулями» и «Приложения диалплана».
Управление этими подразделами позволяет настроить MikoPBX максимально гибко и эффективно, расширяя функциональность телефонной системы и адаптируя ее под уникальные требования организации.
Регистрация в Маркетплейсе MikoPBX не влияет на базовый функционал системы. Вы можете использовать MikoPBX для работы со звонками без регистрации и установки дополнительных модулей. Однако, Мы рекомендуем пройти процедуру регистрации в маркетплейсе для получения возможности расширения функционала системы.
Регистрация даст вам доступ к дополнительным модулям и расширениям.
Управление модулями в MikoPBX — это интерфейс для управления дополнительными компонентами системы, расширяющими ее функциональность. Здесь администраторы могут устанавливать, обновлять, включать или отключать модули, добавляя новые возможности или интеграции с внешними сервисами. Этот раздел позволяет адаптировать систему под специфические потребности компании, обеспечивая гибкость и масштабируемость телефонной сети.
Приложения диалпланов в MikoPBX — это набор инструментов, которые позволяют настраивать индивидуальные сценарии обработки звонков внутри системы. С их помощью вы можете определить последовательность действий, которую система выполнит при поступлении или совершении вызова. Это может включать перенаправление звонка на определенный внутренний номер, воспроизведение специальных аудиосообщений, запрос дополнительной информации у звонящего или выполнение других функций.
Используя приложения диалпланов, вы можете гибко настроить логику работы телефонной системы под потребности вашего бизнеса, не углубляясь в сложное программирование. Это облегчает создание сложных сценариев обработки вызовов, позволяя улучшить эффективность коммуникаций и повысить уровень обслуживания клиентов.
Создание и настройка приложений диалплана
Приложения диалпланов - это программируемые голосовые приложения на PHP и Asterisk Dialplan. MikoPBX поставляется с несколькими предварительно сконфигурированными приложениями. С некоторыми базовыми знаниями планов набора Asterisk можно легко создавать дополнительные приложения. Как и учетная запись телефона, приложения могут иметь внутренний номер, присвоенный в настройках.
Ниже вы увидите описание базовых приложений, включенных в MikoPBX:
000063
Приложение считывает внутренний номер сотрудника, используемое для вызова приложения, и озвучивает его сотруднику, т.е. сотруднику озвучивается его внутренний номер на АТС
000064
0000MILLI - Генерирует постоянный звуковой сигнал частотой 1000 Гц. Используется для проверки качества соединения.
10003246
Приложение Echo посылает полученные аудиосигналы обратно пользователю, чтобы можно было определить длительность задержки. В общем, Вы слышите, что Вы говорите. Приложение в основном используется для тестирования.
Приложения MikoPBX создаются из нескольких планов набора Asterisk приложений. В системе есть много примеров готовых к выполнению приложений. Для добавления нового приложения MikoPBX нажмите на "Добавить новое" в меню приложений.
Всего в несколько шагов Вы сможете создать свои собственные приложения. Во-первых, определите Название и Номер вызова для приложения, при необходимости заполните поле Комментарий. Возможный тип кода приложения:
PHP-AGI скрипт - AGI - это встроенный в Asterisk метод выполнения внешних скриптов (по аналогии с CGI для http серверов), который может расширить функциональность asterisk при помощи других языков программирования, в частности PHP. AGI скрипты могут управлять вызовом в плане набора, вызываются из файла: extensions.conf
Диалплан Asterisk - конфигурация плана набора содержится в файле конфигурации Asterisk - extensions.conf. Это один из самых важных конфигурационных файлов. В нем определяется обработка и маршрутизация входящих и исходящих вызовов. Этот файл управляет поведением всех соединений проходящих через Вашу АТС.
Внесем ясность: мы будем называть MikoPBX приложения - приложениями, планы набора Asterisk -функциями. Например, Answer(), NoOP(), Set() and Wait() - это функции. Эти отдельные целевые функции Asterisk, которые затем объединяются в MikoPBX для создания более мощных MikoPBX приложений. Опишите логические операции в текстовом поле Программный код. Обратите внимание, что в одной строке одновременно допускается только одна команда, например:
На рисунке пример простейшего приложения для номера 000063. После набора номера, вы услышите, как робот озвучивает Ваш внутренний номер.
MikoPBX будет проверять используемые команды. Не исключено, что неправильно запрограммированные операции могут повлиять на работоспособность вашей телефонной системы.
Описание Asterisk функций, которые Вы можете использовать в своих приложениях:
answer
Перевести вызов в отвеченное состояние.
channel status
Возвращает статус подключенного канала.
control stream file
Отправка в канал заданного звукового файла, с возможностью управления его проигрывания (пауза/перемотка/возобновление проигрывания) с помощью получаемых от абонента DTMF цифр, если заданы. (Asterisk 1.2)
database del
Удаление ключа/значения из базы данных.
database deltree
Удаление дерева ключей/значений из базы данных.
database get
Получить значение из базы данных.
database put
Добавление/изменение значения в базе данных.
exec
Выполнение заданной Команды. (Команды - это функции, которые Вы используете при описании плана набора в файле extensions.conf ).
get data
Получить данные из канала.
get option
Ведет себя аналогично команде «STREAM FILE», но используется с заданным значением для таймаута. (Asterisk 1.2)
get variable
Получить значение переменной канала.
hangup
Разорвать соединение (Hangup) на текущем канале.
noop
Пустая команда. Ничего не делает.
receive char
Принимает один символ из канала, если он поддерживает эту возможность.
receive text
Принимает текстовую строку из канала, если он поддерживает эту возможность.
record file
Производит запись в заданный файл.
say alpha
Проговаривает заданную строку символов. (Asterisk 1.2)
say date
Проговаривает дату. (Asterisk 1.2)
say datetime
Проговаривает дату и время, согласно заданному формату. (Asterisk 1.2)
say digits
Проговаривает заданную строку цифр.
say number
Проговаривает заданный номер.
say phonetic
Проговаривает заданную строку символов.
say time
Проговаривает время.
send image
Отправляет изображение в канал, если он поддерживает эту возможность.
send text
Отправляет текст в канал, если он поддерживает эту возможность.
set autohangup
Автоматическое завершение соединение (Autohangup) на канале в заданное время.
set callerid
Установка callerid для текущего канала.
set context
Установка контекста для текущего канала.
set extension
Изменение екстеншена для текущего канала.
set music
Включение/Выключение музыки ожидания (Music on hold), например: «SET MUSIC ON default».
set priority
Установка значения приоритета для следующей выполняемой команды для канала.
set variable
Установка переменной канала.
stream file
Отправка звукового файла в канал.
tdd mode
Установка режима TDD для канала, который может его поддерживать, для включения возможности взаимодействия с TDD.
verbose
Запись сообщения в verbose log сервера asterisk.
wait for digit
Ожидание нажатия DTMF кнопки
Нажмите Сохранить для завершения настройки.