Данная инструкция подробно расскажет о пути начала работы с MikoPBX и поможет вам быстро разобраться с настройкой системы.
Следуйте инструкциям шаг-за-шагом в том порядке, в котором они представлены для быстрой и успешной настройки системы.
Установка MikoPBX
MikoPBX - полноценная операционная система для вашего оборудования, не является отдельной программой. Поставляется в виде образа (файл *.iso, *.img, *.raw).
Она поддерживает многие способы установки:
Установка .
Установка .
Установка .
Установка в .
Перейдите по ссылке к интересующему Вас способу установки и произведите её по данным инструкциям.
Первый вход в веб-интерфейс
После установки Вам необходимо перейти в web-интерфейс MikoPBX для дальнейшей настройки системы. Для того, чтобы это сделать - найдите IP-адрес станции в консоли MikoPBX:
В данном примере - IP-адрес 172.25.233.36. Для перехода в web-интерфейс введите этот IP в адресную строку вашего браузера:
Если в логах Вам не даны логин и пароль, используйте данные по-умолчанию:
Username: admin
Password: admin
После первой авторизации, система попросит Вас поменять пароль.
Настройки внутри web-интерфейса:
Настройки сети и сетевого экрана
Для стабильной работы АТС необходимо настроить сеть через раздел Сеть и Firewall → Сетевые интерфейсы. Ознакомится с подробной инструкцией по данным настройкам можно .
В MikoPBX все локальные подсети возможно описать в разделе Сеть и Firewall → Сетевой экран. Сетевой экран предназначен для ограничения доступа к станции по типу трафика и подсетям. Выполните настройку по .
Настройка защиты от взлома (Fail2Ban)
Fail2ban блокирует IP адреса с нестандартной активностью, он способен снизить скорость неудачных попыток аутентификации, позволяет защитить Вашу АТС от взлома. Инструкцию, которая поможет в настройке можно найти .
Добавление и настройка учетных записей сотрудников
После окончания первоначальной настройки АТС, Вы можете перейти к созданию учетных записей ваших сотрудников. В этом вам поможет .
Подключение провайдеров
После добавления сотрудников, Вам необходимо подключить провайдеров к вашей станции. Инструкцию про этот раздел вы можете найти . Инструкции с примерами настройки реальных провайдеров вы можете найти .
Настройка входящей и исходящей маршрутизации
На данном этапе необходимо задать правила маршрутизации для входящих и исходящих вызовов: как будут обрабатываться звонки, идущие через определенного провайдера:
Для создания правил маршрутизации Вам так же могут понадобиться следующие функции:
Маркетплейс и модули
Маркетплейс позволяет расширить стандартный функционал системы с помощью модулей:
Подробнее про Модули в MikoPBX Вы можете прочитать в .
Про регистрацию в Маркетплейсе MikoPBX Вы можете прочитать в .
На этом, основная настройка MikoPBX завершена! Для более глубокого изучения возможностей MikoPBX рекомендуем обратиться к общей документации.
В данной статье Вы сможете найти инструкции по установке MikoPBX с помощью различных облачных сервисов.
MikoPBX поддерживает установку с помощью многих облачных сервисов. В данном разделе Вы можете найти подробные инструкции по ним. Нажмите на элемент в списке ниже для перехода к инструкции по конкретной виртуальной машине:
В данной статье Вы сможете найти инструкции по установке MikoPBX с помощью различных виртуальных машин.
MikoPBX поддерживает установку с помощью многих виртуальных машин. В данном разделе Вы можете найти подробные инструкции по ним. Нажмите на элемент в списке ниже для перехода к инструкции по конкретной виртуальной машине:
Перехват на ответственного в панели телефонии 4.0 как в панели 1.0
Отменить перехват на ответственного для конкретного провайдера
Установка
Перехват на ответственного
Коммандная строка YC
Установка MikoPBX в Yandex Cloud с помощью утилиты yc
Утилита Yandex Cloud позволяет автоматизировать создание инстансов. Ее можно использовать в скриптах.
На странице продукта скопируйте значение image_id. В текущем примере fd83g1qbk6m3jnl5cvah (для версии 2022.3.15). Идентификатор образа следует укзаать в параметре create-boot-disk image-id
Получим список каталогов
yc resource-manager folder list
Выбираем каталог и указываем его имя в параметре folder-name
Список зон
Описываем зону в параметре zone
Запускаем инстанс
Список инстансов обновится
Используйте EXTERNAL IP для входа и ID в качестве пароля для пользователя admin web интерфейса
AWS
Варианты установки MikoPBX с помощью AWS
Самый простой способ установки MikoPBX - установка готового образа из AWS Marketplace, если вы хотите запустить нестандартную версию MikoPBX, то воспользуйтесь подробной инструкцией, где мы по шагам описали каким образом можно создать AMI образ из любого дистрибутива MikoPBX.
Руководство по MikoPBX
Описание MikoPBX и разделов, которые вы сможете найти в документации. Вступление в документацию.
Предисловие
Добро пожаловать на ресурс документации по MikoPBX! Здесь Вы сможете найти пошаговые инструкции, связанные с взаимодействием с АТС MikoPBX. Для удобства, они собраны в разделы - прямо как в Web-интерфейсе, поэтому ориентироваться в документации очень легко.
Благодарим Вас за выбор MikoPBX! ❤️
Знакомство с MikoPBX
Это статья про первый вход в MikoPBX. Здесь вы найдете процесс первого входа в систему и некоторые рекомендации по первоначальной настройки после входа.
Первый вход в систему MikoPBX
Перейдите в консоль MikoPBX, вверху будет находиться IP-адрес, по которому вы можете подключиться через WEB-интерфейс. При установках не на локальный компьютер используйте внутренний IP-адрес. Скопируйте или запомните его.
Введите или вставьте IP-адрес MikoPBX в web-браузере. Отобразится страница авторизации в web-интерфейс. Введите логин и пароль по умолчанию.
Обслуживание
Описание раздела Обслуживание в MikoPBX
Раздел «Обслуживание» в MikoPBX — это интерфейс для управления техническими аспектами системы и обеспечения ее стабильной работы. Здесь администраторы могут выполнять задачи по резервному копированию и восстановлению данных, обновлению программного обеспечения, мониторингу состояния системы и управлению журналами событий. Этот раздел помогает поддерживать работоспособность телефонной системы, своевременно обнаруживать и устранять возможные проблемы.
Обновление системы
Раздел «Обновление» в MikoPBX — это интерфейс для управления обновлениями программного обеспечения системы. Здесь администраторы могут проверять наличие новых версий, устанавливать обновления и просматривать историю изменений. Регулярное использование этого раздела обеспечивает актуальность, безопасность и стабильность работы MikoPBX.
Google Cloud
Варианты установки MikoPBX в Google Cloud
Установка MikoPBX в Google Cloud может быть выполнена двумя способами: из образа в маркетплейсе Google Cloud или из образа на основе загруженного файла из дистрибутива MikoPBX. Первый способ обеспечивает быстрое и простое развертывание стандартной версии MikoPBX, а второй подходит для промежуточных релизов.
Модули
Описание раздела Модули в MikoPBX
Раздел «Модули» в MikoPBX — это интерфейс для управления дополнительными функциональными компонентами системы, который включает два подраздела: «Управление модулями» и «Приложения диалплана».
Управление этими подразделами позволяет настроить MikoPBX максимально гибко и эффективно, расширяя функциональность телефонной системы и адаптируя ее под уникальные требования организации.
Регистрация в маркетплейсе модулей
Отдельный компьютер
В данной статье Вы сможете найти инструкции по установке MikoPBX на отдельный компьютер
MikoPBX поддерживает установку на отдельный компьютер. Существуют два способа:
Live USB - запись образа на флешку с последующей её установкой на другой диск.
Bootable USB - установка системы на непосредственно сам USB-носитель с последующей возможностью загрузки с нее.
В данном разделе представлены варианты записи образов на всех возможных системах (Windows, MacOS, Linux)
Сеть и Firewall
Описание раздела Сеть и Firewall в MikoPBX
Раздел «Сеть и Firewall» в MikoPBX — это интерфейс для настройки сетевых параметров и управления брандмауэром системы. Здесь администраторы могут настраивать IP-адреса, сетевые интерфейсы и создавать правила брандмауэра для защиты системы от несанкционированного доступа. Этот раздел обеспечивает безопасную и стабильную работу MikoPBX в сетевой инфраструктуре организации.
Сетевые интерфейсы
Раздел «Сетевые интерфейсы» в MikoPBX — это интерфейс для настройки параметров сетевых подключений системы. Здесь администраторы могут управлять IP-адресами, масками подсети, шлюзами и другими сетевыми настройками для каждого сетевого интерфейса. Это позволяет корректно интегрировать MikoPBX в сеть организации и обеспечить ее стабильную работу в соответствии с требованиями сетевой инфраструктуры.
В Docker контейнере
Варианты установки MikoPBX в Docker контейнере
«Host система» должна быть запущена на базе Linux 5+. Тестировалось на Debian 11 и Ubuntu-21.04, Ubuntu Server 22.04 LTS
MikoPBX можно запустить в Docker, используя два основных способа. Первый способ включает в себя запуск контейнера напрямую через команду Docker с указанием необходимых параметров. Второй способ предусматривает использование Docker Compose, что упрощает управление многоконтейнерными приложениями и позволяет описать всю конфигурацию в yaml-файле, что делает развертывание и обслуживание системы более удобным.
Обновление PBX
Данная статья содержит пошаговые инструкции по обновлению MikoPBX на более новую версию.
Перед обновлением обязательно сделайте резервную копию настроек АТС. Делается это при помощи .
Дата и время
В данном разделе происходит настройка часов и календаря
Раздел «Дата и время» в MikoPBX — это интерфейс для настройки системных параметров даты и времени. Здесь администраторы могут установить текущую дату и время, выбрать часовой пояс и настроить синхронизацию с серверами точного времени (NTP). Корректная настройка даты и времени важна для точной регистрации событий, журналов вызовов и работы функций, зависящих от расписания, обеспечивая синхронизацию системы с другими сетевыми устройствами и сервисами.
Настройка производится в разделе «Система» - «Дата и время»:
Существует возможность установить время «вручную», без использования NTP сервера. По возможности, рекомендуем использовать автоматическое определение времени.
Для настройки времени вручную переключите тумблер "Корректировать время вручную"
Google Cloud Маркетплейс
Инструкция по установке готового образа из Google Cloud Маркетплейс
Google Cloud подробная инструкция
Подробная инструкция по загрузке MikoPBX из образа на основе .vhd файла из дистрибутива
Установка докера и cоздание пользователя и каталогов
Команды для установки Docker и Docker Compose и настройка перед созданием контейнера
Запуск MikoPBX в контейнере
Инструкции по запуску готового контейнера MikoPBX, созданию контейнера из произвольного образа и его запуску
Запуск MikoPBX с помощью docker compose
Инструкции по запуску нескольких MikoPBX на одном хосте с помощью docker compose
модуля резервного копирования
Обновление онлайн из web-интерфейса
Через web-интерфейс MikoPBX, используя встроенный механизм обновлений
Обновление из консоли MikoPBX
Из консоли MikoPBX командой для загрузки и установки новой версии
Обновление Docker
Путём скачивания последнего образа контейнера MikoPBX и перезапуска с новым образом
Раздел "Дата и время" в MikoPBX
Элемент для корректировки времени вручную
AWS подробная инструкция
Подробная инструкция по созданию AMI образа
AWS Маркетплейс
Инструкция по установке готового образа из AWS Marketplace
Диагностика системы
Раздел «Диагностика системы» в MikoPBX — это инструмент для мониторинга и анализа состояния телефонной системы. Здесь администраторы могут просматривать журналы событий, проверять с помощью них статус различных сервисов и компонентов системы, а также выполнять тестирование соединений и вызовов. Использование этого раздела помогает своевременно обнаруживать и устранять технические проблемы, обеспечивая стабильную и эффективную работу MikoPBX.
Перезагрузка и выключение системы
Раздел «Перезагрузка и выключение системы» в MikoPBX — это интерфейс для безопасного управления состоянием телефонной системы через веб-интерфейс. Здесь администраторы могут перезагрузить систему для применения новых настроек или корректно выключить ее для технического обслуживания. Использование этого раздела предотвращает возможные ошибки и обеспечивает стабильную работу MikoPBX. Помимо этого, будет рассмотрена возможность перезагрузки через консоль.
Регистрация в Маркетплейсе MikoPBX не влияет на базовый функционал системы. Вы можете использовать MikoPBX для работы со звонками без регистрации и установки дополнительных модулей. Однако, Мы рекомендуем пройти процедуру регистрации в маркетплейсе для получения возможности расширения функционала системы.
Регистрация даст вам доступ к дополнительным модулям и расширениям.
Управление модулями
Управление модулями в MikoPBX — это интерфейс для управления дополнительными компонентами системы, расширяющими ее функциональность. Здесь администраторы могут устанавливать, обновлять, включать или отключать модули, добавляя новые возможности или интеграции с внешними сервисами. Этот раздел позволяет адаптировать систему под специфические потребности компании, обеспечивая гибкость и масштабируемость телефонной сети.
Приложения диалпланов
Приложения диалпланов в MikoPBX — это набор инструментов, которые позволяют настраивать индивидуальные сценарии обработки звонков внутри системы. С их помощью вы можете определить последовательность действий, которую система выполнит при поступлении или совершении вызова. Это может включать перенаправление звонка на определенный внутренний номер, воспроизведение специальных аудиосообщений, запрос дополнительной информации у звонящего или выполнение других функций.
Используя приложения диалпланов, вы можете гибко настроить логику работы телефонной системы под потребности вашего бизнеса, не углубляясь в сложное программирование. Это облегчает создание сложных сценариев обработки вызовов, позволяя улучшить эффективность коммуникаций и повысить уровень обслуживания клиентов.
Раздел «Сетевой экран» в MikoPBX — это интерфейс для настройки брандмауэра (Firewall) системы. Здесь администраторы могут создавать и управлять правилами фильтрации сетевого трафика, контролируя доступ к MikoPBX и защищая ее от несанкционированного доступа и сетевых угроз. Настройка сетевого экрана обеспечивает безопасность телефонной системы, предотвращая потенциальные атаки и обеспечивая стабильную работу в сетевой инфраструктуре организации.
Защита от взлома (Fail2Ban)
Раздел «Защита от взлома (Fail2Ban)» в MikoPBX — это инструмент для обеспечения безопасности системы от несанкционированного доступа и сетевых атак. Fail2Ban мониторит журналы событий и автоматически блокирует IP-адреса, с которых происходят подозрительные или многократные неудачные попытки входа. Настройка этого раздела помогает предотвратить взлом системы и защитить конфиденциальные данные организации.
yc compute instance list
+----------------------+-----------------+---------------+---------+-----------------+-------------+
| ID | NAME | ZONE ID | STATUS | EXTERNAL IP | INTERNAL IP |
+----------------------+-----------------+---------------+---------+-----------------+-------------+
| ef38gedvuug8qvv4l74p | test | ru-central1-c | RUNNING | 51.250.39.55 | 10.130.0.6 |
+----------------------+-----------------+---------------+---------+-----------------+-------------+
Что такое MikoPBX?
MikoPBX - это бесплатный сервер телефонии с операционной системой и простым, удобным веб-интерфейсом. Она работает практически с любой телефонной технологией в мире.
Интерфейс MikoPBX
MikoPBX — это полностью модульный интерфейс для Asterisk, написанный на PHP и Javascript. Это значит что в MikoPBX возможно реализовать абсолютно любой дополнительный функционал Asterisk телефонии. Более того, если вы разработаете полезный модуль, его можно поместить в общий репозиторий и сделать доступным для всех пользователей MikoPBX. Помимо этого, MikoPBX имеет очень низкие требования к аппаратному обеспечению ПК:
Одновременные звонки
Минимально рекомендуемая конфигурация
5 - 10
1 GHz x86-64, 512 MB RAM
До 25
3 GHz x86-64, 1 GB RAM
Более 25
2 CPUs 3 GHz x86-64, 2 GB RAM или больше
С чего начать?
Для начала вам следует установить MikoPBX любым удобным для вас способом. Ниже находятся опции установки. Нажав на их название - вы можете перейти к подробным профильным статьям:
После установки вы можете перейти к изучению вашей станции. В этом вам поможет дальнейшая документация "Руководство пользователя", которая подробно рассказывает про конкретные разделы:
Управление модулями - здесь подробно описан процесс установки и управления модулями.
Документация по конкретным модулям - в этом разделе вы найдете подробное описание каждого модуля, а так же шаги по его настройки и использованию.
Раздел FAQ
В данной секции Вы можете найти ответы на интересующие вас вопросы, а так же решения, которые помогут вам расширить функционал базовых функций. Данная секция, так же, как и основная разделена на разделы для удобства поиска интересующих вас тем.
Если у вас возник вопрос, который не разобран в данном разделе - Вы можете обратиться за помощью в Telegram Community, где пользователи MikoPBX помогают друг другу решить вопросы и потребности, связанные с АТС.
Данные по умолчанию:
Логин - admin
Пароль - admin
Страница авторизации в web-интерфейс
После первой успешной авторизации, MikoPBX автоматически откроет настройки для смены пароля. Поменяйте пароль и нажмите "Сохранить".
Первая авторизация в WEB-интерфейс MikoPBX
Более подробную информацию об Общих настройках в разделе Системных настроек.
После смены пароля система будет полностью готова к работе. Рекомендуется сразу же настроить правила firewall. Прочитать про то, как это сделать, можно по ссылке.
IP-адрес MikoPBX для подключения к WEB-интерфейсу
Системные требования
В данной статье вы сможете найти системные требования для MikoPBX.
Требование к сетевому каналу
Пример расчета необходимой пропускной способности канала для различных кодеков на 30 одновременных звонков. АТС поддерживает наиболее популярные кодеки:
G.711 - 4.67 Mbps
GSM - 1.68 Mbps
G.722 - 4.67 Mbps
G.729 - 1.38 Mbps
Расчет ориентировочный, при использовании одного кодека на всех устройствах, подключенных к АТС. Подробнее .
Минимальные системные требования
Мы рекомендуем использовать два жестких диска для развертывания АТС.
Жесткий диск объемом 800 Mb для основной системы
Жесткий диск объемом 50+ Gb для записей разговоров
1 (2 ядра) процессор x86-64
ПК, с такими параметрами, в наших тестах, держит 38 одновременных входящих звонков при условиях:
К очереди подключено 10 агентов (все online)
Ориентировочно, 1 час разговора занимает 14Мб места на диске. Для диска хранения записей разговоров рекомендуемый размер - не менее 50 гигабайт.
Телефония
Описание раздела телефонии MikoPBX
Глава "Телефония" в документации MikoPBX содержит подробную информацию и инструкции, связанные с настройкой и использованием телефонии в системе.
Сотрудники в MikoPBX — это индивидуальные пользователи системы, которым назначены внутренние номера для совершения и приема звонков. Они имеют персональные учетные записи, позволяющие настроить права доступа, переадресацию вызовов и другие персональные настройки в системе.
В данной статье Вы найдете подробную документацию по добавлению новых сотрудников в станцию, настройку их прав и профилей. Помимо этого, информацию про их дополнительные параметры.
Очереди вызовов
Очереди вызовов в MikoPBX — это функция, позволяющая распределять входящие звонки между группой операторов, удерживая вызовы в очереди до момента, когда оператор станет доступен. Это обеспечивает эффективное управление большим потоком звонков и улучшает качество обслуживания клиентов.
В данной статье Вы найдете подробную документацию по созданию и настройке таких очередей.
IVR меню
IVR меню в MikoPBX — это интерактивное голосовое меню, которое позволяет звонящим взаимодействовать с телефонной системой с помощью нажатия клавиш или голосовых команд. Оно автоматически направляет вызовы к нужным отделам или сотрудникам, улучшая эффективность обработки звонков и повышая качество обслуживания клиентов.
В данной статье вы найдете документацию по созданию и настройке IVR меню.
Конференции
Конференции в MikoPBX — это функция, позволяющая организовывать групповые телефонные звонки с участием нескольких абонентов одновременно. Она позволяет проводить коллективные обсуждения, совещания и встречи по телефону, улучшая коммуникацию как внутри компании, так и с внешними партнерами.
В данной статье вы найдете документацию по созданию и настройке комнат конференций.
Звуковые файлы
Звуковые файлы в MikoPBX — это аудиозаписи, которые используются системой для воспроизведения различных сообщений, таких как приветствия, объявления, инструкции в IVR-меню или сигналы ожидания. Они позволяют персонализировать аудиоконтент, который слышат звонящие, улучшая взаимодействие с системой и предоставляя необходимую информацию.
В данной статье вы найдете подробную информацию про них, а так же способы добавления и их редактирования.
История вызовов
История вызовов в MikoPBX — это журнал, который сохраняет информацию о всех входящих и исходящих звонках через систему. Она предоставляет детальные данные о каждом вызове, включая время, длительность, номера участников и статус, что позволяет анализировать коммуникации и оптимизировать работу телефонной сети компании.
В данной статье Вы найдете информацию про хранение записей разговоров и их фильтров.
Установка докера и cоздание пользователя и каталогов
Подготовка к установке MikoPBX в Docker-контейнер
Установка Docker и Docker Compose на Ubuntu 22.04
Перед началом работы с Docker, необходимо установить сам Docker и Docker Compose. Вот как это можно сделать:
# Обновление списка пакетов и установка необходимых зависимостей
sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common
# Добавление ключа GPG официального репозитория Docker
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
# Добавление репозитория Docker в список источников APT
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
# Установка Docker CE
sudo apt update
sudo apt install docker-ce
# Установка Docker Compose
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
# Проверка версии Docker Compose
sudo docker-compose --version
Создание пользователя и каталогов на хост-системе
Перед созданием контейнера на хостовой машине необходимо создать пользователя и группу с ограничеными правами, а также папку для хранения настроек конфигурации и записей разговоров.
Скачайте актуальный образ системы с расширением .raw на
Выполните авторизацию на портале
Перейдите в раздел "Облако" - "Образы" - кликните по кнопке "Создать"
Создание сервера
Перейдите в раздел "Облако" - "Серверы" - кликните по кнопке "Создать"
Введите имя сервера
В поле "Флейвор" выберите конфигурацию сервера
Вход в web интерфейс
После создания сервера можно перейти к его статусу в разделе "Облако" - "Серверы"
Пароль для входа в вэб интерфейс по умолчанию устанавливается в значение, равному "instance-id", на текущий момент нет возможности получить этот идентификатор из web интерфейса Vscale.
Для получения пароля от web интерфейса в перейдите на вкладку "Логи":
Теперь можно перейти по публичному адресу и начать настройку АТС.
Маршрутизация
Описания раздела маршрутизации MikoPBX
Раздел «Маршрутизация» в MikoPBX — это интерфейс для настройки правил направления вызовов внутри телефонной системы. Здесь администраторы могут определить, как обрабатывать входящие и исходящие звонки, устанавливая условия и маршруты для эффективного распределения звонков между сотрудниками, отделами или внешними линиями.
Провайдеры телефонии в MikoPBX — это раздел системы, где настраиваются подключения к внешним операторам связи через интернет-протоколы для IP-телефонии. Здесь администраторы могут добавлять и настраивать учетные записи SIP-транков или других типов соединений, которые позволяют системе совершать и принимать звонки с городских и мобильных номеров.
В данной статье Вы найдете подробную документацию по подключению провайдеров к станции, их настройку и особенности.
Входящие маршруты (Входящая маршрутизация)
Входящие маршруты в MikoPBX — это набор правил, определяющих, как система обрабатывает входящие звонки от внешних провайдеров телефонии. С их помощью администраторы могут настраивать направления вызовов в зависимости от различных условий, таких как номер вызывающего абонента, время суток или конкретный номер, на который поступил звонок. Это позволяет автоматически распределять входящие звонки на определенных сотрудников, отделы, IVR-меню или очереди вызовов. Настройка входящих маршрутов способствует оптимизации обработки вызовов и повышению качества обслуживания клиентов, обеспечивая гибкое и эффективное управление телефонными коммуникациями в компании.
В данной статье Вы найдете подробную документацию по настройке входящей маршрутизации.
Исходящие маршруты (Исходящая маршрутизация)
Исходящие маршруты в MikoPBX — это набор правил и настроек, определяющих, как система обрабатывает исходящие звонки от сотрудников к внешним номерам. С их помощью администраторы могут управлять направлением вызовов через различные провайдеры телефонии или линии связи в зависимости от определенных условий, таких как набранный номер, префиксы, время суток или права доступа пользователя. Это позволяет оптимизировать затраты на связь, распределять нагрузку между каналами и применять политики безопасности, ограничивая или разрешая определенные типы вызовов. Настройка исходящих маршрутов обеспечивает гибкость и контроль над исходящей телефонной связью, способствуя эффективной работе коммуникационной системы компании.
В данной статье Вы найдете подробную документацию по настройке исходящей маршрутизации.
Нерабочее время
Нерабочее время в MikoPBX — это инструмент для настройки правил обработки вызовов в периоды, когда компания не работает, например, ночью, в выходные или праздничные дни. С его помощью администраторы могут определить, как система будет обрабатывать входящие звонки в нерабочие часы: перенаправлять на автоответчик, воспроизводить специальные голосовые сообщения или переадресовывать вызовы на мобильные номера дежурных сотрудников. Это позволяет обеспечить корректное взаимодействие с клиентами вне рабочего времени и поддерживать высокий уровень обслуживания.
В данной статье Вы найдете подробную документацию по настройке нерабочего времени для Вашей станции.
Звуковые файлы
Добавление/создание звуковых файлов в MikoPBX
Звуковые файлы в MikoPBX — это аудиозаписи, которые используются системой для воспроизведения различных сообщений, таких как приветствия, объявления, инструкции в IVR-меню или сигналы ожидания. Они позволяют персонализировать аудиоконтент, который слышат звонящие, улучшая взаимодействие с системой и предоставляя необходимую информацию.
Загрузка звукового файла на АТС
Поддерживаемый формат файлов mp3 и wav
Звуковые файлы в MikoPBX используются в различных сценариях звонков и интерактивных голосовых меню (в IVR меню, в Нерабочем времени, в Очередях вызовов и для разных системных оповещений, а также В музыке на удержании) для воспроизведения голосового приветствия или оповещения клиента.
Список доступных звуковых файлов отображается в разделе "Телефония" -> "Звуковые файлы".
Для добавления нового звукового файла нажмите "Добавить звуковой файл".
Нажмите Загрузить и выберите звуковой файл.
Откорректируйте наименование файла при необходимости.
Сохраните изменения.
При работе по протоколу https есть возможность записать звуковой файл с использованием микрофона. При работе по https должен использоваться доверенный сертификат.
Звуковые файлы хранятся на АТС по пути /storage/usbdisk1/mikopbx/media/custom
Музыка на удержании
Функция доступна начиная с версии 2020.2.XXX
Если клиент при звонке попадает в очередь или ожидает переадресацию, АТС проигрывает для него мелодию. Есть возможность загрузить свои мелодии для прослушивания во время ожидания.Это можно сделать на вкладке Музыка на удержании описанным выше способом.
Защита от взлома
В данном разделе производится настройка Fail2ban.
Fail2ban включается вместе с Сетевым экраном переключателем в разделе Сеть и Firewall → Сетевой экран.
Переключатель "Сетевой экран и защита от взлома включены"
Сервис Fail2ban блокирует IP адреса с нестандартной активностью.
При неудачной попытке авторизации в лог АТС попадет информация об ошибке, Fail2ban анализирует все неудачные попытки авторизации и считает их. Когда количество неудачных попыток авторизации превышает максимально допустимое количество, IP-адрес отправляется в бан.
Будьте внимательны, Fail2ban не поможет при использовании простых паролей.
Настройки защиты от взлома можно найти в боковом меню:
Если происходит определенное число неудачных попыток входа "Количество попыток для блокировки" в течение определенного периода "В течение (секунд)", IP адрес будет заблокирован в течение заданного периода времени "Блокировать на (секунд)".
Белый список адресов определяет IP - адреса, которые не будут заблокированы Fail2ban. Указывать можно как ip адрес 93.188.40.10, так и подсеть 93.188.40.0/24
Список заблокированных адресов показывает , какие IP-адреса в настоящее время заблокированы.
Так же вы можете разблокировать адрес кликом на соответствующую кнопку в таблице.
Настройка Yandex Mail (Логин, Пароль)
Настройка почты для сервиса Yandex
Для получения уведомлений о пропущенных вызовах по электронной почте необходимо настроить SMTP-клиент. Подробная информация об уведомлениях в MikoPBX рассмотрена здесь. В рамках данной инструкции будет рассмотрен пример настройки уведомлений о пропущенных вызовах для почтового сервиса Yandex.
Документация Yandex по настройки smtp.
Для большей безопасности следует использовать «Пароли приложений». Не используйте основной пароль от почтового ящика.
Введем IP адрес АТС MikoPBX в браузере и перейдем в Система → Почта и уведомления.
Настройки SMTP клиента для сервиса Yandex:
SMTP хост - smtp.yandex.ru
SMTP Порт - 465 (Порт для обслуживания клиентов)
Адрес отправителя и Логин - E-mail с которого будут отправляться сообщения о пропущенных вызовах
Осуществим отправку тестового письма на электронную почту любого сервиса. В случае успешного тестирования на указанный Вами адрес электронной почты придет тестовое письмо.
О том, как настроить шаблон письма для создания e-mail уведомлений вы можете прочитать .
Установка на MDADM RAID1
Подготовка
ВНИМАНИЕ: Все данные на дисках будут уничтожены.
Подготовьте ПК с двумя дисками одинакового объема
Загрузите машину в режиме
Подключитесь к машине через
Сборка RAID 1
Выполните в консоли команду.
Будут отображены имена дисков. В моем случае это.
Затираем суперблоки на дисках.
Чистим старые метаданные.
Создаем RAID1.
На вопрос «Continue creating array?» отвечаем утвердительно "y".
Далее можно начать установку . При выборе диска следует указать md0
Полезные статьи
Grub
TODO: Необходимо править grub.cfg файл. Иначе, не факт, что при сбое одного из дисков, система загрузится.
Yandex Cloud
Варианты установки MikoPBX в Yandex Cloud
В сервисе Yandex Cloud есть возможность загрузить АТС MikoPBX из образа в маркетплейсе Яндекса или из образа на основе загруженного *.raw файла из дистрибутива MikoPBX (промежуточные релизы)
Обновление из консоли MikoPBX
Вариант обновления из консоли MikoPBX
Ниже приведен пример с АТС, установленной на виртуальную машину VirtualBOX. Обновление производится с версии 2022.2.102 до версии 2022.3.15.
Скачайте из репозитория iso-образ нужной вам версии АТС.
iso-образ в репозитории релизов MikoPBX
В программе VirtualBOX откройте настройки виртуальной машины на которой установлена АТС.
Перейдите в раздел Носители.
Выделите виртуальный оптический привод.
Нажмите на значок в группе Атрибуты, нажмите Выбрать файл диска.
Выберите скачанный iso-образ АТС.
Запустите машину.
Выбор файла диска в интерфейсе VirtualBox
В консоли отобразится соответствующая строка "The system loaded in Recovery mode" («АТС загружена в режиме восстановления» на русском).
Консоль MikoPBX
Выберите Install / Repair (или нажмите на клавиатуре цифру 8) и нажмите «Enter».
Вам нужна команда "Update to version ****.*.**". Нажмитена клавиатуре цифру 2, затем нажмите «Enter».
Начнется установка обновления. Когда она завершится, АТС перезагрузится.
После перезагрузки АТС сообщения "The system loaded in Recovery mode" уже не будет, что означает, что АТС загрузилась с жесткого диска, а не с виртуального оптического привода.
Вверху зеленым шрифтом будет обозначена установленная версия обновления.
Обновление Docker
Вариант обновления для MikoPBX в Docker контейнере
Для обновления контейнера MikoPBX до последней версии, вы можете выполнить следующие шаги в командной строке. Эти шаги включают остановку текущего контейнера, скачивание новой версии образа и запуск контейнера с использованием обновлённого образа.
Обновление Docker контейнера
Для начала нужно корректно остановить работающий контейнер. После остановки контейнера его можно безопасно удалить
Для запуска нового контейнера с использованием последней версии образа и теми же настройками, что и ранее (включая монтирование томов и прочие параметры сети), воспользуйтесь следующими командами:
AWS Маркетплейс
Установка MikoPBX с помощью образа из AWS Маркетплейса
Авторизуйтесь в сервисе Amazon Web Services
MikoPBX в AWS Маркетплейс:
Приступим к настройке
Для быстрого и удобного поиска в сервисе Amazon используйте панель поиска
Нерабочее время
Настройка правил нерабочего времени
Назначение
«Нерабочее время» в MikoPBX — это инструмент для настройки правил обработки вызовов в периоды, когда компания не работает, например, ночью, в выходные или праздничные дни. С его помощью администраторы могут определить, как система будет обрабатывать входящие звонки в нерабочие часы: перенаправлять на автоответчик, воспроизводить специальные голосовые сообщения или переадресовывать вызовы на мобильные номера дежурных сотрудников. Это позволяет обеспечить корректное взаимодействие с клиентами вне рабочего времени и поддерживать высокий уровень обслуживания.
Сетевой экран
Описание и настройка Firewall правил в MikoPBX
Сетевой экран в MikoPBX — это интерфейс для настройки брандмауэра (Firewall) системы. Здесь администраторы могут создавать и управлять правилами фильтрации сетевого трафика, контролируя доступ к MikoPBX и защищая ее от несанкционированного доступа и сетевых угроз. Настройка сетевого экрана обеспечивает безопасность телефонной системы, предотвращая потенциальные атаки и обеспечивая стабильную работу в сетевой инфраструктуре организации.
В MikoPBX все локальные подсети возможно описать в разделе «Сеть и Firewall» → «Сетевой экран». Сетевой экран предназначен для ограничения доступа к станции по типу трафика и подсетям.
Для того, чтобы добавить новое правило, необходимо нажать на кнопку "Добавить новую подсеть":
Настройка Gmail (Архив)
Настройка почты для сервиса gmail
Всегда используйте «Пароли приложений» для авторизации. .
smtp от Gmail
Для получения уведомлений о пропущенных вызовах по электронной почте необходимо настроить SMTP-клиент. Подробная информация об уведомлениях в MikoPBX рассмотрена . В рамках данной инструкции будет рассмотрен пример настройки уведомлений о пропущенных вызовах для почтового сервиса Gmail.
Перезагрузка и выключение системы
Описание возможностей раздела
Перезагрузка станции через интерфейс MikoPBX
Меню выключения/перезагрузки системы вы можете найти в MikoPBX в "Перезагрузка" -> "Обслуживание".
При открытии страницы будет отображен список активных звонков на АТС. Отображается дата начала звонка, «Кто» и «Кому» звонит.
Система
Описание раздела "Система" в MikoPBX
Раздел «Система» в MikoPBX — это интерфейс для управления общими настройками и параметрами телефонной системы. Здесь администраторы могут настраивать основные системные параметры, управлять обновлениями, датой и другими функциями, обеспечивающими стабильную и безопасную работу MikoPBX. Этот раздел позволяет контролировать и оптимизировать работу системы на уровне всей инфраструктуры.
Общие настройки
В разделе «Общие настройки» в MikoPBX администраторы могут управлять основными параметрами системы, такими как настройки срока хранения записей разговоров, уведомления, параметры журналов, язык звуковых оповещений и многими другими системными опциями. Этот раздел обеспечивает контроль над общими функциями и поведением MikoPBX, позволяя оптимизировать работу системы под потребности организации.
Настройка Proton (Логин, Пароль)
Настройка почты для сервиса proton.me
Генерация SMTP токена
Для начала, перейдите в настройки своего аккаунта Proton ().
Обновление из web-интерфейса
Вариант обновления из web-интерфейса
В некоторых разделах интерфейса (например, Сотрудники) в правом нижнем углу указана текущая версия MikoPBX.
В web-интерфейсе АТС перейдите в Обслуживание → Обновление PBX.
Если есть версии АТС новее вашей текущей, они будут отображены в таблице Доступны онлайн обновления, в которой в первом поле номер версии, а во втором - список изменений.
Конференции
Создание и настройка конференций в MikoPBX
Конференции в MikoPBX — это функция, позволяющая организовывать групповые телефонные звонки с участием нескольких абонентов одновременно. Она позволяет проводить коллективные обсуждения, совещания и встречи по телефону, улучшая коммуникацию как внутри компании, так и с внешними партнерами.
Создание конференц-комнат
Список конференц-комнат располагается в разделе "Телефония" -> "Конференции".
2Gb оперативной памяти
Сетевой адаптер
Каждую секунду поступает новый звонок
Клиенту во время ожидания воспроизводится музыка (MOH)
Обратите внимание, что если Вы в разделе «Сетевой экран» для подсети указали настройку «Никогда не блокировать адреса из этой сети», то подсеть автоматом попадает в белый список и добавлять ее вручную не требуется. Не нужно пытаться наполнять вручную список белых IP-адресов, желательно в исключительных случаях прописывать IP-адреса.
Максимальное количество входящих пакетов SIP - опция позволяет ограничить количество пакетов с одного IP адреса в секунду. Если ограничение будет превышено, новые пакеты будут отброшены. Это может повысить устойчивость сервера к атакам.
Раздел "Защита от взлома"
Параметры защиты
Список заблокированных адресов
Магазин приложений
Инструкция по установке готового образа из Яндекс Маркетплейс
Произвольный образ
Подробная инструкция по загрузке MikoPBX из произвольного образа
Утилита коммандной строки yc
Установка MikoPBX в Yandex Cloud с помощью утилиты yc
Установка обновления
Обновленная версия
Дата и время
Раздел «Дата и время» в MikoPBX — это интерфейс для настройки системных параметров даты и времени. Здесь администраторы могут установить текущую дату и время, выбрать часовой пояс и настроить синхронизацию с серверами точного времени (NTP). Корректная настройка даты и времени важна для точной регистрации событий, журналов вызовов и работы функций, зависящих от расписания, обеспечивая синхронизацию системы с другими сетевыми устройствами и сервисами.
Почта и уведомления
Раздел «Почта и уведомления» в MikoPBX позволяет настроить отправку системных уведомлений через электронную почту. Здесь администраторы указывают параметры SMTP-сервера, определяют события для уведомлений, такие как голосовые сообщения или системные ошибки, и редактируют шаблоны писем. Этот раздел помогает своевременно информировать пользователей и администраторов о важных событиях, обеспечивая эффективный контроль за работой системы.
Доступ к AMI
Раздел «Доступ к AMI» в MikoPBX — это интерфейс для настройки доступа к Asterisk Manager Interface (AMI). Здесь администраторы могут управлять параметрами подключения к AMI, такими как включение или отключение доступа, указание логинов и паролей для аутентификации. Настройка доступа к AMI позволяет внешним приложениям или скриптам взаимодействовать с системой MikoPBX для мониторинга и управления звонками, расширяя функциональные возможности телефонной системы.
Кастомизация системных файлов
Раздел «Кастомизация системных файлов» в MikoPBX предоставляет администраторам возможность напрямую изменять или дополнять стандартные конфигурационные файлы системы. Здесь вы можете внести индивидуальные настройки, которые не доступны через стандартный веб-интерфейс, и адаптировать поведение системы под специфические требования вашей организации.
Этот раздел предназначен для продвинутых пользователей, которые обладают глубоким пониманием структуры и работы MikoPBX. С его помощью можно:
Редактировать конфигурационные файлы: вносить изменения в существующие файлы или добавлять новые параметры.
Переопределять стандартные настройки: изменять значения по умолчанию для определенных функций или модулей.
Добавлять собственные скрипты или модули: расширять функциональность системы путем интеграции пользовательских решений.
Важно отметить, что неправильное изменение системных файлов может привести к нестабильной работе или сбоям системы. Поэтому рекомендуется создавать резервные копии перед внесением изменений и тщательно проверять корректность настроек.
# Создание нового пользователя (например, www-user) без прав суперпользователя
sudo adduser --disabled-password --gecos "" www-user
# Создание каталогов для хранения данных
sudo mkdir -p /var/spool/mikopbx/cf
sudo mkdir -p /var/spool/mikopbx/storage
# Назначение прав созданному пользователю на каталоги
sudo chown -R www-user:www-user /var/spool/mikopbx/
Для начала нужно корректно остановить работающий контейнер. После остановки контейнера его можно безопасно удалить
Следующий шаг — это скачивание последней версии образа MikoPBX:
Пример файла docker-compose.yml, который может быть использован для обновления вашего контейнера MikoPBX через Docker Compose:
Сохраните содержимое в файл docker-compose.yml, выполните необходимые корректировки и запускайте командой:
Примечания
Данные: Поскольку данные сохраняются в Docker Volume, они остаются нетронутыми при обновлении, что позволяет сохранить настройки и пользовательские данные.
Переменные окружения: Убедитесь, что все необходимые переменные окружения передаются корректно.
Безопасность: Перед обновлением всегда рекомендуется создать резервные копии ваших данных.
Эти шаги помогут обеспечить гладкое и безопасное обновление вашего контейнера MikoPBX.
Чтобы добавить новое правило нажмите на кнопку Добавить интервал времени.
Создание нового правила нерабочего времени
Откроется форма создания нового правила.
Форма создания нового правила
В ней есть возможность указать:
Период - календарный период отсутствия сотрудников в офисе. Например, на время новогодних или майских праздников
Дни недели - конкретные дни недели, для которых будет выполняться данное правило
Период времени - период времени отсутствия сотрудников в течении суток.
Применять только к определенным входящим маршрутам - можно активировать эту функцию и с помощью нее выбирать на какие входящие маршруты будет распространяться данное правило. (Подробнее ниже)
Действие с входящим вызовом - можно выбрать проиграть звуковой файл или перевести вызов. Перевести вызов можно на конференцию, IVR меню, очередь, внутренний номер сотрудника или служебные номера завершения вызова.
В поле Комментарий можно заметку, с описанием созданного правила, чтобы по данному описанию можно было быстро сориентироваться о сущности данного правила.
Кнопкой с ластиком можно очистить поля, напротив которых эта кнопка располагается.
Применять только к определенным входящим маршрутам
Активировав эту функцию, сверху у вас появится новое меню "Ограничения по маршрутам"
Параметр "Применять только к определённым маршрутам"
Здесь вы можете выбрать к каким конкретно маршрутам будет применяться создаваемое вами правило.
Раздел "Ограничения по маршрутам"
Примеры правил
Данным правилом указываются звонки с конца рабочего дня (19:00) и до начала рабочего дня (9:00).
Пример правила №1
Данным правилом указываются звонки по выходным дням: в субботу и воскресенье.
Пример правила №2
Раздел "Нерабочее время" в MikoPBX
Общие настройки
Название - задайте произвольное имя для нового правила сетевого экрана.
Справа от адреса подсети находится поле Маска подсети в формате CIDR.
Параметры правила
Доступные сервисы
SIP&RTP-регистрация телефонов и голосовой трафик - Session Initiation Protocol используется для установки соединений между VoIP телефонами
WEB-доступ к административному интерфейсу настройки АТС
SSH-root доступ к системе. SSH(Secure Shell) позволяет получить доступ к консоли MikoPBX.
AMI-доступ к asterisk manager api через telnet. Asterisk Manager Interface (AMI) предоставляет доступ к Asterisk по TCP/IP протоколу.
AJAM - доступ к asterisk manager api, через http, https
ICMP-проверка связи командой ping
CTICLIENT-подключение панели телефонии для 1С
Раздел "Доступные сервисы"
Дополнительные параметры
У каждой подсети есть флаг «Это VPN или локальная сеть». При установке этого флага MikoPBX будет представляться всем локальным подсетям локальным IP, а не внешним.
Флаг «Никогда не блокировать адреса из этой сети» следует включать только для доверенных подсетей. Если включен данный флаг, то правила защиты от взлома на данную подсеть не распространяются.
Раздел "Дополнительные параметры"
Раздел "Сеть и Firewall" -> "Сетевой экран" в MikoPBX
Элемент для создания нового правила
Введем IP адрес АТС MikoPBX в браузере и перейдем в Система → Почта и уведомления.
Раздел "Почта и уведомления"
Настройки SMTP клиента для сервиса Gmail:
SMTP хост - smtp.gmail.com
SMTP Порт - 465 (Порт для обслуживания клиентов)
Адрес отправителя и Логин - E-mail с которого будут отправляться сообщения о пропущенных вызовах
Пароль - пароль от электронной почты, необходимый для авторизации
Метод шифрования - Использовать TLS
Параметры настроек отправки сообщений
Сохраним введённые настройки и перейдем к настройке Вашего почтового аккаунта. Особенностью сервиса Gmail является то, что к Вашему аккаунту автоматически запрещен доступ ненадежным приложениям, к которым относится MikoPBX, поэтому необходимо вручную разрешить доступ к данным приложениям (инструкции по настройке размещены здесь).
Возвращаемся в Система → Почта и уведомления. Осуществим отправку тестового письма на электронную почту любого сервиса. В случае успешного тестирования на указанный Вами адрес электронной почты придет тестовое письмо.
О том, как настроить шаблон письма для создания E-mail уведомления вы можете прочитать здесь.
Пока есть активные вызовы перезагрузка и отключение не будут доступны через web интерфейс.
Список активных звонков
«Перезагрузить АТС» - команда начинает перезагрузку станции.
«Выключение АТС» - завершает все процессы и отключает станцию.
Опции выключения/перезагрузки системы
Перезагрузка станции через консольное меню
Вы можете перезагрузить станцию через консольное меню. Для этого выберете раздел «[3] Перезагрузить систему».
Консоль MikoPBX
Если вы хотите перезагрузить станцию: нажмите «[1] Перезагрузить MikoPBX».
Если вы хотите выключить станцию: нажмите «[2] Выключить».
Перезагрука/выключение станции
Перезагрузка с проверкой диска
В случае аварийной перезагрузки АТС (например, выключение электроэнергии) может потребоваться выполнить проверку диска на ошибки.
В консольном меню АТС введите команду «[9] Консоль(Shell)» и нажмите Enter
Система запустит консоль АТС.
Консольное меню MikoPBX
Введите команду Reboot. Нажмите Enter
Система перезагрузится с проверкой диска.
Команда Reboot
Раздел "Обслуживание" -> "Перезагрузка"
Далее перейдите в раздел "Proton Mail" -> "IMAP/SMTP".
Раздел "IMAP/SMTP"
Далее пролистайте до секции "SMTP submission". Нажмите "Generate token".
Кнопка для создания нового токена "Generate token"
Введите произовольное название в поле "Token name" - MikoPBX в нашем случае, так же выберите Email address для которого Вы создаете токен.
Создание нового SMTP токена
Будет создан токен. Его параметры будут показаны один раз и когда Вы закроете окно, станут недоступны. Сохраните их, мы будем использовать их для дальнейшей настройки.
Параметры созданного токена
Подключение в MikoPBX
Перейдите в раздел "Система" -> "Почта и уведомления".
Раздел "Система" -> "Почта и уведомления".
Перейдите в "Настройки SMTP". Заполните все необходимые параметры:
Адрес отправителя - Ваш адрес электронной почты, под которым Вы генерировали токен.
Имя отправителя - имя от которого отправляется почта.
Тип аутунтификации - "Логин и пароль".
SMTP логин - SMTP Username из окна с данными токена.
SMTP пароль - SMTP token из окна с данными токена.
Рекомендуем проводить обновления последовательно, «не перепрыгивая» через релизы.
Раздел "Доступные онлайн обновления"
Далее возможны два варианта обновления: обновление онлайн, обновление скачанным img-файлом.
Обновление онлайн
Будьте внимательны! Если система установлена на тот же диск, где хранятся записи разговоров, то могут быть сложности с обновлением. см. форум
Обновления загружаются на АТС и сразу же применяются.
Для обновления таким способом нажмите кнопку в нужной вам версии обновления.
Кнопка для обновления системы
Появится окно предупреждения. Нажмите в нем Обновить.
Окно предупреждения
АТС загрузит и применит обновления, а затем перезагрузится.
Обновление скачанным img-файлом
Следует сразу заметить, что данным способом можно выполнить не только обновление, но и откат на более прежнюю версию.
Для обновления данным способом нажмите кнопку в нужной вам версии обновления.
Кнопка для загрузки файла обновления
Начнется скачивание img-образа. Дождитесь завершения загрузки.
Затем нажмите кнопку и выберите данный img-файл.
Выбор файла для обновления
Затем нажмите Применить обновление, а в появившемся окне предупреждения нажмите Обновить.
Установка обновления
Начнется применение обновлений. После окончания которого АТС перезагрузится.
Процесс обновления
Отображение версии в web-интерфейсе
Раздел "Обновление PBX"
Для создания новой конференц-комнаты нажмите кнопку Добавить конференцию.
Кнопка "Добавить конференцию"
Необходимо указать название конференции и ее внутренний номер, позвонив на который можно в эту конференцию зайти.
Название и внутренний номер конференции
Для того чтобы в конференцию не могли зайти сотрудники, для которых это обсуждение не предназначено, можно защитить конференц-комнату паролем. Для этого заполните поле cr_pinCode.
В это поле можно вводить только цифры, минимум одна цифра.
Установка пин-кода для входа в конференцию
В этом случае для того чтобы попасть в данную конференцию сотруднику после набора номера конференции необходимо будет ввести пин-код.
Характерные особенности конференц-связи
Все собеседники общаются только голосом (никаких других способов передачи информации, кроме речевого, не предоставляется);
все собеседники могут говорить и слышать друг друга одновременно (то есть обеспечивается дуплексная связь);
участники используют для общения телефоны (аппаратные или программные).
Использование
Каждый участник конференции звонит на номер конференции. Первый участник слышит музыку на удержании до тех пор, пока к конференции не присоединится хотя бы еще один участник.
Сотрудник может перевести своего собеседника в конференцию, реализовав перевод с помощью комбинации стар-кодов на своем телефоне. Перевести в конференцию можно как внутренний номер, так и внешний. Комбинация для переводов задается в разделе "Система" -> "Общие настройки" -> "Переводы вызовов".
Пример:
Сотрудник набирает комбинацию **1111 (комбинация для безусловного перевода) и его собеседник попадает в конференцию и становится её первым участником. У переводившего сотрудника вызов завершается, и, чтобы попасть в конференцию он звонит на номер конференции 1111.
Максимальное количество участников конференции не ограничено.
Раздел "Телефония" -> "Конференции"
Proxmox LXC контейнер
Установка MikoPBX в LXC контейнер
Proxmox LXC — это легковесные контейнеры в составе платформы виртуализации Proxmox VE, работающие на базе технологии LXC (Linux Containers). Они позволяют запускать изолированные Linux-системы с минимальным потреблением ресурсов по сравнению с полноценными виртуальными машинами.
Загрузка шаблона контейнера
Перейдите в "local" хранилище, далее "CT Templates". Нажмите "Download from URL" для перехода к диалогу загрузки шаблона из URL.
Перейдите на с релизами и скопируйте ссылку на скачивание файла-шаблона с расширением "lxc.tar.gz".
Вставьте ссылку в поле "URL", нажмите "Query URL". Если Вы скопировали правильную ссылку, то в поле "File name" будет подставлено название файла с расширением "lxc.tar.gz".
Нажмите "Download" для начала загрузки.
После окончания загрузки, Вы увидите надпись "TASK OK".
Создание LXC контейнера
Нажмите "Create CT" в правой верхней части интерфейса для создания нового контейнера.
Заполните все базовые параметры контейнера:
Hostname - укажите название для сервиса.
Password - укажите пароль для входа в Web-интерфейс MikoPBX.
SSH public keys - сгенерируйте и вставьте Ваш ssh-ключ. Далее Вы сможете использовать его для подключения к станции по SSH. Подробнее про генерацию ключей и SSH подключение можно прочитать .
Нажмите "Next".
Выберите ранее загруженный шаблон в разделе "Template".
Нажмите "Next".
Далее укажите размер системного диска. Рекомендуемое значение - 1 ГБ.
Нажмите "Add" для добавления нового диска.
Укажите размер второго диска: на нем будут храниться записи разговоров. Рекомендуемый размер - не менее 50 ГБ. Так же укажите путь к диску - "/storage".
Нажмите "Add" для добавления нового диска.
Укажите размер третьего диска для хранения конфигурации. Рекомендуемый размер - 0.5 ГБ. Так же укажите путь к диску - "/cf".
Нажмите "Next".
На следующей вкладке укажите количество ядер, которые будут использованы. Для небольшой компании можно указать 1-2 ядра (подробнее в ).
Нажмите "Next".
Далее укажите количество оперативной и Swap памяти для контейнера.
Swap — это область на диске, которую система использует как дополнительную память, когда заканчивается оперативная память (RAM). Она работает значительно медленнее RAM и служит резервом, чтобы система не завершала процессы при нехватке памяти.
Нажмите "Next".
В следующем разделе, выберите Ваши параметры сети. В нашем случае используется DHCP для получения IPv4. Firewall здесь можно не включать, но необходимо настроить его позже в MikoPBX (подробнее можно прочитать в ).
Нажмите "Next".
В разделе с настройкой параметров DNS нажмите "Next".
Вы увидите итоговую конфигурацию контейнера. Нажмите "Finish".
Первый запуск
Перейдите в окно управления созданного контейнера, нажав на его название. Нажмите на кнопку "Start" для запуска.
Далее перейдите во вкладку "Console". Дождитесь загрузки системы и найдите IP-адрес Web-интерфейса.
Введите его в адресную строку Вашего браузера. Далее произведите первую авторизацию в MikoPBX.
Данные для входа:
Login: admin
Password: пароль, который Вы задали на начальном этапе создания контейнера.
История вызовов
Просмотр и фильтр истории вызовов в MikoPBX
История вызовов в MikoPBX — это журнал, который сохраняет информацию о всех входящих и исходящих звонках через систему. Она предоставляет детальные данные о каждом вызове, включая время, длительность, номера участников и статус, что позволяет анализировать коммуникации и оптимизировать работу телефонной сети компании. Располагается в разделе "Телефония" -> "История вызовов".
Раздел "История вызовов"
Чем она полезна
История вызовов в MikoPBX позволяет:
Отобразить все вызовы;
Отобразить вызовы по отбору;
Визуально отобразить пропущенные вызовы из общего списка звонков;
Скачать/прослушать запись разговора.
Каждый элемент списка содержит информацию о:
номере телефона звонящего абонента (Кто);
номере телефона, на который звонили (Кому);
дате и времени свершения звонка (Дата звонка);
Вызовы, отмеченные красным цветом, являются пропущенными. Длительность разговора для пропущенных вызовов равна нулю, такие вызовы невозможно прослушать.
Для каждой записи истории звонков доступна возможность прослушивания и скачивания записи разговоров. Записи разговоров скачиваются локально на ПК в формате .mp3.
Каждая строка вызова содержит полную информацию об участниках разговора.
На скриншоте выше отображено следующее:
Вызов поступил на номер 79255283744;
На вызов ответила Белкина;
Белкина осуществила консультативный перевод на Шевченко;
Отборы
Для применения отбора нужно после ввода в поле значения нажать Enter.
В строке поиска истории вызовов можно реализовать следующие отборы:
1) Отбор по номеру телефона
В строке поиска можно ввести как внутренний номер сотрудника, так и номер клиента (внешний).
2) Отбор по двум номерам телефона
В строке поиска через пробел можно ввести два номера телефона. Если ввести "74952293042 302", то будут отображены все отвеченные вызовы между двумя номерами.
Отвеченные вызовы - это вызовы, имеющие длительность разговора больше 0 секунд, время голосового приветствия не учитывается.
3) Отбор по дате
При открытии истории звонков, журнал по умолчанию формируется на текущую дату. Установите нужный вам период и нажмите Применить.
4) Отбор по linkedid
linkedid - уникальный идентификатор звонка. Данным отбором удобно пользоваться, если необходимо найти вызов, исходя из данных .
Для применения этого отбора:
1. Откройте журнал звонков 1С;
2. Выделите нужную строку;
3. Нажмите Подробнее во встроенном плеере (или вызвав контекстное меню на данной строке);
4. Скопируйте поле Идентификатор;
5. Вставьте это значение в строку поиска истории вызовов MikoPBX и нажмите Enter.
DigitalOcean
Установка MikoPBX с помощью сервиса DigitalOcean
Инструкция актуальна для версии 2024.2.111 и новее!
В данной инструкции мы пошагово произведем установку MikoPBX с помощью облачной платформы DigitalOcean.
Перед началом Вам необходимо скопировать ссылку на актуальный образ MikoPBX с расширением .raw. Сделать это можно на github MikoPBX.
Загрузка образа в DigitalOcean
Перейдите в "Manage" -> "Backups & Snapshots"
Перейдите в "Custom Images" -> "Import via URL":
Вставьте ссылку на файл образа диска с расширением .raw, скопированную ранее.
Введите имя для образа, выберите регион для его загрузки (должен совпадать с будущим регионом виртуальной машины). В качестве операционной системы образа выберите "Unknown"
Нажмите "Upload image"
Дождитесь загрузки образа.
Создание виртуальной машины в облаке
Перейдите на главную страницу DigitalOcean.
Для перехода к создаю виртуальной машины, перейдите в "Create" -> "Droplets":
Выберите регион и датацентр для Вашей виртуальной машины.
Далее выберите ранее загруженный образ и конфигурацию для вашей виртуальной машины:
Перейдите во вкладку "Additional Storage". Здесь необходимо добавить второй диск, который будет использоваться для хранения записей разговоров. Для этого нажмите "Add volume" и укажите параметры для нового диска.
Рекомендуемый размер диска для хранения записей разговоров - от 50ГБ.
Перейдите в раздел "Choose authentication method". Здесь необходимо выбрать "SSH Key" и добавить связку ключей для SSH подключения. Подробнее прочитать про их создание Вы можете в следующих статьях:
Нажмите "Create Droplet".
Подключение к консоли и первый вход в WEB-Интерфейс
Подключение из консоли Digital Ocean
Перейдите в меню созданной машины. Дождитесь ее запуска. Далее подключитесь с помощью встроенной консоли в DigitalOcean (элемент на скриншоте).
После загрузки системы, перейдите в web-интерфейс, используя внешний IP-адрес, указаный в консоли (external).
Вставьте IP-адрес машины в строку браузера. После перехода на страницу авторизации в MikoPBX, используйте следующие данные для входа:
Логин - admin
Пароль - id Виртуальной машины, найти который Вы можете в адресной строке:
Подключение по SSH
Для подключения по SSH следуйте . В данной статье будет пример с использованием powershell (windows).
Стандартный логин для авторизации по SSH для ВМ в DigitalOcean - do-user.
Перейдите в Powershell и пропишите следующую команду:
Замените:
C:\Users\<Username>\.ssh\id_ed25519 на путь к Вашему ключу на локальном устройстве
do-user на Ваш root-логин (если Вы его изменяли при созданиии ВМ)
После нажатия "Enter" произойдет авторизация по SSH и Вы попадете в консольное меню MikoPBX.
Магазин приложений
Установка MikoPBX в Yandex Cloud из Marketplace
Для начала зарегистрируйтесь в сервисе Yandex Cloud.
Приступим к настройке
Создание виртуальной машины
Откройте Все сервисы / Инфраструктура и сеть / Compute Cloud
Перейдите в раздел Виртуальные машины
На вкладке выберите Создать ВМ
Введите имя виртуальной машины, например vm-mikopbx
Укажите зону доступности
Укажите параметры вычислительных ресурсов виртуальной машины, исходя из ожидаемой нагрузки на АТС и вашего бюджета. Для тестовой машины можно указать Гарантированная доля vCPU - 20%, RAM - 1 Гб
Загрузка АТС MikoPBX из образа в маркетплейсе
В разделе Выбор образа/загрузочного диска выберите Marketplace / Показать все продукты Marketplace / VoIP / MikoPBX IP АТС
В разделе Диски и файловые хранилища скорректируйте размер загрузочного диска до 1 Гб
Настройка дисков
Для развертывания АТС используйте два диска:
диск объемом 1 Гб для основной системы
диск объемом 50+ Гб
В разделе Диски и файловые хранилища выберите Добавить диск
На открытой вкладке введите имя диска для хранения данных, например storage-mikopbx
Укажите тип диска HDD
Настройка сети
В разделе Сетевые настройки выберите существующую или создайте новую облачную сеть
В поле Подсеть в выпадающем меню выберите Добавить подсеть
На открытой вкладке введите имя подсети, например local-mikopbx
Публичный адрес и Внутренний IPv4-адрес оставьте в положении Автоматически
Настройка параметров SSH
В разделе Доступ укажите Сервисный аккаунт
Введите Логин и SSH-ключ, предварительно сгенерированный по
В разделе Дополнительные настройки установите флажок Разрешить доступ к серийной консоли
Завершив ввод значений, нажмите кнопку Создать ВМ
Запуск АТС MikoPBX
Дождитесь запуска созданной виртуальной машины, обычно первый запуск занимает 6-8 минут. Статус Running, еще не означает что система полностью развернулась
Откройте созданную виртуальную машину и перейдите в раздел Серийная консоль
Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера
Для входа используйте указанные во вкладке Серийная консоль логин и пароль
Подключение S3 хранилища DigitalOcean
Инструкция по подключению DigitalOcean Spaces Object Storage в качестве S3-хранилища
Перейдите в раздел "Manage" -> "Spaces Object Storage". Нажмите "Create a Spaces Bucket" для создания нового бакета.
На странице создания бакета, в разделе "Choose a datacenter region", выберите ближайший к серверу MikoPBX регион. Выберите "Standart Storage".
Запомните название Вашего региона (sgp1 на скриншоте ниже), оно понадобится в будущем для настройки внутри MikoPBX.
В поле "Choose a unique Spaces Bucket name" укажите произвольное название для бакета.
Нажмите "Subscribe & Create Bucket".
Перейдите на страницу созданного бакета (нажмите на его название в разделе "Buckets").
Перейдите на вкладку "Settings".
Пролистайте до раздела "Access Keys". Нажмите "Create Access Key" для создания новой связки ключей.
Заполните необходимые параметры для создаваемого ключа:
Select access scope - Limited Access.
Buckets - выберите ранее созданный бакет.
Permissions - Read/Write/Delete.
Нажмите "Create Access Key".
Будет отображены значения связки ключей (Access Key ID и Secret Key). Сохраните эти значения, они понадобятся в будущем при настройке на стороне MikoPBX.
Подключение к MikoPBX
Перейдите во вкладку "Обслуживание" -> "Хранилище".
Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:
Автоматическая загрузка записей в облачное хранилище — включите переключатель.
URL точки доступа S3 — введите https://sgp1.digitaloceanspaces.com - замените sgp1 на Ваш регион.
Регион S3 — укажите регион Вашего бакета в DigitalOcean, в этой инструкции - sgp1.
Настройте ползунок «Локальное хранение (режим S3)» — выберите, как долго записи будут храниться локально до удаления после выгрузки в облако.
Более короткое локальное хранение быстрее освобождает дисковое пространство.
Нажмите «Сохранить».
После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Соединение с S3 успешно» и начнется синхронизация записей телефонных разговоров.
Proxmox
Установка MikoPBX с помощью Proxmox.
Загрузка образа MikoPBX
Откройте вкладку local / ISO images и выберите Download from URL
В поле URL вставьте ссылку на файл из дистрибутива MikoPBX с расширением .iso
Нажмите кнопку Download, дождитесь окончания загрузки файла
Создание виртуальной машины
Выберите Create VM
На вкладке General введите имя (Name) виртуальной машины, например mikopbx-vm
Перейдите к следующей вкладке OS, в поле ISO image выберите загруженный ранее образ
Укажите тип OS (Type) - Linux
На вкладке System уберите флажок Qemu Agent, для других полей используйте значения по умолчанию
Для развертывания АТС используйте два диска:
диск объемом 1 Гб для основной системы
диск объемом 50+ Гб
Перейдите к вкладке Disks
Скорректируйте размер диска под систему до 1 Гб
Нажмите кнопку Add и добавьте дополнительный диск для хранения данных
Укажите размер диска не менее 50 Гб
На вкладках CPU и Memory укажите параметры вычислительных ресурсов виртуальной машины, исходя из ожидаемой нагрузки на АТС. Для тестовой машины можно указать в поле Cores (вкладка CPU) - 2, в поле Memory (вкладка Memory) - 2 Гб
На вкладке Network уберите флажок Firewall
Перейдите к последней вкладке Confirm и установите флажок Start after created
Завершив ввод значений, нажмите кнопку Finish
Установка АТС MikoPBX
Перейдите к созданной виртуальной машине mikopbx-vm
На открытой вкладке перейдите в раздел Console
Если загрузка прошла успешно, появится консольное меню. Введите с клавиатуры 8 для начала установки
Выберите диск под систему и введите с клавиатуры имя диска, например sda. Подтвердите выбор, введите с клавиатуры y
Подключите диск для хранения записей разговоров, ведите с клавиатуры наименование диска для подключения, например sdb
После появления сообщения “Press any key within 30 seconds to boot from LiveCD…” не нажимайте никаких кнопок. В этом случае система загрузится с жесткого диска.
Запуск АТС MikoPBX
На открытой вкладке в разделе Console скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера
Для входа используйте логин - admin и пароль - admin
IVR меню
Создание и настройка IVR меню в MikoPBX
IVR меню в MikoPBX — это интерактивное голосовое меню, которое позволяет звонящим взаимодействовать с телефонной системой с помощью нажатия клавиш или голосовых команд. Оно автоматически направляет вызовы к нужным отделам или сотрудникам, улучшая эффективность обработки звонков и повышая качество обслуживания клиентов.
Предварительная настройка
Перед созданием IVR меню необходимо загрузить звуковые файлы, которые будут проигрываться клиенту при звонке в Вашу компанию. Звуковые файлы добавляются в разделе Телефония → Звуковые файлы
Загрузка звуковых файлов в MikoPBX
Также есть возможность записать файл с помощью микрофона, если с АТС соединиться по https.
Создание IVR-меню
Перейдите в Телефония → IVR меню.
Нажмите Создать новое IVR меню. Задайте наименование IVR меню, номер и при необходимости комментарий. Выберите звуковой файл, который вы загрузили на предыдущем этапе.
Настройте Действия при донаборе. В первой колонке укажите добавочный номер, а во второй настройте правило адресации.
Задайте Количество повторов перед переводом на номер по умолчанию.
Установите Таймаут ожидания ввода добавочного номера (значение в секундах), после которого будет повтор голосового приветствия.
Номер по умолчанию необходим для случая, если клиент не ввел добавочный номер (к примеру не было технической возможности).
Включите переключатель Разрешить набор любого внутреннего номера при необходимости.
Введите номер IVR меню, позвонив на который, можно на это IVR попасть.
Нажмите Сохранить.
Описания принципа работы IVR
При звонке на голосовое меню (Номер IVR меню) начинает проигрываться звуковой файл Голосовое приветствие.
Во время проигрывания голосового меню можно набирать добавочный номер сотрудника. За эту возможность отвечает флаг Разрешить донабор любого внутреннего номера. IVR позволяет разрешить донабор любого внутреннего номера: очереди, IVR, внутреннего номер сотрудника.
После проигрывания голосового меню происходит ожидание в течении Таймаут ожидания ввода добавочного номера
Входящие маршруты
Описание и настройка входящей маршрутизации
В данном разделе необходимо создать правила и шаблоны распределения входящих звонков для созданных в MikoPBX провайдеров. Правила входящих звонков описывают маршрут звонка с момента его поступления в АТС до момента его завершения. Вы можете создавать неограниченное количество правил входящей маршрутизации. Для одного провайдера можно создать несколько правил.
Раздел "Входящие маршруты" в MikoPBX
Дополнительные примеры настройки входящей маршрутизации доступны в разделе FAQ.
Приоритет правил маршрутизации и маршрут по умолчанию
Правила располагаются в списке в порядке их приоритета. Если за указанный в правиле интервал времени никто не ответит на входящий вызов, то вызов направится на следующее по приоритету правило. Правила можно перемещать в списке вверх-вниз, то есть изменять их приоритет, перетаскивая их за стрелки.
Если ни по одному из правил на звонок не ответили, применяется входящий маршрут по умолчанию.
Доступны следующие действия, которые можно указать в качестве правила по умолчанию:
Воспроизвести сигнал занято - клиент будет воспроизведен сигнал занято и входящий вызов будет завершен;
Положить трубку;
Перевести вызов - вызов можно перевести на номер, который вы можете выбрать в поле, расположенном справа от действия. В качестве номера для перевода можно выбрать IVR-меню, очередь вызовов, конференцию, внутренний номер сотрудника.
Несколько маршрутов для одного провайдера
Для одного провайдера можно описать несколько входящих маршрутов.
Сперва вызов идет по верхнему маршруту. Если клиент не дозвонился, то вызов идет по нижнему правилу (более низкий приоритет). Если клиент не дозвонился и по второму маршруту, то вызов идет по маршруту по умолчанию.
Создание правила маршрутизации
Чтобы добавить новое правило входящей маршрутизации нажмите на кнопку Добавить новое правило.
В поле Заметка опишите маршрут, который хотите реализовать. В дальнейшем это поможет вам в отладке схемы звонка.
Выберите Провайдера, для которого создаете новый шаблон распределения входящих звонков.
Дополнительный номер DID - это номер, на который вам позвонил клиент, в ряде случаев может совпадать с логином провайдера. Это не обязательное поле и его следует заполнять, если необходимо более точно маршрутизировать вызовы.
На следующем шаге необходимо указать на какой телефонный номер будет направлен входящий вызов от клиента. В качестве телефонного номера могут выступать номера IVR-меню, очереди вызовов, конференции, внутренние номера сотрудников.
Укажите время, в течение которого вызов будет идти на указанный вами телефонный номер.
Если спустя указанный интервал времени никто не ответит на входящий вызов, то вызов направится на следующее по приоритету правило.
Настройка Yandex Mail (oAuth2)
Настройка почты для сервиса Yandex Mail через oAuth2 авторизацию
В диалоговом окне выберите опцию "Для атворизации пользователей". Нажмите "Перейти к созданию".
Далее заполните необходимую информацию:
Название - произвольное.
Иконка сервиса - произвольное изображение.
Почта для связи - почта на которую будут приходить уведомления об авторизации.
Нажмите "Продолжить".
Далее выберите в качестве платформы "Веб-сервисы". В поле "Redirect URl" вставьте следующую ссылку:
Замените 192.168.100.60 на ip-адрес Вашей станции.
Нажмите "Продолжить".
Далее на странице "Права доступа к данным пользователей" в разделе "Дополнительные" впишите "smtp" и выберите доступ "Отправка писем через Яндекс.Почту по протоколу SMTP".
На следующей странице нажмите "Всё верно, создать приложение".
После создания приложения будет выведены ClientID и Client Secret. Далее они понадобятся нам для настройки внутри web-интерфейса MikoPBX.
Настройки внутри MikoPBX
Перейдите в Web-интерфейс MikoPBX. Далее "Система" -> "Почта и уведомления" -> "Настройки SMTP".
Заполните все необходимые данные:
Адрес отправителя, Имя отправителя - Ваша почта и от какого имени будут отправляться письма.
Тип аутентификации - OAuth2.
SMTP логин - Ваша почта.
Все остальные настройки оставьте по умолчанию. Более подробное описание Вы можете найти в главное статье о параметрах почты ().
После этого нажмите "Сохранить"!
Нажмите "Подключить через OAuth2". Войдите в Ваш аккаунт Яндекс. После авторизации, нажмите "Log in as...".
При успешной авторизации Вы увидите соответствующее окно.
Подключение S3 хранилища Yandex Cloud
Инструкция по подключению Яндекс Cloud Object Storage в качестве S3-хранилища
Перейдите в раздел "Все сервисы" -> "Object Storage".
Нажмите "Создать бакет".
Заполните следующие параметры для создаваемого бакета:
Имя — укажите название бакета (в нашем примере - mikopbx-s3-storage). Имя должно быть уникальным в рамках всего Yandex Cloud.
Макс. размер — задайте максимальный объём бакета. Рекомендуется установить значение, соответствующее вашим потребностям (не менее 50 ГБ для рабочей станции), чтобы контролировать расход облачного пространства. Если ограничение не нужно — отметьте «Без ограничения».
Доступ — для всех трёх параметров (Чтение объектов, Чтение списка объектов, Чтение настроек) выберите значение
После заполнения всех параметров нажмите кнопку «Создать бакет».
Создание сервисного аккаунта
Перейдите в раздел "Все сервисы" -> "Identity and Access Management".
Нажмите "Создать сервисный аккаунт".
Укажите следующие параметры:
Имя — введите название сервисного аккаунта (например, mikopbx-s3-access).
Роли в каталоге — нажмите «Добавить роль», в строке поиска введите storage и выберите роль storage.editor. Эта роль даёт необходимые права.
После заполнения параметров нажмите «Создать».
Перейдите в дашбоард созданного сервисного аккаунта, нажав на его название.
Нажмите "Создать новый ключ" -> "Создать статический ключ доступа".
6. Введите описание для создаваемого ключа и нажмите "Создать".
Будут отображены идентифкатор ключа и секретный ключ. Сохраните эти значения, они понадябтся позже для подключения хранилища к MikoPBX.
После закрытия диалога значение ключа будет недоступно.
Подключение к MikoPBX
Перейдите во вкладку "Обслуживание" -> "Хранилище".
Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:
Автоматическая загрузка записей в облачное хранилище — включите переключатель.
URL точки доступа S3 — введите https://storage.yandexcloud.net
Регион S3 — укажите регион Вашего аккаунта в Yandex Cloud, в этой инструкции - ru-central1
Настройте ползунок «Локальное хранение (режим S3)» — выберите, как долго записи будут храниться локально до удаления после выгрузки в облако.
Более короткое локальное хранение быстрее освобождает дисковое пространство.
Нажмите «Сохранить».
После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Подключено к S3» и начнется синхронизация записей телефонных разговоров.
Настройка Mail.ru (Логин, Пароль)
Настройка почты для сервиса mail.ru
Создания пароля для входа
Необходимо создать специальный пароль для входа в почтовую программу. С обычным паролем от почты войти не получится. Чтобы создать такой пароль, к почте должен быть привязан телефон. Перейдите в Контакты и адреса и проверьте, привязан ли он. Если нет — привяжите.
Откройте почту. В левом нижнем углу перейдите в "Настройки" → "Все настройки" → "Безопасность" → "."
Нажмите Создать.
На следующей странице добавьте название для создаваемого пароля - это поможет для его идентификации в будущем. В нашем примере - "SMTP для MikoPBX".
Нажмите Продолжить.
Выберите тип протокола - "Только отправка писем в Почте".
Нажмите Продолжить.
Скопируйте пароль и введите его, когда будете входить с почтой Mail в почтовую программу.
Пароль будет отображен только один раз! В случае утери необходимо создать новый, повторив все шаги с самого начала.
Подключение в MikoPBX
Перейдите в раздел "Система" -> "Почта и уведомления".
Перейдите в "Настройки SMTP". Заполните все необходимые параметры:
Адрес отправителя - Ваш адрес электронной почты.
Имя отправителя - имя от которого отправляется почта.
Установка в Yandex cloud произвольного образа MikoPBX
Для начала зарегистрируйтесь в сервисе .
Приступим к настройке
Создание виртуальной машины
Откройте Все сервисы / Инфраструктура и сеть /
VMware ESXi
Установка MikoPBX с помощью VMware ESXi.
Создание виртуальной машины
Создаём новую виртуальную машину
Hyper-V
Установка MikoPBX с помощью HyperV.
Создание виртуальной машины
Выберите Действие / Создать / Виртуальная машина
API ключи
Описание работы в MikoPBX
REST API MikoPBX позволяет автоматизировать управление станцией и интегрировать её с внешними системами — CRM, helpdesk, корпоративными порталами и собственными сервисами. Для доступа к API используются API ключи.
Авторизация
Все запросы к REST API авторизуются через заголовок Authorization: Bearer <token>. MikoPBX поддерживает два типа токенов:
Тип
Google Cloud Маркетплейс
Установка MikoPBX в Google Cloud с помощью Маркетплейса
Авторизуйтесь на платформе
MikoPBX в Google Cloud Маркетплейс:
Приступим к настройке
Для быстрого и удобного поиска на платформе Google Cloud используйте панель поиска
Selectel
Установка MikoPBX с помощью Selectel
В данной инструкции мы пошагово произведем установку MikoPBX с помощью облачной платформы Selectel.
Перед началом вам необходимо скачать актуальный образ MikoPBX с расширением .raw. Сделать это можно по .
Загрузка образа в Selectel
Хранилище
Использование дискового пространства и настройки хранения
Раздел «Хранилище» в MikoPBX позволяет контролировать использование дискового пространства и управлять настройками хранения данных. Здесь отображается подробная разбивка занятого места по категориям: записи разговоров, системные логи, резервные копии и другие файлы. Помимо мониторинга локального хранилища, раздел предоставляет возможность настроить автоматическую выгрузку записей в облачное хранилище S3.
Расположение раздела: "Обслуживание" -> "Хранилище".
Give this access key a name - укажите произвольное название для идентификации связки ключей.
Имя бакета S3 — укажите имя бакета, созданного в DigitalOcean (например, mikopbx-s3-storage в этой инструкции)
Ключ доступа и Секретный ключ — вставьте значения, полученные в первой части этой инструкции (связка Access ключей).
Раздел "Spaces Object Storage"
Параметры создаваемого бакета #1
Параметры создаваемого бакета #2
Созданный бакет в разделе "Buckets".
Вкладка "Settings" на странице созданного бакета
Раздел "Access Keys"
Параметры создаваемой связки ключей
Связка access ключей
Раздел "Хранилище"
Параметры для подключения S3 DigitalOcean
Успешное подключение
«С авторизацией»
.
Имя бакета S3 — укажите имя бакета, созданного в Яндекс Cloud (например, mikopbx-s3-storage в этой инструкции)
Ключ доступа и Секретный ключ — вставьте значения, полученные при создании статического ключа сервисного аккаунта.
Раздел "Object Storage"
Кнопка "Создать бакет"
Параметры создаваемого бакета
Раздел "Identity and Access Management"
Кнопка "Создать сервисный аккаунт"
Параметры создаваемого сервисного аккаунта
Созданный сервисный аккаунт
Создание нового ключа для сервисного аккаунта
Описание создаваемого ключа
Созданный идентификатор и ключ
Раздел "Хранилище"
Параметры для подключения S3 Yandex Cloud
Успешное подключение
SMTP пароль - созданный пароль для внешнего приложения.
Отбор по двум номерам телефона (кто звонил, кому звонил)
Отбор по дате вызова
Отбор по linkedid
для набора добавочного.
Общее время для набора номера = Длительность звукового файла + Таймаут ожидания ввода добавочного номера
.
Если общее время для набора номера истекло происходит повторное голосовое оповещение и ожидание в течении таймаута, то есть следующая попытка IVR.
Если пользователь некорректно набирает номер или вообще ничего не набирает, то также происходит повторное голосовое оповещение и ожидание в течении таймаута - следующая попытка IVR.
Максимальное количество попыток задается в параметре Количество повторов, перед переводом на номер по умолчанию.
Как только попытки превысят указанное значение, происходит переадресация на Номер по умолчанию.
Запись файла с помощью микрофона
Раздел "Интерактивные голосовые меню - IVR"
Создаение нового IVR (Интерактивного голосового меню)
Настройка действия при донаборе
Настройки IVR
Настройка приоритета правил маршрутизации
Маршрут по умолчанию
Несколько маршрутов для одного провайдера
Элемент "Добавить новое правило"
Параметры обработки входящих
Провайдер OAuth2 - Yandex Mail.
Идентификатор приложения (Client ID), Секретный ключ (Client Secret) - данные из Yandex (6 пункт из прошлого раздела в этой инструкции).
MikoPBX создание загрузочного диска в Yandex Cloud
для хранения записей разговоров
Compute Cloud
Перейдите в раздел Виртуальные машины
На вкладке выберите Создать ВМ
Введите имя виртуальной машины, например vm-mikopbx
Укажите зону доступности
Укажите параметры вычислительных ресурсов виртуальной машины, исходя из ожидаемой нагрузки на АТС и вашего бюджета. Для тестовой машины можно указать Гарантированная доля vCPU - 20%, RAM - 1 Гб
Загрузка АТС MikoPBX из произвольного образа
Перед созданием виртуальной машины необходимо предварительно загрузить образ MikoPBX в облачное хранилище
Откройте Все сервисы / Инфраструктура и сеть / Object Storage
На вкладке Object Storage выберите Создать бакет
Введите имя нового бакета, например mikopbx-imgs
Укажите макс. размер 1 Гб
Для других полей используйте значения по умолчанию
Завершив ввод значений, нажмите кнопку Создать бакет
Откройте созданный бакет mikopbx-imgs
На открывшейся вкладке выберите Загрузить объекты
Выберите файл из дистрибутива MikoPBX с расширением .raw
Нажмите кнопку Загрузить
После завершения загрузки откройте загруженный объект
Выберите Получить ссылку и скопируйте ссылку на образ
Откройте Все сервисы / Инфраструктура и сеть / Compute Cloud
Перейдите в раздел Образы
На вкладке выберите Загрузить образ
Введите имя образа, например mikopbx-img
В поле Ссылка на образ в Object Storage укажите скопированную ранее ссылку на образ АТС
Нажмите кнопку Загрузить
Вернемся к выбору образа на вкладке Все сервисы / Инфраструктура и сеть / Compute Cloud / Виртуальные машины
В разделе Выбор образа/загрузочного диска выберите Свой образ / Выбрать / Наполнение - Образ / mikopbx-img
В разделе Диски и файловые хранилища скорректируйте размер загрузочного диска до 1 Гб
Настройка дисков
Для развертывания АТС используйте два диска:
диск объемом 1 Гб для основной системы
диск объемом 50+ Гб для хранения записей разговоров
В разделе Диски и файловые хранилища выберите Добавить диск
На открытой вкладке введите имя диска для хранения данных, например storage-mikopbx
Укажите тип диска HDD
Укажите размер диска не менее 50 Гб
Наполнение - Пустой
Для других полей на вкладке используйте значения по умолчанию
Нажмите кнопку Добавить
Настройка сети
В разделе Сетевые настройки выберите существующую или создайте новую облачную сеть
В поле Подсеть в выпадающем меню выберите Добавить подсеть
На открытой вкладке введите имя подсети, например local-mikopbx
В поле CIDR укажите диапазон адресов, например 172.16.32.0/24
Для других полей на вкладке используйте значения по умолчанию
Нажмите кнопку Создать
Публичный адрес и Внутренний IPv4-адрес оставьте в положении Автоматически
Настройка параметров SSH
В разделе Доступ укажите Сервисный аккаунт
Введите Логин и SSH-ключ, предварительно сгенерированный по инструкции
В разделе Дополнительные настройки установите флажок Разрешить доступ к серийной консоли
Завершив ввод значений, нажмите кнопку Создать ВМ
Запуск АТС MikoPBX
Дождитесь запуска созданной виртуальной машины, обычно первый запуск занимает 6-8 минут. Статус Running, еще не означает что система полностью развернулась
Откройте созданную виртуальную машину и перейдите в раздел Серийная консоль
Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера
Для входа используйте указанные во вкладке Серийная консоль логин и пароль
На данном этапе MikoPBX загружается с оптического диска, на который записан ISO-образ. На это нам указывает строчка: "The system is loaded in Recovery mode".
Переключите язык интерфейса на русский. Для этого выполните Change Language -> Русский. Меню примет вид:
Произведите установку MikoPBX.
Все данные на диске, куда устанавливается MikoPBX, будут потеряны.
Нажмите Выполнить установку.
Отобразится информация о всех доступных дисках (в данном примере: sdb, sdc).
Введите с клавиатуры имя диска, который вы подразумевали под "системный", в текущем случае sdb и нажмите Enter (Если он выбран по умолчанию можно просто нажать Enter).
Система запросит подтверждение. Введите - y и нажмите Enter.
После выполнения установки будет предложено выбрать диск для хранения записей разговоров.
Ориентировочно, 1 час разговора занимает 14Мб места на диске.
Введите имя диска (в данном примере - единственный доступный диск sdc) и нажмите Enter.
После завершения установки система перезагрузится.
Теперь MikoPBX будет запускаться с диска sdb, на который вы ее установили.
Увидим, что строчка «The system is loaded in Recovery mode» отсутствует.
На этом установка MikoPBX завершена.
Первый вход в MikoPBX
Для того, чтобы открыть панель управления вам надо вбить в строку браузера IP-адрес вашей виртуальной машины.
IP-адрес MikoPBX
Окно входа в веб-интерфейс
Логин и пароль по умолчанию - admin
На этом установка MikoPBX на завершена.
На вкладке Укажите имя и местонахождение введите имя виртуальной машины, например mikopbx-vm
На вкладке Выделить память выделите необходимый размер оперативной памяти, исходя из ожидаемой нагрузки на АТС. Для тестовой машины можно указать 2 Гб
Перейдите к вкладке Настройка сети, выберите заранее настроенное сетевое соединение
На вкладке Подключить виртуальный жесткий диск скорректируйте размер диска под систему до 1 Гб
На вкладке Параметры установки установите флажок Установить операционную систему с загрузочного компакт- или DVD-диска
Выберите Файл образа (.iso) и укажите ссылку на файл из дистрибутива MikoPBX с расширением .iso
Завершив ввод значений, нажмите кнопку Готово
Диск для хранения данных
Для развертывания АТС используйте два диска:
диск объемом 1 Гб для основной системы
диск объемом 50+ Гб для хранения записей разговоров
Перейдите к Параметрам созданной виртуальной машины
Выберите IDE контроллер, к которому подключен диск под систему
На открывшейся вкладке выберите Жесткий диск, нажмите кнопку Добавить
Нажмите кнопку Создать
На вкладке Выбор формата диска выберите формат - VHD
На вкладке Выберите тип диска укажите тип диска - Фиксированного размера
На вкладке Укажите имя и местонахождение укажите имя, например storage.vhd, и расположение диска
На вкладке Настройка диска задайте размер диска для хранения данных не менее 50Гб
Для других полей используйте значения по умолчанию
Завершите настройку, нажав кнопку Готово
Установка АТС MikoPBX
Для запуска виртуальной машины нажмите Пуск
Перейдите к вкладке Подключить созданной виртуальной машины mikopbx-vm
Если загрузка прошла успешно, появится консольное меню. Введите с клавиатуры 8 для начала установки
Выберите диск под систему и введите с клавиатуры имя диска, например sdb. Подтвердите выбор, введите с клавиатуры y
Подключите диск для хранения записей разговоров, ведите с клавиатуры наименование диска для подключения, например sdc
После появления сообщения “Press any key within 30 seconds to boot from LiveCD…” не нажимайте никаких кнопок. В этом случае система загрузится с жесткого диска.
Запуск АТС MikoPBX
На открытой вкладке Подключить скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера
Для входа используйте логин - admin и пароль - admin
Когда использовать?
JWT токен
Внутренние компоненты системы, модули, встроенные инструменты
Для внешних интеграций всегда используйте API ключ — он создаётся вручную, имеет настраиваемые права доступа и может быть отозван в любой момент.
Создание API-ключа
Перейдите в раздел «Система» → «API ключи».
Раздел "Система" -> "API ключи"
Нажмите «Добавить API ключ».
Заполните поле Описание (например: CRM Integration)
Скопируйте сгенерированный API-ключ — он отображается только один раз
Важно: сохраните ключ сразу после создания. После закрытия страницы восстановить его невозможно — придётся создавать новый.
Базовые настройки API ключа
Настройка прав доступа
Придерживайтесь принципа минимальных привилегий — каждый ключ должен иметь доступ только к тем ресурсам, которые реально нужны.
При создании ключа доступны два варианта:
Полные права доступа — ключ получает доступ ко всем ресурсам API на чтение и запись. Используйте только если это действительно необходимо.
Ручная настройка — для каждого ресурса API отдельно указывается уровень доступа: только чтение, чтение и запись, или нет доступа.
"Чтение" позволяет получать данные (GET)
"Чтение и запись" позволяет создавать, изменять и удалять данные (POST, PUT, DELETE).
Сетевой фильтр: выберите один из двух вариантов:
Только локальные подключения — ключ будет работать только из локальной сети. Рекомендуется если интеграция работает внутри инфраструктуры.
Разрешены подключения с любых адресов — ключ доступен без ограничений по IP. Используйте только если клиент находится за пределами локальной сети.
Безопасность
Соблюдение следующих требований защищает API от перехвата токенов и несанкционированного доступа:
Валидный SSL сертификат:
Используйте доверенный SSL сертификат на стороне сервера MikoPBX. Самый простой способ — выпустить бесплатный сертификат через модуль Let's Encrypt (инструкция по работе с модулем находится здесь).
Работа без валидного сертификата допустима только в изолированной тестовой среде без доступа из интернета.
Доверие к сертификату на стороне клиента:
Клиент обязан проверять сертификат сервера при каждом запросе. Отключение проверки (verify=False в Python, -k в curl) недопустимо в production: без неё возможна атака типа «человек посередине» (MITM), при которой злоумышленник перехватывает Bearer-токен в открытом виде.
Ограничение прав (scope) ключа:
Каждый ключ должен иметь доступ только к тем ресурсам, которые реально используются интеграцией. Не используйте «Полные права доступа» без необходимости — компрометация такого ключа даёт атакующему полный контроль над API.
Ограничение сетевого доступа:
Если интеграция работает внутри локальной сети — выбирайте «Только локальные подключения». Это исключает возможность использования скомпрометированного ключа из внешней сети.
Вариант «Разрешены подключения с любых адресов» используйте только когда клиент физически находится за пределами локальной сети, и убедитесь что остальные меры безопасности соблюдены — валидный SSL сертификат и минимальные права ключа.
Примеры и подробная документация
Нажмите на карточку для перехода:
Добавление ролей сервисной учетной записи
Если у вас есть сервисная учетная запись, проверьте наличие нужных ролей, в случае необходимости добавьте их
Если сервисной учетной записи нет, создайте и добавьте ей нужные роли
Откройте Navigation menu / Products & solutions / Management / IAM & Admin
Перейдите к вкладке Service accounts и нажмите на CREATE SERVICE ACCOUNT
Введите имя сервисной учетной записи, например mikopbx-service-account
Нажмите кнопку CREATE AND CONTINUE
Добавьте роли Cloud Infrastructure Manager Agent, Compute Admin, Compute Network Admin, Service Account User
Нажмите кнопку DONE
Создание виртуальной машины
Откройте Marketplace и введите в поисковой строке MikoPBX
Имя образа - любое желаемое название для вашего образа.
ОС - Linux
Источник - Файл
Файл - выберите раннее загруженный файл с расширением .raw
Все остальное - по умолчанию.
Нажмите создать и дождитесь окончания процесса.
Параметры загружаемого образа диска
Создание сервера в Selectel
Перейдите в раздел Облачная платформа -> Серверы
Раздел "Серверы"
Нажмите "Создать сервер":
"Создать сервер"
В конфигурации вашей ВМ укажите:
Имя - произвольное название.
Пул - такой же, как у раннее созданного образа.
Источник - выберите раннее загруженный образ.
Конфигурация - желаемое "железо" исходя из ваших потребностей.
Первая секция конфигурации
Диски: Здесь вам необходимо указать размер для первого диска (он же - системный диск) - 5Гб (минимально возможный в Selectel). А так же создайте новый диск, используя кнопку "Добавить". Укажите размер. Для диска, который используется для записи разговоров - рекомендуемое значение >50Гб. Типы дисков - "Базовый HDD"
Сеть - "Приватная + 1 публичный IP"
Вторая секция конфигурации
Нажмите "Создать сервер".
"Создать сервер"
После создания, сразу остановите запуск сервера.
Включение DHCP
Перейдите в раздел Облачная платформа -> Сеть.
Раздел "Сеть"
Перейдите в конфигурацию сети "Nat":
Сеть "Nat"
Перейдите в раздел Подсети -> Автоматические сетевые настройки.
Автоматические сетевые настройк
Включите переключатель "DHCP-сервер".
"DHCP-сервер"
Первый запуск MikoPBX
Вернитесь к разделу Облачная платформа -> Серверы. Далее - в созданный сервер.
Включите сервер:
Элемент переключения состояния сервера
Перейдите в раздел "Syslog":
Раздел "Syslog"
Произведите подключение по:
External IP Address - внешний IP-адрес вашей MikoPBX. Скопируйте и вставьте его в адресную строку.
Web credentials - данные для входа в WEB-интерфейс. Введите логин и пароль.
На вкладке «Информация о хранилище» отображается общая картина использования дискового пространства.
В верхней части страницы находится блок с горизонтальной диаграммой, которая наглядно показывает, какую долю от общего объёма диска занимает каждая категория данных.В примере занято 56.0 GB из 100.0 GB. Каждый сегмент диаграммы окрашен в свой цвет в соответствии с легендой:
🟠 Записи разговоров
🟣 История разговоров
🔵 Системные логи
🟢 Дополнительные модули
🩵 Резервные копии
🔴 Системные кеши
⚫ Прочие файлы
Раздел "Информация о хранилище"
В нижней части страницы находится список категорий данных и количество памяти, которая каждая из них занимает.
Локальное хранилище
На вкладке "Локальное хранилище" доступно определение срока хранения записей разговоров на станции: передвигая ползунок, выберите необходимый период хранения:
30 дней (1 месяц) - минимальный период хранения.
90 дней (3 месяца) - рекомендуется для малого бизнеса.
1 год - для соблюдения требований законодательства.
Бесконечно - хранить все записи без ограничений.
Более длительные периоды хранения требуют больше дискового пространства.
Вкладка "Локальное хранилище". Выбор срока хранения записей разговора.
Облачное хранилище S3
На этой вкладке настраивается автоматическая выгрузка записей разговоров во внешнее S3-совместимое хранилище (например: Amazon S3, Яндекс Cloud, VK Cloud).
В верхней части вкладки находится переключатель «Автоматическая загрузка записей в облачное хранилище» — он включает или отключает функцию выгрузки.
Для подключения к бакету необходимо заполнить следующие поля:
URL точки доступа S3 — адрес сервиса хранилища (например, https://storage.yandexcloud.net для Yandex Cloud S3).
Регион S3 — регион размещения бакета (например, ru-central1).
Имя бакета S3 — название бакета, в который будут загружаться записи.
Ключ доступа и Секретный ключ — учётные данные сервисного аккаунта для авторизации.
Нажмите "Сохранить" для сохранения настроек.
Вкладка "Облачное хранилище S3"
Далее нажмите кнопку «Проверить соединение» — система выполнит тестовое подключение и отобразит результат в верхней части страницы. При успешном подключении появится сообщение «Подключено к S3» и начнется синхронизация записей телефонных разговоров.
Успешное соединение с S3 хранилищем
В нижней части вкладки расположен ползунок «Локальное хранение (режим S3)» — он определяет, как долго записи будут сохраняться локально на станции перед тем, как они будут выгружены в облачное хранилище и удалены со станции (локально). Срок локального хранения не может превышать общий срок хранения.
Более короткое локальное хранение быстрее освобождает дисковое пространство.
Если у вас есть нет ключа SSH, сразу перейдите к пункту 18
Для других полей используйте значения по умолчанию
Завершив ввод значений, нажмите кнопку CREATE
Настройка портов для входящих соединений
Откройте Navigation menu / VPC network / Firewall
Выберите CREATE FIREWALL RULE для создания нового правила для входящего соединения
Введите имя нового правила (Name), например internal-allow
Укажите Direction of traffic - Ingress
Укажите Targets
Из выпадающего меню в поле Source filter выберите IPV4 ranges и в поле Source IPv4 ranges укажите 0.0.0.0/0
В разделе Protocols and ports установите флажок TCP (Ports - 0-65535) и флажок UDP (Ports - 0-65535)
Для других полей используйте значения по умолчанию
Завершив ввод значений, нажмите кнопку CREATE
Обязательно выполните настройку Firewall на самой АТС MikoPBX
Запуск АТС MikoPBX
Откройте вкладку Compute Engine и перейдите в раздел Virtual machines / VM Instance
Перейдите к созданной виртуальной машине mikopbx-vm
На открытой вкладке перейдите к Logs / Serial port 1 (console)
Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера
Для входа используйте указанные в Serial port 1 (console) логин и пароль
VMware Fusion
Установка MikoPBX с помощью VMware Fusion.
Создание виртуальной машины
Создаем новую виртуальную машину.
После скачивания последней версии образа (), указываем ISO файл с установочным дистрибутивом.
Нажимаем "Continue"
Выбираем тип операционной системы Other Linux 5.x and later kernel 64-bit
Нажимаем "Continue"
Выбираем тип биоса Legacy
Нажимаем "Continue"
Нажимаем "Finish"
Подключение нового диска
После создания виртуальной машины, дождитесь ее загрузки
Перейдите в раздел "[3] Reboot the system"
Выберите "[2]Shutdown"
После выключения виртуальной машины, перейдите в настройки
Выберите "Add device"
Выберите "New Hard Disk"
Нажмите "Add..."
Выберите размер жесткого диска(мы рекомендуем не менее 50ГБ)
Нажмите "Apply"
1 час записи разговоров занимает примерно 14мб на диске.
Установка MikoPBX
Запустите виртуальную машину
Выберите пункт "[8] Install"
Введите имя диска, на который будет установлена MikoPBX
В нашем случае - sdb, введите его название и нажмите Enter
Подтвердите выбор диска: введите y
Выберите диск для записи разговоров
В нашем случае - sdc, введите его название и нажмите Enter
Система перезагрузится и MikoPBX будет готова к использованию.
Первое подключение к MikoPBX
В АТС отображается IP адрес станции, по которому к ней можно подключится
Введите IP адрес станции в строку браузера и у вас откроется меню входа в MIkoPBX
Логин и пароль по умолчанию - "admin"
Доступ к AMI
Настройка доступа к AMI
Asterisk Manager Interface (AMI) - мощный и удобный программный интерфейс (API) Asterisk для управления системой из внешних программ. Благодаря AMI внешние программы могут осуществлять соединения с Asterisk посредством TCP протокола, инициировать выполнение команд, считывать результат их выполнения, а так же получать уведомления о происходящих событиях в реальном времени.
AMI часто используют для интеграции с бизнес-процессами и системами, программным обеспечением CRM (Customer Relationship Managment — управление взаимодействия с клиентами). Управление Asterisk часто осуществляется из консоли CLI, но при использовании AMI не требуется прямой доступ к серверу, на котором запущен Asterisk. AMI — это наиболее простой инструмент, который в руках разработчика может оказаться очень мощным и гибким средством для интеграции с другими программными продуктами. Он дает возможность разработчикам использовать информацию, генерируемую Asterisk, в реальном масштабе времени.
Первое что необходимо сделать, это включить AMI и завести пользователя, с помощью которого клиентская программа будет аутентифицироваться. «Система» - «Доступ к AMI»
Раздел "Доступ к AMI"
Для добавления новой учетной записи необходимо указать Имя пользователя и Пароль. Кроме того, необходимо задать Сетевой фильтр, т.е. из какой подсети разрешено подключение к пользователю AMI. Вы можете разрешить подключения с любых адресов, либо указать конкретную сеть, настройку который Вы произвели в разделе "Сеть и Firewall" → "".
Опции и права пользователя AMI
Права пользователя AMI, устанавливаемые в секции [user] конфигурационного файла /etc/asterisk/manager.conf
Идентификатор прав
Чтение
Запись
Настройка Gmail (oAuth2)
Настройка почты для сервиса gmail
Для настройки OAuth 2.0 в Google требуется использовать URL-адрес станции.
Самый простой способ — создать DNS-запись на локальном сервере или добавить соответствие IP-адреса и доменного имени в файл hosts на устройстве, с которого выполняется настройка.
Настройки аккаунта Google
Перед началом настройки, необходимо поменять некоторые параметры аккаунта Google. Для этого перейдите на страницу управления ().
Перейдите в раздел "Безопасность и вход в аккаунт". Убедитесь, что у Вас настроена двухэтапная аутентификация.
Перейдите в консоль Google Cloud, в раздел "APIs & Services" (). Создайте проект под текущую задачу.
Перейдите в библиотеку APIs (раздел "Library").
Введите в поиске: "gmail api". Перейдите в карточку Gmail API.
Нажмите "Enable" для подключения.
Перейдите на главную страницу APIs & Services. Далее "OAuth consent screen".
Создайте проект (нажмите "Get started"). Заполните произвольное название и Вашу почту. В качестве Audience выберите "Internal". Нажмите "Create" для завершения.
Вернитесь на главную страницу APIs & Services. Далее в раздел "Credentials". Нажмите "Create credentials". Выберите "OAuth client ID" для создания.
В качестве Application type, выберите "Web application". Далее введите произвольное название. Нажмите "Create".
Решение: впишите URl адрес станции в Веб-интерфейсе MikoPBX: "Сеть и Firewall" -> "Сетевые интерфейсы". Перейдите в раздел "Топология сети" и впишите имя хоста в поле "Внешнее имя хоста вашего маршрутизатора". (Включите "Эта станция расположена за NAT маршрутизатором")
Сетевые интерфейсы
Описание и настройка сетевых интерфейсов
Раздел «Сетевые интерфейсы» в MikoPBX — это интерфейс для настройки параметров сетевых подключений системы. Здесь администраторы могут управлять IP-адресами, масками подсети, шлюзами и другими сетевыми настройками для каждого сетевого интерфейса. Это позволяет корректно интегрировать MikoPBX в сеть организации и обеспечить ее стабильную работу в соответствии с требованиями сетевой инфраструктуры.
Раздел находится в "Сеть и Firewall" -> "Сетевые интерфейсы":
Раздел "Сетевые интерфейсы"
Параметры
Имя хоста - это имя машины. Если значение не указано, то используется имя mikopbx.local.
Сетевые интерфейсы
Существует два способа настроить IP-адрес в MikoPBX:
DHCP (Dynamic Host Configuration Protocol) - это протокол, который позволяет автоматически настраивать IP-адрес. Рекомендуется использовать этот способ, если вы не хотите заниматься ручной настройкой. Просто включите опцию "Использовать DHCP для получения настроек сети" и система автоматически получит IP-адрес от DHCP сервера.
Ручная настройка - если вы не хотите использовать DHCP или хотите задать IP-адрес вручную, вы можете выполнить ручную настройку сети. Для этого вам понадобятся некоторые знания о топологии сети. В поле IP-адрес введите желаемый IP-адрес, а рядом с ним укажите маску подсети в формате CIDR. Например, /24 соответствует маске подсети 255.255.255.0.
"VLAN ID" - Кроме того, MikoPBX поддерживает виртуальные сетевые интерфейсы, известные как VLAN. Эта функция особенно полезна, если у вас есть только один физический сетевой интерфейс, но вам требуется использовать несколько виртуальных интерфейсов. С помощью VLAN можно создать виртуальные интерфейсы, которые работают поверх физического интерфейса. Преимуществом использования VLAN является возможность направлять телефонные разговоры через него, в то время как сетевое оборудование может осуществлять отдельную обработку трафика VLAN, обеспечивая стабильное соединение.
Важно отметить, что количество сетевых интерфейсов в MikoPBX не ограничено, и вы можете настроить и использовать несколько интерфейсов в соответствии с вашими потребностями.
Топология сети
"Сетевой интерфейс с доступом в интернет" - это основной интерфейс, через который MikoPBX будет получать доступ к внешним адресам, то есть адресам вне вашей локальной сети.
Если вы не указали адрес DNS-сервера, MikoPBX будет использовать сервер 8.8.8.8 по умолчанию. DNS-серверы отвечают за преобразование доменных имен в IP-адреса, позволяя устройствам находить нужные ресурсы в сети.
В зависимости от топологии вашей сети, вам потребуется выполнить определенные настройки MikoPBX. Вариант, когда АТС находится за сетевым маршрутизатором, является наиболее распространенным. Это означает, что MikoPBX подключена к вашей локальной сети, и для доступа к интернету используется маршрутизатор. Другой вариант - АТС находится на публичном IP, то есть имеет прямой доступ к интернету без промежуточного маршрутизатора.
В обоих случаях необходимо настроить MikoPBX соответствующим образом, чтобы обеспечить правильное функционирование и доступ к внешним ресурсам.
Если АТС находится за маршрутизатором, то необходимо установить галку «Эта станция расположена за NAT маршрутизатором»
Если нам известен внешний адрес станции (ip или доменное имя)и проброшены порты АТС во внешний мир, то имеет смысл заполнить поля «Внешний IP адрес Вашего маршрутизатора» или «Внешнее имя хоста вашего маршрутизатора».
Всем адресам, которые не являются для АТС локальными, станция будет представляться внешним адресом:
Если «Внешний IP адрес Вашего маршрутизатора» пустое, а «Внешнее имя хоста вашего маршрутизатора» заполнено, то АТС будет представляться именно этим полем (Внешнее имя).
Внешний IP-адрес обязателен для заполнения. Если указано доменное имя - то приоритет за ним и Внешний IP адрес не используется.
Когда вы включаете опцию «Эта станция расположена за NAT маршрутизатором», важно указать внешний адрес или имя хоста вашего маршрутизатора. Это необходимо для правильной настройки связи между внешней сетью и вашей АТС. Помимо этого, на самом маршрутизаторе необходимо выполнить проброс портов SIP 5060 и RTP 10000-10200 на локальный адрес АТС. Проброс портов позволяет маршрутизатору правильно направлять сетевой трафик SIP и RTP к вашей АТС.
Однако, если ваш провайдер позволяет вам регистрироваться без использования NAT и у вас нет необходимости подключать внешних абонентов, то вы можете не включать опцию «Эта станция расположена за NAT маршрутизатором». Даже если ваша АТС находится за NAT-маршрутизатором, но вы не нуждаетесь во внешних подключениях, эта опция не обязательна.
Важно учитывать требования вашего провайдера и особенности вашей сети при выборе и настройке этой опции.
Ручная настройка сетевых маршрутов
Перейдите в раздел Система → Кастомизация системных файлов.
Откройте для редактирования файл /etc/static-routes.
Выберите режим «Заменять полностью» и вставьте правило.
Например, route add -net 54.246.198.136 netmask 255.255.255.255 gw 172.16.32.15 dev eth0
Для указания операционной системе, какой сетевой интерфейс (в данном случае eth0) использовать для поиска IP-адреса 54.246.198.136, а также для указания шлюза (gateway) для направления запроса (в данном случае 172.16.32.15), мы задаем соответствующие значения в настройках сетевого правила.
Маска подсети "255.255.255.255" указывает, что данное правило будет применимо только к конкретному IP-адресу 54.246.198.136. Если вам необходимо создать правило для группы адресов, например, для всей подсети 54.246.198.0, то фактически это охватывает диапазон адресов от 54.246.198.1 до 54.246.198.254.
Таким образом, указывая сетевой интерфейс и шлюз в сетевых настройках, вы определяете, какую сеть и через какой маршрут направлять соответствующие запросы и коммуникацию. Это важно для настройки сетевого взаимодействия и обеспечения правильной маршрутизации трафика в вашей сети.
Нажмите "Сохранить"
Почта и уведомления
Настройка почты и уведомлений
Раздел «Почта и уведомления» в MikoPBX позволяет настроить отправку системных уведомлений через электронную почту. Здесь администраторы указывают параметры SMTP-сервера, определяют события для уведомлений, такие как голосовые сообщения или системные ошибки, и редактируют шаблоны писем. Этот раздел помогает своевременно информировать пользователей и администраторов о важных событиях, обеспечивая эффективный контроль за работой системы.
Настройка уведомлений для почтовых сервисов:
Подключение к SMTP серверу
Для получения уведомлений о пропущенных вызовах и сообщениях голосовой почты по электронной почте необходимо настроить SMTP-клиент. SMTP (Simple Mail Transfer Protocol) используется для отправки электронной почты через Интернет. SMTP-клиенты взаимодействуют с SMTP сервером, который отправляет электронную почту.
Общие настройки
SMTP хост - адрес почтового сервера
SMTP порт - порт почтового сервера
SMTP логин, SMTP пароль - параметры авторизации
Если сервер поддерживает защищенное соединение только по SSL, то можно явно указать протокол в поле «SMTP хост», к примеру
Оповещения о пропущенных
Существует возможность настроить адрес и шаблон оповещения о пропущенных вызовах:
Email для уведомлений о пропущенных - по умолчанию, уведомления о пропущенных отправляются на email, указанный в . Если вызов не удается сопоставить с сотрудником или email не указан, то вызов будет направлен на этот «общий» адрес
Тема, текст, подвал письма могут содержать параметры в виде ИМЯ_ПАРАМЕТРА
Список доступных «параметров»:
NOTIFICATION_MISSEDCAUSE - на текущий момент всегда принимает значение «NOANSWER», т.е. пропущенный вызов
NOTIFICATION_CALLERID - от кого был вызов
NOTIFICATION_TO - кому был вызов
Голосовая почта
Существует возможность настроить адрес и шаблон оповещения о голосовой почте:
Голосовая почта будет отправлена каждому сотруднику, кто пропустил вызов (если email указан в его карточке).
Голосовая почта всегда будет отправлена на «Единый Email для отправки сообщений голосовой почты»
Прослушать запись голосовой почты возможно из АТС
В теме, теле и подвале email можно использовать следующие «параметры»:
VM_DATE - дата и время
VM_CALLERID - callerid звонящего, состоит из name и num, пример «Alexey Portnov» <101>
VM_DUR - длительность сообщения
Чтобы указать параметр, нужно использовать конструкцию вида ИМЯ_ПАРАМЕТРА.
Нажмите Сохранить для завершения настройки.
Почта и уведомления (new)
Настройка почты и уведомлений
Раздел «Почта и уведомления» в MikoPBX позволяет настроить отправку системных уведомлений через электронную почту. Здесь администраторы указывают параметры SMTP-сервера, определяют события для уведомлений, такие как голосовые сообщения или системные ошибки, и редактируют шаблоны писем. Этот раздел помогает своевременно информировать пользователей и администраторов о важных событиях, обеспечивая эффективный контроль за работой системы.
С 2026 года многие облачные провайдеры закрывают порты на SMTP по умолчанию (например Selectel, DigitalOcean). В случае ошибок подключений - уточняйте информацию у Вашего облачного провайдера.
Раздел "Почта и уведомления" в MikoPBX
Общие настройки
Использовать оповещения - позволяет включить/отключить все оповещения на email, включая голосовую почту.
Отправлять уведомления о пропущенных вызовах - позволяет включить/отключить уведомления о пропущенных вызовах.
Единый Email для уведомлений о пропущенных вызовах - общий адрес электронной почты для отправки уведомлений о пропущенных внешних вызовах (если у сотрудника не указан email, используется этот общий адрес).
Настройки SMTP
Адрес отправителя, Имя отправителя - от имени этого адреса и имени будут отправляться электронные письма.
Тип аутентификации:
Логин и пароль - классический тип аутентификации при подключении к SMTP-серверу, при котором используется адрес почтового ящика (логин) и пароль от него. Все параметры (сервер, порт, шифрование, логин и пароль) вводятся и хранятся вручную
Аунтефикация по логину и паролю
SMTP логин, SMTP пароль - параметры авторизации.
SMTP хост - адрес почтового сервера.
SMTP порт - порт почтового сервера.
Аунтефикация с OAuth2
SMTP логин - параметры авторизации.
Провайдер OAuth2 - почтовый сервис, через который выполняется OAuth-аутентификация (например, Microsoft/Outlook, Google/Gmail).
Идентификатор приложения (Client ID) - уникальный идентификатор приложения, созданного в панели управления выбранного OAuth-провайдера. Используется для того, чтобы провайдер понимал, какое именно приложение запрашивает доступ к почтовому ящику.
Как подключить?
В нашей документации приведено несколько примеров подключения для каждого из типов аутентификации. Ниже Вы можете найти ссылки на эти инструкции.
Аутентификация по логину и паролю:
Аутентификация oAuth2:
Управление модулями
Подключение, настройка и управление модулями
Дополнительные модули позволяют расширить возможности функционала основной системы. В данной инструкции вы сможете найти информацию про управление модулями, а так же про установку приложений с помощью встроенного Marketplace.
Для использования платных и бесплатных модулей, необходимо зарегистрировать копию MikoPBX и бесплатно получить лицензионный ключ. Инструкцию по тому, как это сделать - вы можете найти здесь.
Подробные инструкции по настройке и эксплуатации каждого модуля вы можете найти здесь.
Найти раздел Управления модулями вы можете в "Модули" -> "Маркетплейс модулей".
Установленные модули
В данном разделе происходит основное управление модулями: их подключение, настройка, а так же загрузка своих, "кастомных" модулей. Документацию по разработке своих модулей вы можете найти .
Все установленные модули находятся в списке, в одноимённой вкладке:
Есть возможность загрузить свой модуль, используя кнопку "Загрузить новый модуль". Необходимо загружать файлы .zip. После загрузки модуль появится в списке на вкладке "Установленные модули"
Так же есть возможность перейти в настройки любого модуля для дальнейшей его конфигурации:
Помимо этого, можно включить/отключить модуль.
Из интерфейса установленного модуля можно быстро перейти к его документации, нажав на знак вопроса справа от короткого описания модуля:
Быстрый доступ к модулю
Существует возможность вынести любой модуль в боковое меню для быстрого доступа к нему, что может быть полезно, если вам требуется постоянный доступ к настройки модуля для изменения параметров или его состояния.
Для того, чтобы это сделать - выполните дальнейшую инструкцию:
Перейдите в настройки модуля, который Вы хотите вывести в боковое меню, нажав на элемент редактирования справа от версии модуля:
Нажмите на значок настроек справа от статуса состояния модуля для перехода к настройкам отображения модуля в боковом меню:
В данном разделе вы можете:
Переключить отображение модуля в боковом меню - "Показывать модуль в боковом меню".
Выбрать раздел в котором он будет отображаться - в примере выбран раздел "Модули".
Так же можно указать произвольное название модуля.
После завершения настройки - нажмите "Сохранить".
Маркетплейс модулей
В данном разделе вы можете установить модули от MIKO, а так же от производителей-партнеров.
Напротив каждого модуля есть кнопка для его скачивания и установки. Так же здесь отображена базовая информация по модулю с коротким описанием каждого модуля.
Слева от названия модуля вы можете найти значок, по которому можно понять платный ли он или бесплатный. Например, на изображении выше модуль "REST API Автоинформатор" - платный, а модуль "Генератор SSL сертификатов через Let's Encrypt" - бесплатный.
У каждого платного модуля есть испытательный период - 2 недели. За этот период вы можете попробовать функционал модуля и принять решение о покупке. Для покупки модуля - напишите на почту [email protected]
Карточка модуля
Существует возможность перейти в карточку модуля, нажав на его название в интерфейсе маркетплейса.
Здесь вы можете найти версию актуального релиза, информацию про разработчика, платный ли модуль или бесплатный. Тут же находятся 3 раздела:
Описание модуля
Здесь вы можете найти изображения про функционал и настройки модуля. Помимо этого - базовое описание модуля, а так же раздел "Полезные ссылки", где располагается ссылка на подробную документацию по настройке и эксплуатации модуля.
История версий
В данном разделе вы можете найти историю версий модуля, с подробным описанием изменений, а также минимально совместимой версии MikoPBX для корректной его работы. Так же вы можете установить конкретную версию модуля, нажав на синий элемент под общим ее описанием.
Лицензионное соглашение
Здесь вы можете ознакомиться с пользовательским лицензионным соглашением для каждого модуля расширения.
Активация купонов
В случае покупки модуля, вам будет выдан купон. Для его активации перейдите в Модули -> Маркетплейс модулей:
Далее перейдите в раздел "Управление лицензией"
В поле "Активация купона" введите ваш купон, далее нажмите "Активировать купон"
Ключ защиты всегда начинается с MIKO-. Купон для изменения состава продуктов всегда начинается с MIKOUPD-
VK Cloud
Установка MikoPBX с помощью VK Cloud
Для начала авторизуйтесь на сайте
Приступим к настройке
Добавление локальной подсети
Откройте Виртуальные сети /
1С:Облачная инфраструктура
Установка MikoPBX с помощью 1С:Облачная инфраструктура
Для начала авторизуйтесь на сайте
Приступим к настройке
Добавление локальной подсети
Откройте Виртуальные сети /
Подключение S3 хранилища AWS
Инструкция по подключению AWS S3 в качестве облачного хранилища для автоматической выгрузки записей разговоров из MikoPBX
Создание бакета
Перейдите в консоль AWS (). Перейдите в раздел "Все сервисы" -> "Storage" -> "S3".
VMware Workstation Pro
Установка MikoPBX с помощью VMware Workstation Pro
В текущей инструкции будет описан процесс создания и настройки виртуальной машины в VMware Workstation Pro, а так же процесс установки MikoPBX.
Скачать установщик VMware Workstation Pro можно .
Используйте для установки на VMware Workstation Pro версии АТС MikoPBX отличные от 2024.1.114
Версия 2024.1.114 временно не поддерживает установку с помощью VMware Workstation Pro!
Microsoft Azure
Установка MikoPBX с помощью Microsoft Azure.
Для начала авторизуйтесь на портале Microsoft Azure
Приступим к настройке
Для быстрого и удобного поиска на портале Azure используйте панель поиска
Запуск MikoPBX в контейнере
Установка MikoPBX в Docker контейнер
Для работы с MikoPBX в контейнере необходимо установить docker и docker compose, а также создать пользователя и папки для хранения настроек конфигурации и записей разговоров по инструкции
Запуск контейнера Docker
Для запуска контейнера с вашим приложением воспользуйтесь следующими командами:
Установка системы на USB носитель (Bootable USB)
Установка системы на USB-носитель
Перед началом загрузите образ диска с расширением .raw. Сделать это можно .
Установка системы на USB-носитель
Провайдер OAuth2 - Google/Gmail.
Идентификатор приложения (Client ID), Секретный ключ (Client Secret) - данные, которые сохранены из Google Cloud (12 пункт из прошлого раздела в этой инструкции).
Предоставляет пользователю доступ к чтению подробных логов
Только чтение
Agent
Чтение событий статуса агентов из app_queue и chan_agent модулей
Позволяет пользователю выполнять действия для управления и получения состояния очередей и агентов
User
Доступа к пользовательским событиям, а также событиям Jabber / XMPP пользователей
Позволяет пользователю выполнять команду UserEvent, для создания пользовательских событий
Config
Только для записи
Позволяет пользователю получать, обновлять и перегружать файлы конфигурации
Command
Только для записи
Позволяет пользователю выполнять команды Asterisk CLI из AMI
Dtmf
Позволяет пользователю получать события DTMF
Только чтение
Reporting
Доступ к событиям качества звонка, таким как jitterbuffer или RTCP
Позволяет пользователю выполнять ряд действий для получения статистики и информации о состоянии всей системы
Cdr
Чтение событий записи данных в CDR
Только чтение
Dialplan
Чтение событий установки переменных диалплана, создания "экстенов"
Только чтение
Originate
Только для записи
Разрешение пользователю выполнять команду Origitate, которая отправляет запрос на создание нового звонка
System
Чтение общей информации о системе, например, уведомления о перезагрузке конфигурации
Позволяет пользователю выполнять Asterisk системы управления такими командами, как Restart, Reload, или Shutdown. Это разрешение также предоставляет пользователям возможность запускать системные команды за пределами Asterisk. Предоставление такого разрешения эквивалентно предоставлению доступа к командной оболочке, с правами пользователя / группы, под которыми запущен процесс Asterisk
Call
Чтение события о каналах в системе
Позволяет пользователю устанавливать информация на каналах
Отправлять уведомления о голосовых сообщениях - позволяет включить/отключить уведомления о голосовых сообщениях.
Единый Email для уведомлений о голосовых сообщениях - общий адрес электронной почты для отправки уведомлений о голосовых сообщениях (приоритет: 1. Личный email сотрудника; 2. Указанный email в этом поле)
Отправлять уведомления о входах в систему - позволяет включить/отключить уведомления о входах в систему.
Отправлять системные уведомления - позволяет включить/отключить отправку системных уведомлений.
Email системного администратора - адрес, на который будут отправляться системные уведомления.
OAuth2 - способ аутентификации, при котором Вы не храните и не передаёте пароль от почтового ящика. Вместо этого приложение получает временный токен доступа у почтового провайдера (Microsoft 365/Outlook, Google Workspace/Gmail и т.д.) и использует его при отправке писем через SMTP.
Тип шифрования:
Без шифрования (порт 25) - классический способ подключения к SMTP без защиты канала.
STARTTLS (порт 587) - рекомендованный и наиболее распространённый способ отправки почты. Соединение начинается без шифрования, после чего клиент и сервер согласовывают переход на защищённый канал.
SSL/TLC (порт 465) - подключение к SMTP с шифрованием с самого начала соединения. Канал защищён сразу после установки TCP-соединения, без этапа переключения.
Проверять сертификат сервера - настройка безопасности, которая определяет, будет ли клиент проверять подлинность SSL/TLS-сертификата SMTP-сервера при установке защищённого соединения (STARTTLS или SSL/TLS).
Секретный ключ (Client Secret) - конфиденциальный ключ приложения, выданный OAuth-провайдером. Используется вместе с Client ID для подтверждения подлинности приложения при получении и обновлении токенов доступа. Должен храниться в секрете и не передаваться третьим лицам.
SMTP хост - адрес почтового сервера.
SMTP порт - порт почтового сервера.
Тип шифрования:
Без шифрования (порт 25) - классический способ подключения к SMTP без защиты канала.
STARTTLS (порт 587) - рекомендованный и наиболее распространённый способ отправки почты. Соединение начинается без шифрования, после чего клиент и сервер согласовывают переход на защищённый канал.
SSL/TLC (порт 465) - подключение к SMTP с шифрованием с самого начала соединения. Канал защищён сразу после установки TCP-соединения, без этапа переключения.
Проверять сертификат сервера - настройка безопасности, которая определяет, будет ли клиент проверять подлинность SSL/TLS-сертификата SMTP-сервера при установке защищённого соединения (STARTTLS или SSL/TLS).
Адрес отправителя - от имени этого адреса будут отправляться электронные письма
Email системного администратора - на этот электронный адрес будут отправляться все системные уведомления, к примеру о нехватке места на диске. При изменении и сохранении настроек на этот адрес будет отправлено тестовое письмо
Использовать TLS - активирует использование шифрования при подключении к серверу, для подключения по SSL, необходимо к адресу сервера добавить описание протокола
Проверять сертификат сервера - в ряде случаев необходимо отключить, при использовании самоподписанных сертификатов
Использовать оповещения - позволяет включить / отключить все оповещения на email, включая голосовую почту
NOTIFICATION_DURATION - длительность в секундах
NOTIFICATION_DATE - дата вызова
VM_CALLER_NAME - имя звонящего (берется из VM_CALLERID)
VM_CALLER_NUM - номер телефона звонящего (берется из VM_CALLERID)
Введите описание ключа для того, чтобы идентифицировать его в будущем. Нажмите "Create access key".
Описание ключа
Будет отображены access key и secret access key ключи. Сохраните их, они понадобятся далее для настройки внутри MikoPBX.
Только сейчас можно просмотреть или загрузить секретный ключ доступа. Восстановить его позже будет невозможно.
Access key и Secret access key
Подключение к MikoPBX
Перейдите во вкладку "Обслуживание" -> "Хранилище".
Раздел "Облсуживание" -> "Хранилище"
Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:
Автоматическая загрузка записей в облачное хранилище — включите переключатель.
URL точки доступа S3 — введите адрес доступа к S3 AWS, в зависимости от региона Вашего бакета (ссылка на таблицу со всеми url). В этой инструкции - https://s3.ap-southeast-1.amazonaws.com
Регион S3 — укажите регионВашего бакета, в этой инструкции - ap-southeast-1
Имя бакета S3 — укажите имя бакета, созданного в AWS (например, aws-s3-mikopbxstorage в этой инструкции)
Ключ доступа и Секретный ключ — вставьте значения, полученные при создании access ключа сервисного аккаунта.
Настройте ползунок «Локальное хранение (режим S3)» — выберите, как долго записи будут храниться локально до удаления после выгрузки в облако.
Более короткое локальное хранение быстрее освобождает дисковое пространство.
Нажмите «Сохранить».
Параметры подключения облачного хранилища S3 в MikoPBX
После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Подключено к S3» и начнется синхронизация записей телефонных разговоров.
Перейдите в интерфейс VMware WorkStation Pro. Нажмите кнопку "Create a New Virtual Machine" для создания новой виртуальной машины.
Элемент "Create a New Virtual Machine"
В интерфейсе создания виртуальной машины укажите тип виртуальной машины: "Typical (recommended)". Далее, нажмите - "Next >".
Выбор типа создаваемой виртуальной машины
Далее выберите источник установки "Installer disc image file (iso):", выберите файл образа диска с расширением .iso. Скачать дистрибутив вы можете по ссылке. После выбора нажмите "Next >" для продолжения.
Выбор источника установки системы для создаваемой виртуальной машины
Выберите "Linux" в поле "Guest operating system". В качестве "Version" - "Debian 11.x 64-bit". Нажмите "Next >"
Выбор операционной системы и версии для создаваемой виртуальной машины
Укажите желаемое имя для виртуальной машины в поле "Virtual machine name:". Так же есть возможность указать локацию для этой виртуальной машины на вашем компьютере: используйте поле "Location". Нажмите "Next >".
Указание названия и пути для создаваемой виртуальной машины
Укажите размер для первого (системного) жесткого диска: рекомендуемое значение - 1Гб. Выберите "Split virtual disk into multiple files". Нажмите "Next >".
Указание параметров для системного жесткого диска для создаваемой виртуальной машины
Далее мы создадим и подключим второй жесткий диск, который будет использоваться для хранения записей разговоров.
Перейдите в настройки раннее созданной виртуальной машины.
Раздел настроек виртуальной машины
Нажмите "Add..." для добавления нового элемента системы.
Кнопка для добавления нового элемента системы
Выберите "Hard Disk" в разделе "Hardware types". Нажмите "Next >"
Выбор типа нового элемента системы
Выберите "Virtual disk type" - "SCSI". Нажмите "Next >".
Выбор типа диска
Выберите "Create a new virtual disk". Нажмите "Next >".
Выбор параметра "Create a new virtual disk"
Выберите размер диска: рекомендованное значение - не менее 50 Гб. Так же выберите параметр "Split virtual disk into multiple files". Нажмите "Next >"
Указание параметров для создаваемого диска
Укажите произвольное название для жесткого диска. Нажмите "Finish"
Название для второго жесткого диска
Указание сетевого интерфейса для виртуальной машины
В настройках перейдите в раздел "Network Adapter". Выберите "Network connection" - "Bridged: Connected directly to the physical network". Нажмите "OK"
Настройка сетевого интерфейса
Первый запуск системы
Произведите запуск виртуальной машины.
Кнопка для запуска виртуальной машины
Откроется командный интерфейс MikoPBX. АТС начнет загружаться. На данном этапе MikoPBX загружается с оптического диска, на который записан ISO-образ. На это нам указывает строчка: "The system is loaded in Recovery mode".
Переключите язык интерфейса на русский. Для этого выполните "[1] Change Language" -> "[2] Русский".
Далее произведем установку MikoPBX. Перейдите в пункт "[8] Install".
Отобразится информация о всех доступных дисках (в данном примере: sdb, sdc). Системой предложен диск по умолчанию, в нашем случае - sdb. Если вы согласны с предложенным диском, который будет использоваться в качестве системного - нажмите Enter. В противном случае напишите название другого диска.
Все данные на диске, куда устанавливается MikoPBX, будут потеряны.
Выбор диска для системы
Далее система выдаст предупреждения. Для подтверждение операции - введите "y" и нажмите Enter.
После выполнения установки будет предложено выбрать диск для хранения записей разговоров. Введите имя диска (в данном примере - единственный доступный диск sdc) и нажмите Enter.
Выбор диска для хранения записей разговоров
После завершения установки система перезагрузится.
Теперь MikoPBX будет запускаться с диска sdb, на который вы ее установили. Увидим, что строчка «The system is loaded in Recovery mode» отсутствует. Это значит, что установка MikoPBX совершена успешно.
Успешно установленная MikoPBX
Первый вход в MikoPBX
Для того, чтобы открыть веб-интерфейс MikoPBX вам надо вписать в строку браузера IP-адрес вашей виртуальной машины, найти его вы можете в консоли.
IP-адрес MikoPBX
Впишите IP-адрес в адресную строку вашего браузера. Произведите первый вход в MikoPBX по стандартному логину и паролю.
При первом входе в WEB-интерфейс MikoPBX используйте стандартные данные:
Чтобы убедиться, что ваше приложение MikoPBX запостилось и работает в Docker-контейнере, можно выполнить следующие шаги после его запуска. Эти шаги помогут проверить состояние контейнера и просмотреть его логи.
Шаг 1: Проверка статуса контейнера
Сначала нужно удостовериться, что контейнер успешно запущен и работает. Для этого используем команду docker ps, которая покажет список запущенных контейнеров и их статус.
Эта команда выведет информацию о всех активных контейнерах. Убедитесь, что контейнер mikopbx присутствует в списке и его статус указывает на то, что он запущен и работает (например, статус up).
Шаг 2: Просмотр логов контейнера
После подтверждения того, что контейнер запущен, следующим шагом будет просмотр логов для проверки, что приложение загрузилось без ошибок и функционирует нормально. Команда docker logs позволит вам увидеть вывод, который генерирует ваше приложение.
Просмотрите вывод команды на наличие сообщения, подобного указанному ниже. Это сообщение свидетельствует о том, что MikoPBX успешно загружена и готова к использованию:
Если отображается процесс запуска MikoPBX то необходимо подождать и повторить команду sudo docker logs mikopbx
Шаг 3: Проверка доступа к веб-интерфейсу
При старте контенер не имеет информации об адресе хостовой системы, потому необходимо открыть внешний адрес хостовой системы, в данном случае Ubuntu в браузере.
https://<IP адрес хост системы>
Войдите в веб-интерфейс, используя логин admin и пароль admin, чтобы убедиться, что веб-интерфейс доступен и функционирует корректно.
Особенности работы контейнизированной MikoPBX
Флаг NET_ADMIN необходим для возможности работы системы проактивной защиты fail2ban и фаервола iptables внутри контейнера. При срабатывании блокировки доступа, например при вводе неверного пароля, доступ с IP адреса злоумышленника будет заблокирован.
Если необходимо использовать «Модуль резервного копирования», то контейнер следует запускать с флагом –privileged. Когда MikoPBX запускается в контейнере, резервное копирование можно также выполнять архивированием каталогов cf и storage вручную . В этом случае привелегированный режим можно не использовать, но в момент копирования контейнер должен быть остановлен.
Флаг –net=host указывает на то, что NAT между хостом и контейнером не будет использоваться. MikoPBX будет подключена напрямую к сети хостовой машины. Все порты, которые должен занять контейнер будут заняты и на хост машине. Если на хост машине, какой-то из портов недоступн, то при загрузке MikoPBX возникнут ошибки. Подробнее в
При необходимости можно скорректировать стандартный набор портов, которые использует MikoPBX. Это можно сделать объявляя переменные окружения при запуске контейнера.
Создание контейнера из tar архива
Помимо использования нашего официального реестра, вам может понадобиться вариант создания контейнера из образа, например для бета версии. В составе опубликованных релизов и предрелизов поставляется tar архив, который мы используем для создания контейнера.
Пример кода, для его использования:
Переменные окружения для конфигурирования MikoPBX
Ниже перечислены некоторые переменные окружения, которые позволят скорректировать используемые MikoPBX порты и настройки.
SSH_PORT - порт для SSH (22)
WEB_PORT - порт для работы web интерфейса по протоколу HTTP (80)
WEB_HTTPS_PORT - порт для работы web интерфейса по протоколу HTTPS (443)
SIP_PORT - порт для подключения SIP клиента (5060)
TLS_PORT - порт для подключения SIP клиента с шифрованием (5061)
RTP_PORT_FROM - начало диапазона RTP портов, передача голоса (10000)
RTP_PORT_TO - конец диапазона RTP портов, передача голоса (10800)
IAX_PORT - порт для подключения IAX клиентов (4569)
AMI_PORT - порт AMI (5038)
AJAM_PORT - порт AJAM используется для подключения панели телефонии для 1С (8088)
AJAM_PORT_TLS - порт AJAM используется для подключения панели телефонии для 1С (8089)
BEANSTALK_PORT - порт для сервера очередей Beanstalkd (4229)
REDIS_PORT - порт для сервера Redis (6379)
GNATS_PORT - порт для сервера gnatsd (4223)
ID_WWW_USER - идентификатор пользователя www-user (можно задать выражением $(id -u www-user), где www-user имя НЕ root пользователя)
ID_WWW_GROUP - идентификатор группы www-user (можно задать выражением $(id -g www-user), где www-user имя НЕ root группы)
WEB_ADMIN_LOGIN - логин для доступа в Web интерфейс
WEB_ADMIN_PASSWORD - пароль для доступа в Web интерфейс
Полный список всех возможных параметров настроек доступен в исходном коде по ссылке.
Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!
Выполните команду:
Будет отображена информация про все подключенные диски. Нас интересует диск с маркировкой (external, physical). В нашем случае это disk4, в Вашем случае номер может быть другим. Используйте его номер для выполнения дальнейших шагов в этой инструкции.
Вывод команды diskutil list
Далее необходимо отформатировать USB носитель. Для этого используйте команду:
Все данные на диске будут удалены! Еще раз проверьте название диска который Вы форматируете!
Для подтверждения введите пароль администратора, дождитесь окончания форматирования.
Форматирование диска
Отмонтируйте (отключите) диск, используя следующую команду:
Отключение диска (команда unmountDisk)
Запишите образ на USB-носитель, используя следующую команду:
В данной инструкции в качестве примера, запись образа будет произведена на Ubuntu 24.04.
Подключите Ваш usb-носитель и откройте Terminal.
Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!
Выполните команду:
Будет отображена информация про все подключенные диска. Найдите в этом списке Ваш usb-носитель и запомните его наименование. В нашем случае, это диск sdb.
Список всех подключенных дисков
Далее необходимо отформатировать usb-носитель, используя следующую команду:
Все данные на диске будут удалены! Еще раз проверьте название диска который Вы форматируете!
Для подтверждения введите пароль администратора, дождитесь окончания форматирования.
Форматирование диска
Отмонтируйте (отключите) диск, используя следующую команду:
Команда "umount"
Запишите образ на USB-носитель, используя следующую команду:
Запуститесь с USB-носителя. При возникновении ошибок (черный экран) - убидитесь, что:
Secure Boot - Disabled
CSM (Compatibility Support Module) - Enabled
Загрузка с USB-носителя
Система успешно загружена, но не подключен диск для хранения записей разговоров. Для его подключения, передвигаясь стрелочками на клавиатуре, перейдите в пункт "[6] Data storage" и нажмите Enter.
Раздел "Data Storage"
Далее выберите пункт "Mount drive as data storage" для подключения диска.
Выбор действия
Выберите диск, который будет использоваться для хранения записей разговоров. Для этого введите его ID (название), например sdc в нашем случае.
Нажмите Enter.
Выбор диска
После этого система перезагрузится и будет готова к работе и первой авторизации в Web-интерфейс.
Успешно установленная система
Для перехода в Web-интерфейс, введите IP-адрес Вашей MikoPBX в строку браузера. Используйте стандартные данные для авторизации.
Инструкция актуальна для версии 2024.2.138 и новее!
В данной инструкции мы пошагово произведем установку MikoPBX с помощью облачной платформы Vultr.
Перед началом Вам необходимо скачать актуальный образ MikoPBX с расширением .iso. Сделать это можно на github MikoPBX.
Загрузка образа в Vultr
Загрузка файла в хранилище
Для начала необходимо загрузить образ в облачную платформу.
Перейдите в раздел "Cloud Storage" -> "Object Storage":
Необходимо создать новое хранилище. Для этого нажмите "Add Object Storage":
Выберите тип хранилища (рекомендуется использовать самый базовый, так как он нужен только для хранения файла образа диска). Так же укажите название.
Перейдите в созданное хранилище, нажав на его название:
Перейдите во вкладку "Buckets" и создайте новый Bucket с произвольным названием.
В информации о хранилище, будут указаны данные для S3 подключения.
Далее необходимо подключиться к хранилищу через WinSCP. Для этого, перейдем в его интерфейс. Выберите "New Site":
Укажите следующие параметры:
"File protocol" - Amazon S3.
"Encryption" - TLS/SSL Implict encryption.
"Port number" - 443.
Нажмите "Login".
Загрузите файл образа диска в хранилище.
Вернитесь в интерфейс Vultr, перейдите в директорию Вашего Bucket'а.
Нажмите на три точки справа от названия файла. Перейдите в раздел "Change Access". Разрешите доступ, переключив тумблер.
Импорт образа
Нажмите на три точки справа от названия файла. Скопируйте URL.
Перейдите в раздел "Orchestration" -> "ISOs":
Нажмите "Add ISO":
Вставьте ссылку на ранее загруженный файл, нажмите "Upload".
Добавление связки SSH-ключей
Перейдите в раздел "Account" -> "SSH Keys". Нажмите "Add SSH Key"
Сгенерируйте пару SSH ключей .
В интерфейсе добавления пары SSH-ключей введите произвольное название, а так же вставьте сгенерированный ключ.
Нажмите "Add SSH Key".
Создание виртуальной машины
Перейдите в раздел "Products" -> "Compute":
Нажмите "Deploy Server":
В открывшемся разделе выберите регион и конфигурацию вашей виртуальной машины.
Перейдите далее.
Выберите "ISO/iPXE" -> Ранее загрузочный образ.
Так же выберите ранее созданную пару SSH-ключей.
Нажмите "Deploy".
Создание второго диска
После создания сервера, остановите его запуск.
Перейдите в раздел "Cloud Storage" -> "Block Storage":
Нажмите "Add Block Storage":
Выберите тип диска, регион (такой же как у ранее созданной виртуальной машины), размер, а так же укажите произвольное название.
Рекомендуемый размер диска для хранения записей разговоров - не менее 50Гб.
Перейдите в раздел управления созданным диском. Прикрепите диск к созданной виртуальной машине используя пункт "Attach to:"
Установка системы
Перейдите в меню управления виртуальной машиной.
Перейдите в консоль, нажав на соответствующий элемент.
Вы попадете во встроенную консоль.
Перейдите в "[8] Install".
Выберите диск, который будет использован в качестве системного. Подтвердите действия - введите "y" и нажмите "Enter":
Выберите диск для хранения записей разговоров. Система перезагрузится.
Перейдите в настройки виртуальной машины "Settings", далее в "Custom ISO". Нажмите "Remove ISO".
На данном этапе система установлена и готова к работе!
Подключение к WEB-интерфейсу
В адресную строку введите IP-адрес Вашей виртуальной машины. Найти его Вы можете в консоли MikoPBX.
Введите следующие данные для авторизации:
Логин - admin
Пароь - ID-виртуальной машины. Оно имеет вид "150dd137-a0e2-45f6-baf9-ddc15a600d60", найти его Вы можете в адресной строке (скриншот ниже)
Исходящие маршруты
Описание и настройка исходящей маршрутизации
Исходящие маршруты в MikoPBX — это набор правил и настроек, определяющих, как система обрабатывает исходящие звонки от сотрудников к внешним номерам. С их помощью администраторы могут управлять направлением вызовов через различные провайдеры телефонии или линии связи в зависимости от определенных условий, таких как набранный номер, префиксы, время суток или права доступа пользователя. Это позволяет оптимизировать затраты на связь, распределять нагрузку между каналами и применять политики безопасности, ограничивая или разрешая определенные типы вызовов. Настройка исходящих маршрутов обеспечивает гибкость и контроль над исходящей телефонной связью, способствуя эффективной работе коммуникационной системы компании.
В данной статье Вы найдете подробную документацию по настройке исходящей маршрутизации.
Вы можете создавать неограниченное количество правил исходящей маршрутизации. Для одного провайдера можно создать несколько правил.
Раздел "Исходящие маршруты" в MikoPBX
Создание правила
Дополнительные примеры настройки исходящей маршрутизации доступны в разделе FAQ.
Шаг 1. Добавление нового правила
Чтобы добавить новое правило исходящей маршрутизации нажмите на кнопку Добавить новое правило.
Шаг 2. Название и заметка
Название правила можно задавать произвольным.
В заметке можно описать маршрут звонка, который хотите реализовать, в дальнейшем это может помочь вам в отладке.
Шаг 3. Задание шаблона номеров
Задайте шаблон для исходящих звонков. Подробнее про шаблоны номеров .
Приведенный на картинке выше пример означает следующее: если набранный номер начинается с "7" или "8", и остальная часть номера состоит 10 цифр.
Если набираемый номер подходит под правила нескольких маршрутов, то вызов будет производится в порядке описания маршрутов, поочередно, пока вызов не будет отвечен, или пока подходящие маршруты не закончатся.
Шаг 4. Преобразование номера
Преобразовать номер - данная настройка предназначена для удаления префикса номера и замены его на нужный префикс.
Примеры преобразования номеров приведены , а так же .
В приведенном примере в начале номера не отсекаются цифры и не добавляются цифры.
Шаг 5. Выбор провайдера
Выберите из списка провайдера, для которого настроили исходящую маршрутизацию и сохраните изменения.
Примеры
Примеры шаблонов номеров
Номер начинается с
Остальная часть номера состоит из указанного количества цифр
Примеры номеров
Примеры изменения префиксов номеров
Пример 1. Необходимо заменить префиксы номеров "+7" на "8".
Например, номер +74952293042 должен быть преобразован к номеру 84952293042.
Реализация правила выглядит следующим образом:
Пример 2. Необходимо заменить префиксы номеров "8", "7" на "+7".
Например, номера 84952293042 и 74952293042 должны быть преобразованы к номеру +74952293042.
Реализация правила выглядит следующим образом:
Пример 3. Необходимо добавить префикс "8" к номеру.
Например, номера 4952293042 и 4996382584 должны быть преобразованы к номеру 84952293042 и 84996382584 соответственно.
Реализация правила выглядит следующим образом:
Пример 4. Необходимо удалить код города "8495" или "7495", или "8499", или "7499" и оставлять 7-значный номер.
Например, номера 84952293042 и 74996382584 должны быть преобразованы к номеру 2293042 и 6382584 соответственно.
Реализация правила выглядит следующим образом:
Диагностика системы
Описание функций раздела
Раздел «Диагностика системы» в MikoPBX — это инструмент для мониторинга и анализа состояния телефонной системы. Использование этого раздела помогает своевременно обнаруживать и устранять технические проблемы, обеспечивая стабильную и эффективную работу MikoPBX.
Расположение раздела: "Обслуживание" -> "Системные логи"
Раздел "Диагностика системы" в MikoPBX
Содержит 3 вкладки: просмотр логов, информация о системе, захват сетевых пакетов. Далее в статье будет подробно разобрана каждая из них.
3 вкладки в разделе
Просмотр логов
Раздел позволяет просмотреть файлы логов для детального анализа работы АТС
Для начала работы - выберите файл.
Установите лимит строк для выборки.
Установите офсет - значение сдвига в выборке.
Доступны следующие возможности:
1. Cкачать полученную выборку в виде файла
2. Обновить выборку
3. Автоматическое обновление выборки
Пример. Анализ звонка
Допустим необходимо проанализировать прохождение исходящего звонка на номер 74952293042
Выберите файл для анализа asterisk/verbose.
В качестве фильтра установите номер телефона 74952293042.
В поле лимит укажите значение с запасом, к примеру
В данном примере ID = C-0000000f.
Повторяем запрос лога, но уже с фильтром C-0000000f.
Будет получен весь лог прохождения dialplan.
Полученные данные можно отправить специалисту технической поддержки.
В лог звонка также можно перейти из интерфейса истории звонков:
После перехода по иконке "Лист" будет открыт интерфейс "Системные логи" с файлом "asterisk/verbose" и отбором по ID звонка:
Информация о системе
Данная вкладка отображает следующую информацию:
Сетевые настройки
Нагрузка на CPU
Потребляемая оперативная память
Настройки iptables
Захват сетевых пакетов
Данный раздел позволяет произвести детальный анализ ошибок в работе АТС.
Сбор сетевых пакетов
Вы можете запустить сбор сетевых пакетов, проходящих через сетевой интерфейс.
Для запуска процесса нажмите кнопку "Старт".
Воспроизведите вашу проблему: совершите звонок или иное действие, приводящее к сбою / ошибке.
Нажмите кнопку "Остановить и скачать".
Сетевые пакеты будут автоматически сохранены в архив MikoPBXLogs_log-tcpdump-XXXXXXXXXX. Также они должны автоматически сохраниться в папку Загрузки вашего браузера.
Если в папке Загрузки архив найти не удалось , можете и скачать его из директории /storage/usbdisk1/mikopbx/tmp- файл log-tcpdump-XXXXXXXXXX.zip
Существует возможность воспользоваться поиском в WinSCP: в поле имени искомого файла ввести "log-tcpdump*", а в каталоге поиска ввести "/storage".
Скачать все системные логи
Вы можете скачать все накопленные на АТС системные логи. Для этого нажмите кнопку "Скачать все системные логи".
Системные логи будут автоматически сохранены в архив MikoPBXLogs_log-sys-XXXXXXXXXX.zip. Логи автоматически должны сохраниться в папку Загрузки вашего браузера.
Так же данный архив с логами можно получить из каталога /storage/usbdisk1/mikopbx/tmp, подключившись к АТС при помощи WinSCP. Файл - log-sys-XXXXXXXXXX.zip
Будьте внимательны! При большом объеме звонков или прочей сетевой «нагрузки» на АТС логи могут занять довольно много места на диске.
Другие способы снятия лога:
С помощью
С помощью
C помощью (дамп звонка)
Подключение S3 хранилища Wasabi
Инструкция по подключению Wasabi Cloud Storage в качестве S3-хранилища
В левом меню выберите раздел "Buckets" и нажмите кнопку "Create Bucket".
На странице создания бакета укажите:
Bucket Name - произвольное уникальное имя для бакета (например, mikopbx-s3-storage).
Region - выберите регион, ближайший к станции MikoPBX.
Запомните название Вашего региона (например, ap-southest-1), оно понадобится при настройке внутри MikoPBX.
Нажмите "Create Bucket".
После создания бакета необходимо создать политику доступа. Перейдите в раздел "Policies" в левом меню и нажмите "Create Policy".
Задайте название для создаваемой политики (Policy Name), придумайте ее описание для будущей идентификации (Description). В поле "Policy Editor" вставьте следующий набор правил:
Замените "YOUR-BUCKET-NAME" на название ранее созданного бакета (mikopbx-s3-storage в этой инструкции)
Перейдите в раздел "Users" в левом меню (блок "Users & Groups") и нажмите "Create User".
На первом шаге "Details" заполните параметры:
UserName - укажите произвольное имя пользователя (например, mikopbx-user).
Type of Access - отметьте только "Programmatic (create API keys)".
Require MFA - оставьте выключенным.
Нажмите "Next".
На шаге Groups - пропустите, нажмите "Next".
На шаге Policies — выберите политику, созданную ранее (например, mikopbx-access в этой инструкции), и нажмите "Next".
На шаге Review проверьте параметры и нажмите "Create User".
После создания пользователя будут отображены Access Key и Secret Key. Сохраните эти значения, они понадобятся для настройки внутри MikoPBX.Secret Key показывается только один раз.
Подключение к MikoPBX
Перейдите во вкладку "Обслуживание" -> "Хранилище".
Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:
Автоматическая загрузка записей в облачное хранилище — включите переключатель.
URL точки доступа S3 — введите endpoint Вашего региона из таблицы ниже.
Например, для региона eu-central-1: https://s3.eu-central-1.wasabisys.com
Регион S3 — укажите регион Вашего бакета в Wasabi (например, eu-central-1
Нажмите «Сохранить».
Регион
Endpoint URL
После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Соединение с S3 успешно» и начнётся синхронизация записей телефонных разговоров.
Настройка Microsoft Outlook (oAuth2)
Настройка почты для сервиса Outlook (outlook.com; hotmail.com)
Настройки внутри Microsoft Entra
Регистрация приложения
Войдите в
Перейдите в раздел "Entra ID" -> "App registrations". Далее нажмите "New registration" для регистрации нового приложения.
Выберите следующие параметры для Вашего приложения:
Name - укажите название для Вашего приложения.
Supported account types - выберите параметр "Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant)".
Укажите Redirect URl:
Select a platform - выберите "Web".
URl:
Замените 192.168.100.71 на адрес Вашей MikoPBX.
Далее нажмите "Register".
Будет созданно приложения. Сохраните client ID, в будущем он понадобится для настройки внутри веб-интерфейса MikoPBX.
Выдача разрешений и создание Client secret
Из главной страницы приложения перейдите в "Manage" -> "API permissions".
Нажмите "Add a permission".
В разделе "Microsoft Graph" выберите "Delegated Permissions". В поиске введите "SMTP". Поставьте галочку напротив "SMTP.Send".
Так же в поиске введите "offline". Поставьте галочку напротив "offline_access".
Нажмите "Add permissions".
Далее перейдите в раздел "Certificates & secrets" -> "Client secrets". Нажмите "New client secret".
Задайте необходимые параметры:
Description - произвольное описание.
Expires - срок на который Вы выпускаете этот client secret. Он понадобится нам для аутентификации приложения в MikoPBX.
После истечения срока, созданный client secret перестанет функционировать и необходимо будет повторить процесс создания нового ключа и подключения к MikoPBX.
После создания, значение Client Secret будет показано всего один раз. Не забудьте скопировать его в Web-интерфейс MikoPBX.
Нажмите "Add".
Скопируйте "Value" (не SecretID!). Он понадобится для настройки в веб-интерфейсе MikoPBX.
Выдача разрешений пользователю
Для корректной работы приложения, Вам необходимо выдать разрешение на использования SMTP протокола для пользователя, чью почту Вы авторизовываете в ходе текущей насройки. Для этого выполните следующие шаги:
Перейдите в центр администрирования организации ().
Перейдите в раздел "Users" -> "Active Users". Нажмите на имя пользователя, под учетной записью которого произодится создание приложения.
В учетной записи, перейдите в раздел "Mail" и выберите "Manage email apps".
Убедитесь, что "Authenticated SMTP" разрешен. Сохраните изменения, нажав "Save changes".
Настройки внутри MikoPBX
Перейдите в Web-интерфейс MikoPBX. Далее "Система" -> "Почта и уведомления" -> "Настройки SMTP".
Заполните все необходимые данные:
Адрес отправителя, Имя отправителя - Ваша почта и от какого имени будут отправляться письма.
Тип аутентификации - OAuth2.
SMTP логин - Ваша почта.
Все остальные настройки оставьте по умолчанию. Более подробное описание Вы можете найти в главное статье о параметрах почты ().
После этого нажмите "Сохранить"!
Нажмите "Подключить через OAuth2". Войдите в Ваш аккаунт Microsoft. Далее подтвердите выдачу всех запрошенных разрешений.
При успешной авторизации Вы увидите соответствующее окно.
VirtualBOX
Установка MikoPBX с помощью VirtualBox
Используйте для установки на VirtualBOX версии АТС MikoPBX ниже 2024.1.114
Версия 2024.1.114 временно не поддерживает установку на VirtualBOX
Кастомизация системных файлов
Описание возможностей раздела "Кастомизация системных файлов"
Раздел «Кастомизация системных файлов» в MikoPBX предоставляет администраторам возможность напрямую изменять или дополнять стандартные конфигурационные файлы системы. Здесь вы можете внести индивидуальные настройки, которые не доступны через стандартный веб-интерфейс, и адаптировать поведение системы под специфические требования вашей организации.
С его помощью можно:
Редактировать конфигурационные файлы: вносить изменения в существующие файлы или добавлять новые параметры.
Переопределять стандартные настройки
7ХХ
0
700, 701, 702…
74952293042
0
74952293042
74(95|99)
7
74952293042, 74996382584…
(7|8)0{1}
1
700, 701, 802, 803…
(25|26)
0
25, 26
[0-9]{1}
0
цифра от 0 до 9-ти, вхождение один раз
[1-5]{2}
0
12, 15, 14, 25 цифра от 1 до 5-ти, вхождение два раза
[8-9]+
0
8899, 888, 988888 цифра от 8 до 9-ти, вхождение от одного и более раз
1. Скачайте программу VirtualBox по ссылке и установите ее.
2. Создайте новую виртуальную машину.
3. Укажите Имя и Папку машины.
Тип - Linux.
Версия - Other Linux (64Bit).
Нажмите Далее.
Укажите размер основной памяти - 1024 МБ, а так же количество процессоров - 2
Нажмите Далее.
5. Выберите Создать новый виртуальный жесткий диск. Введите размер диска 700 МБ, а так же поставьте галочку у пункта "Выделить место в полном размере"
Нажмите Создать.
6. Подтвердите создание виртуальной машины: нажмите кнопку Готово.
Настройка виртуальной машины
1. Перейдите к настройкам созданной виртуальной машины.
Для этого нажмите Настроить.
2. Перейдите на вкладку Носители. Добавьте новый жёсткий диск для хранения записей разговоров.
3. В появившемся окне нажмите Создать.
4. Формат жёсткого диска выберите - VDI (VirtualBox Disk Image).
Нажмите Далее.
5. Жёсткий диск должен быть фиксированного размера.
Поставьте галочку рядом с пунктом "Выделить место в полном размере"
Нажмите Далее.
6. Укажите Имя создаваемого диска.
Установите Размер дискапорядка 50 ГБ.
Нажмите Готово.
7. Выделите вновь созданный диск и нажмите Выбрать.
8. Созданный диск появиться в списке носителей.
9. Смонтируйте на оптический диск образ MikoPBX.
Для этого в разделе Носители выделите оптический диск и в разделе Атрибуты нажмите кнопку выбора файла образа.
10. В появившемся меню нажмите Выбрать файл диска...
11. Выберите скачанный ISO-образ диска и нажмите Открыть.
12. Перейдите на вкладку «Сеть». Установите Тип подключения в значение Сетевой мост.
Нажмите ОК для сохранениявсех произведенных настроек.
На данном этапе MikoPBX загружается с оптического диска, на который записан ISO-образ. На это нам указывает строчка: "The system is loaded in Recovery mode".
3. Переключите язык интерфейса на русский. Для этого выполните Change Language -> Русский. Меню примет вид.
4. Произведите установку MikoPBX.
Все данные на диске, куда устанавливается MikoPBX, будут потеряны.
Нажмите Выполнить установку.
5. Отобразится информация о всех доступных дисках (в данном примере: sdb, sdc).
Диск, на который будет установлена MikoPBX, называется системным (SYSTEM). В качестве системного диска можно выбрать диск, размер которого превышает 500 Мб.
6. Введите с клавиатуры имя диска, который вы подразумевали под "системный", в текущем случае sdb и нажмите Enter (Если он выбран по умолчанию можно просто нажать Enter).
7. Система запросит подтверждение. Введите - y и нажмите Enter.
8. После выполнения установки будет предложено выбрать диск для хранения записей разговоров.
Ориентировочно, 1 час разговора занимает 14Мб места на диске.
Введите имя диска (в данном примере - единственный доступный диск sdc) и нажмите Enter.
9. После завершения установки система перезагрузится.
Теперь MikoPBX будет запускаться с диска sdb, на который вы ее установили.
Увидим, что строчка «The system is loaded in Recovery mode» отсутствует.
На этом установка MikoPBX завершена.
Первый вход в MikoPBX
Для того, чтобы открыть панель управления вам надо вбить в строку браузера IP-адрес вашей виртуальной машины.
Логин и пароль по умолчанию - admin
На этом установка MikoPBX на завершена.
: изменять значения по умолчанию для определенных функций или модулей.
Добавлять собственные скрипты или модули: расширять функциональность системы путем интеграции пользовательских решений.
Он находится в Система -> Кастомизация системных файлов:
Раздел "Кастомизация системных файлов"
Важно отметить, что неправильное изменение системных файлов может привести к нестабильной работе или сбоям системы. Поэтому рекомендуется создавать резервные копии перед внесением изменений и тщательно проверять корректность настроек.
Мы рекомендуем использовать возможности данного раздела только опытным администраторам Asterisk. В MikoPBX есть возможность из web-интерфейса изменять следующие конфигурационные файлы:
Наименование файла
Описание
asterisk.conf
Общие (глобальные) настройки Asterisk.
В файле конфигурации asterisk.conf Вы определяете следующее:
-Местоположение, права доступа и владельца сокета, которые используется для подключения удаленной консоли управления сервером.
Местоположение различных директорий, используемых сервером Asterisk для определения местоположения файлов конфигурации, библиотек, скриптов и место, где будут создаваться лог фалы.
Параметры командной строки запуска сервера, используемые по умолчанию.
cel.conf
Лог событий канала. В отличии от CDR, сохраняет все события имевшие место в канале.
extensions.conf
План набора (dialplan) Asterisk. В нем определяется обработка и маршрутизация входящих и исходящих вызовов. Этот файл управляет поведением всех соединений, проходящих через Вашу АТС.
features.conf
Для редактирования конфигурационного файла воспользуйтесь кнопкой:
Перед Вами будет открыта форма редактирования конфигурационного файла:
Выберите один из четырех возможных вариантов редактирования:
«Не менять» - не позволяет вносить изменения в файл, только чтение файла.
«Добавлять в конец файла» - в конец выбранного конфигурационного файла будут добавлены (рекомендуемый).
«Заменять полностью» - все Ваши изменения переопределят конфигурационный файл.
Режим "Script" - читайте далее.
Кастомизация системных файлов скриптом
Существуют сценарии, когда нужно выполнить более сложные модификации системных файлов, чем простое добавление текста в конец конфигурационного файла. Например, нужно выполнить переопределение параметров PJSIP учетных записей, но хочется сохранить возможность настройки системы через веб интерфейс.
Реализован новый подход к кастомизации. Можно описать bash скрипт, который будет выполняться каждый раз после того, как система сформирует конфигурационный файл. В итоге интегратор сможет делать очень тонкие изменения конфигурационных файлов без разработки дополнительных модулей.
Например, мы хотим поменять значение max_contacts у всех сотрудников, кроме одного.
Кастомизация файлов "скриптом"
sip.conf
Добавить параметры к существующей секции возможно используя конструкцию (+):
Описать новую секцию можно в произвольной форме, единственное, не следует допускать повторения имен секций: Пример:
extensions.conf
Дорабатывайте dialplan с осторожностью - есть большая вероятность нарушить работу АТС!
Существует возможность перехватить выполнения dialplan. Для этого необходимо описать custom контексты. На текущий момент можно перехватить выполнения в следующих контекстах:
internal-originate-custom - контекст используется при звонках из панели телефонии для 1С
<ID-ПРОВАЙДЕРА>-incoming-custom - контекст предназначен для обработки входящих вызовов через провайдера
<ID-ПРОВАЙДЕРА>-outgoing-custom - контекст предназначен для обработки исходящих вызовов через провайдера
all_peers-custom - контекст используется при прямом исходящем звонке с телефона
outgoing-custom - контекст используется при наборе внешнего номера, ДО выбора исходящего маршрута
add-trim-prefix-clid-custom - этот контекст используется при обработке входящих вызовов, лучшим образом подходит для нормализации входящего номера телефона, добавить / отсечь префикс
internal-users-custom - в этом контексте обрабатываются вызовы на внутренние номера
public-direct-dial-custom - контекст обработки входящих вызовов БЕЗ авторизации
Пример контекста:
Обязательно следует в конце вызывать метод «return».
Некоторые примеры использования custom-контекстов:
[user2_pingtel]
type=friend
username=user2_pingtel
secret=blah
host=dynamic
qualify=1000 ; Рассматриваем клиента как неработающего,
; если ответ от него идет более 1 сек.
callgroup=1,3-4 ; Клиент является членом групп вызовов: 1, 3 и 4
pickupgroup=1,3-4 ; Мы можем совершать "pick-up" вызовов, нажатием *8,
; для вызовов из групп 1, 3 и 4
defaultip=192.168.0.60
disallow=all
allow=ulaw
allow=alaw
allow=g729
Инструкция актуальна для версии 2024.2.135 и новее!
В данной инструкции мы пошагово произведем установку MikoPBX с помощью облачной платформы Alibaba cloud.
Перед началом Вам необходимо скачать актуальный образ MikoPBX с расширением .raw. Сделать это можно на github MikoPBX.
Загрузка образа в Alibaba cloud
Создание Bucket
Для начала необходимо создать bucket для хранения образа. Для этого необходимо перейти в "OSS Management Console" ().
Перейдите в раздел "Buckets".
Нажмите "Create Bucket" для создания нового Bucket'а:
Заполните следующие данные:
"Bucket name" - произвольное название для хранилища.
"Region" - выберите регион, где будет храниться ваш образ
Регион у хранилища для образа и регион виртуальной машины должны совпадать!
Нажмите "OK".
Перейдите в созданный bucket, нажав на его название в разделе "Buckets":
Нажмите "Upload object" и загрузите ранее скаченный файл образа диска в формате .raw (все параметры оставьте по умолчанию).
После того, как файл образа диска будет загружен, Вам необходимо скопировать ссылку на него. Для этого нажмите "View Details" справа от названия файла, в открывшемся меню скопируйте ссылку из поля "URL".
Создание образа
Вернитесь в ECS Console (). Перейдите в раздел "Images".
Нажмите "Import Image" для испорта образа из хранилища (Bucket):
В открывшейся вкладке выберите "Linux Operating System" и нажмите "Next".
Введите/выберите следующие параметры для образа:
"Image File URL" - вставьте ранее скопированную ссылку на загруженный файл образа диска.
"Image Name" - введите произвольное, уникальное название для Вашего образа.
"OS Type" - linux
Нажмите "OK" для создания образа. Дождитесь его создания (при завершении в поле Status вы увидите надпись Available)
Создание пары SSH-ключей
Далее необходимо создать и добавить связку SSH ключей в Alibaba Cloud.
В ESS Консоли перейдите в раздел "Network Security" -> "Key Pairs":
Нажмите "Create SSH Key Pair".
Далее необходимо сгенерировать пару SSH-ключей. Про то как это сделать - Вы можете прочитать . Далее заполните все необходимые данные:
"Name" - произвольное название для создаваемой связки ключей
"Creation Mode" - Import
"Public Key" - вставьте Ваш публичный ключ, сгенерированный ранее
Нажмите "OK" для создания связки ключей в облаке
Создание группы правил
Перед созданием виртуальной машины так же нужно создать и группу правил (firewall).
Перейдите в раздел "Network & Security" -> "Security Groups"
Нажмите "Create Security Group":
Укажите следующие параметры для группы правил:
"Security Group" - введите произвольное название для группы правил.
"Network" - выберите вашу сеть. Если она не созданна - нажмите "Create VPC" справа от поля.
"Security Group" - Basic Security Group.
Обязательно настройте firewall в самой MikoPBX как можно раньше после создания виртуальной машины. Подробнее про то как это сделать, Вы можете прочитать .
Нажмите "Create Security Group".
Создание виртуальной машины
Перейдите в раздел "Instances & Images" -> "Instances":
Нажмите "Create Instance" для создания новой виртуальной машины.
Выберите параметры для вашей виртуальной машины:
"Billing Method" - выберите вариант оплаты ВМ.
"Region", "Network and Zone" - выберите параметры региона и зоны, подходящие Вам.
"Image" - выберите "Custom Images" -> Загруженный ранее образ
"Storage" - выберите тип и размер "System Disk". 20 Гб - минимально возможный в Alibaba Cloud.
Добавьте второй диск, нажав "Add Data Disk". Укажите его тип и размер.
Рекомендуемый размер диска для хранения записей разговора - не менее 50ГБ. В данной инструкции, в качестве примера, используется диск размером 30ГБ.
Выберите параметры сети для Вашей ВМ. Группа правил будет назначена автоматически (ранее созданная):
Нажмите "Create Order".
Подключение к консоли MikoPBX
В разделе "Instances" перейдите к созданной виртуальной машине, нажав на ее название.
Подключение из встроенной в облако консоли
Нажмите "Connect".
Выберите "VNC". Произойдет подключение в новой вкладке Вашего браузера.
Подключение по SSH
Подробнее про SSH-подключения Вы можете узнать . В данной документации, в качестве примера будет продемонстрировано подключение по SSH через PowerShell.
Введите следующую команду для SSH-подключения:
Замените C:\Users\username\.ssh\id_ed25519 на путь к ssh-ключам; root- на Ваше имя для ssh-авторизации (если оно было изменено при создании ВМ); ip-adress - на Внешний адрес MikoPBX.
Произойдет подключение по SSH:
Первая авторизация в WEB-интерфейсе
На главной странице виртуальной машины находятся несколько важных параметров для авторизации в WEB-интерфейсе.
Вставьте IP-адрес в адресную строку браузера - Вы попадете на страницу авторизации в web-интерфейс MikoPBX.
Данные для входа:
Username - admin
Password - ID Вашей виртуальной машины
UTM
Установка MikoPBX в UTM
В данной иснтрукции будет произведена установка на UTM. Перед ее началом скачайте файл образа диска с расширением ".iso". Сделать это можно по ссылке.
Данная инструкция актуальна с первого релиза, опубликованного в 2026 году. Протестированно на процессорах Apple Silicon.
Создание виртуальной машины
Перейдите в UTM. Нажмите "Create a New Virtual Machine" для создания новой виртуальной машины.
В качестве типа виртуальной машины выберите "Virtualize".
В качестве типа операционной системы выберите "Preconfigured" - "Linux".
Выберите ранее загруженный файл образа диска в разделе "Boot ISO Image". Для этого нажмите на "Browse...".
Далее укажите характеристики Вашей виртуальной машины. В нашем случае будут использованы 2 ГБ ОЗУ и 2 ядра процессора.
Далее укажите размер для системного диска. В нашем случае - 1 Гб.
В MikoPBX используются два диска:
Системный диск. На него устанавливается система, рекомендуемый размер - 1 Гб.
Диск для хранения записей разговоров. Рекомендуемый размер - от 50 Гб.
Нажмите Continue.
Будет отображена итоговая конфигурация виртуальной машины. Задайте ей желаемое имя (поле "Name"). И нажмите "Save".
Подключение диска для хранения данных
Перейдите в настройки ВМ. Для этого нажмите правой кнопкой мыши по её названию, далее "Edit".
Перейдите в "Drives". Нажмите "New..."
Создайте новый диск со следующими параметрами:
Interface - VirtlO
Size - не менее 50Гб (в этой документации для тестовой машины будет использовано 10Гб)
Нажмите "Create".
Установка системы
Запустите виртуальную машину.
После загрузки Вы увидите надпись PBX is running in Live or Recovery mode. Это означает, что система загружена из образа диска в Live режиме. Необходимо произвести установку системы. Для этого перейдите к разделу "[8] Install on Hard Drive".
Выберите диск для установки системы. В нашем случае доступны диски vda и vdb, для установки выбираем диск vda.
Подтвердите выбор: введите "y" с клавиатуры и нажмите Enter.
Далее выберите диск для хранения записей разговоров. В нашем случае единственный оставшийся размером 10 Гб.
После этого система будет перезагружена и доступна в обычном режиме (надпись "PBX is running in Live or Recovery mode" пропадет).
Введите этот IP-адрес в строку браузера для перехода в Веб-интерфейс.
Стандартные данные для входа:
Login: admin
Password: admin
AWS подробная инструкция
Установка MikoPBX в AWS с помощью произвольного образа
Авторизуйтесь в сервисе Amazon Web Services
Для выполнения инструкций установите утилиту командной строки Amazon, для этого откройте Терминал и введите в командной строке
Приступим к настройке
Для быстрого и удобного поиска в сервисе Amazon используйте панель поиска
Обеспечение безопасности MikoPBX
Как защитить MikoPBX от взлома и несанкционированного доступа
В последнее время участились случаи взлома IP-АТС. Злоумышленники получают доступ к телефонии и совершают звонки за ваш счёт — на платные номера и международные направления. Это может привести к потерям в десятки и сотни тысяч рублей за считанные часы.
Кроме прямых финансовых потерь, взломанная АТС может использоваться мошенниками для звонков от имени вашей организации — например, для обзвона граждан якобы от лица банков или государственных органов. При этом у жертв отображается номер вашей компании, что ведёт к репутационному ущербу и возможным проверкам со стороны правоохранительных органов.
Пройдитесь по всем пунктам этой инструкции — даже если вы уже настраивали систему, возможно, что-то было упущено.
Критическая уязвимость в версии 2024.1.114!
В файле назначаются пользовательские коды и опции абонентских функций Asterisk, такие как: перевод вызова (transfer); перехват вызова (pickup); запись по требованию (record on demand); таймауты набора и переадресации (digit timeout); паркинг (park) и др.
http.conf
Встроенный http сервер Asterisk
iax.conf
В файле Вы описываете ваши соединения по протоколу IAX.
indications.conf
Национализация тональных сигналов
logger.conf
Настройка логов Asterisk. В данном файле настраивается логирование событий Asterisk в файлы, консоль и syslog linux. Для применения настроек выполните команду «logger reload» в консоли (CLI) Asterisk.
manager.conf
Настройка интерфейса AMI (Asterisk Manager Interface)
modules.conf
Параметры загрузки модулей Asterisk.
musiconhold.conf
Параметры музыки на удержание в IVR
queues.conf
Очередь входящих вызовов Asterisk. Подробное описание стратегии вызовов. Penalty, timeout, member и все доступные параметры.
rtp.conf
Глобальные настройки RTP - медиа-портов и протокола
sip.conf
Файл отвечает за настройку внутренних и внешних каналов SIP в Asterisk.
voicemail.conf
Настройки уведомлений по E-mail
jail.local
Настройки Fail2ban
msmtp.conf
Настройки SMTP-клиента
"OS Version" - Others Linux
"Architecture" - 64-bit OS
Уберите галочку с чек-бокса "Check After Import".
"Resource Group" - выберите Вашу ресурсную группу в облаке
"Resource Group" - выбрите Вашу группу ресурсов.
Разрешите все входящие подключения (пример на скриншоте ниже). Все исходящие подключения разрешены по умолчанию.
Загрузите файл из дистрибутива MikoPBX с расширением .raw
Нажмите кнопку Upload
Дождитесь окончания загрузки файла
Добавление прав и прикрепление политик
Если для данного облака не выполнялось, сделайте один раз
Создайте отдельную папку для файлов на компьютере
Создайте в папке файл trust-policy.json
Откройте Терминал и перейдите к созданной папке
Выполните команду vi trust-policy.json
Перейдите в режим редактирования, нажав i, вставьте текст
Нажмите ESC и напишите :wq, чтобы записать файл
Аналогично создайте файл role-policy.json, измените значение имени бакета в тексте на имя созданного вами бакета
Аналогично создайте файл import-image.sh, измените значения параметра DEFAULT_BUCKET на имя созданного вами бакета и параметра DEFAULT_IMAGE на имя образа, загруженного в бакет
Выполните команду aws configure, укажите регион и скопированные ключи Access key и Secret access key
Выполните команду
Выполните команду
Выполните команду
В случае успешного выполнения команды будет сформирован уникальный идентификатор образа AMI
Создание виртуальной машины
Откройте Services / Compute / EC2 и перейдите в раздел Images / AMIs
Выберите созданный образ и нажмите кнопку Launch an instance form AMI для создания виртуальной машины
Введите имя виртуальной машины (Name), например mikopbx-vm
Укажите тип машины (Instance type) - t3.micro
Если у вас есть ключ SSH, выполните следующее
Укажите SSH ключ в поле Key pair
Если у вас есть нет ключа SSH, выполните следующее
Выберите Create new key pair и укажите имя пары ключей (Key pair name), например mikopbx_key
Следуйте дальше по инструкции
В разделе Network settings установите флажки Allow SSH traffic и Allow HTTPS traffic
По умолчанию весь входящий трафик к EC2 в AWS запрещен, в том числе и SIP трафик. После создания ВМ не забудьте настроить security group к которой она прикреплена (разрешить необходимый трафик).
Для развертывания АТС используйте два диска:
диск объемом 1 Гб для основной системы
диск объемом 50+ Гб для хранения записей разговоров
При необходимости измените размер диска для хранения данных в разделе Configure storage, по умолчанию его размер - 50Гб
Для других полей используйте значения по умолчанию
Нажмите кнопку Launch instance
Запуск АТС MikoPBX
Перейдите к созданной виртуальной машине mikopbx-vm
На открытой вкладке выберите Connect / EC2 serial console, дождитесь полной загрузки системы, пока не отобразятся параметры авторизации
Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера
Для входа используйте указанные в EC2 serial console логин и пароль
Обязательно выполните настройку Firewall на самой АТС MikoPBX
#!/bin/bash
# Определение переменных по умолчанию
DEFAULT_IMAGE="mikopbx-2024.1.40-dev-x86_64.raw"
DEFAULT_BUCKET="mikopbx-bucket"
DEFAULT_DESCRIPTION="MikoPBX the best open source PBX on asterisk"
DEFAULT_NAME="MikoPBX 2024.1.40-dev"
# Переопределение переменных значениями переменных окружения, если они установлены
IMAGE="${IMAGE:-$DEFAULT_IMAGE}"
BUCKET="${BUCKET:-$DEFAULT_BUCKET}"
DESCRIPTION="${DESCRIPTION:-$DEFAULT_DESCRIPTION}"
NAME="${NAME:-$DEFAULT_NAME}"
# Файл JSON для команды import-snapshot
JSON_FILE="disk_container.json"
# Создание файла JSON
cat <<EOF> ${JSON_FILE}
{
"Description": "${DESCRIPTION} image",
"Format": "raw",
"UserBucket": {
"S3Bucket": "${BUCKET}",
"S3Key": "${IMAGE}"
}
}
EOF
# Импорт снимка
IMPORT_TASK_ID=$(aws ec2 import-snapshot --description "${DESCRIPTION} image" --disk-container "file://${JSON_FILE}" --query 'ImportTaskId' --output text)
echo "Import task started with ID: $IMPORT_TASK_ID"
# Ожидание завершения импорта снимка
while true; do
STATUS=$(aws ec2 describe-import-snapshot-tasks --import-task-ids $IMPORT_TASK_ID --query 'ImportSnapshotTasks[0].SnapshotTaskDetail.Status' --output text)
echo "Current status: $STATUS"
if [ "$STATUS" == "completed" ]; then
break
fi
sleep 30
done
# Получение SnapshotId
SNAPSHOT_ID=$(aws ec2 describe-import-snapshot-tasks --import-task-ids $IMPORT_TASK_ID --query 'ImportSnapshotTasks[0].SnapshotTaskDetail.SnapshotId' --output text)
# Регистрация AMI
AMI_ID=$(aws ec2 register-image \
--name "$NAME" \
--description "$DESCRIPTION" \
--architecture x86_64 \
--sriov-net-support simple \
--virtualization-type hvm \
--ena-support \
--boot-mode legacy-bios \
--root-device-name "/dev/sda1" \
--block-device-mappings "[{\"DeviceName\": \"/dev/sda1\", \"Ebs\":{\"DeleteOnTermination\":true, \"VolumeSize\":1, \"SnapshotId\":\"$SNAPSHOT_ID\"}}, {\"DeviceName\": \"/dev/sdb\", \"Ebs\":{\"VolumeSize\":50}}]" \
--query 'ImageId' \
--output text)
echo "AMI created with ID: $AMI_ID"
aws configure
aws iam create-role --role-name vmimport --assume-role-policy-document "file://trust-policy.json"
aws iam put-role-policy --role-name vmimport --policy-name vmimport --policy-document "file://role-policy.json"
sh import-image.sh
Обнаружена уязвимость в модуле внешней панели: если модуль опубликован в интернет или Firewall настроен некорректно, злоумышленник может получить все SIP-учётки и совершать звонки от имени Вашей компании.
Необходимо выполнить следующие шаги:
Обновиться до версии 2026.1.223 или новее.
Установить патч безопасности (см. ниже).
Закрыть WEB, CTI и SIP-доступ к станции из2вне.
Обновить все пароли.
Патч безопасности для версии 2024.1.114
Если вы используете версию 2024.1.114, установите патч одной командой:
Если вы используете более старую версию — обновитесь до актуального релиза. Шаги 3 и 4 из списка выше необходимо выполнить в любом случае, независимо от версии.
Обязательные меры безопасности
Включите сетевой экран (Firewall)
Сетевой экран — первая линия защиты. Он ограничивает, кто может подключаться к вашей АТС.
Перейдите в раздел «Сеть и Firewall» → «Сетевой экран», убедитесь что переключатель активирован и создайте правила, разрешающие доступ только из нужных подсетей.
Какие адреса добавить в правила:
Подсеть вашего офиса
Адреса VPN-сервера
Адреса вашего провайдера телефонии (уточните у провайдера)
Статические IP-адреса удалённых сотрудников
Для удалённых сотрудников с динамическим IP рекомендуем подключить у их интернет-провайдера услугу статического IP-адреса (обычно 100–200 ₽/мес). Альтернатива — VPN: все удалённые сотрудники подключаются через VPN-сервер, и в Firewall добавляется только его адрес.
Подробная инструкция:
Закройте веб-интерфейс и CTI от интернета
Панель управления АТС — это «ключи от всей системы». Если она доступна из интернета без ограничений, злоумышленник может получить полный контроль над телефонией.
В правилах сетевого экрана разрешите WEB и CTI-доступ только для подсети вашего офиса или VPN. Для всех остальных правил отключите галочки WEB и CTI. Если вам нужен удалённый доступ — используйте VPN.
Используйте сложные пароли
Простой пароль — самая частая причина взлома. Злоумышленники перебирают тысячи комбинаций в секунду, и пароли вроде 1234, admin или password подбираются мгновенно.
Требования к паролям SIP-аккаунтов и веб-интерфейса:
Минимум 12 символов
Буквы ВЕРХНЕГО и нижнего регистра
Цифры и специальные символы (!@#$%^&*)
Без словарных слов, имён и дат рождения
Что проверить:
Откройте карточку каждого сотрудника в разделе «Телефония» → «Сотрудники» и убедитесь, что SIP-пароль достаточно сложный
Проверьте пароль для входа в веб-интерфейс в разделе «Система» → «Общие настройки» → «Пароль WEB интерфейса»
Измените имя авторизации (Auth Username)
По умолчанию для SIP-авторизации используется внутренний номер сотрудника (например, 204). Злоумышленники это знают и перебирают именно стандартные номера.
Auth Username — это имя пользователя, которое телефон или софтфон отправляет при регистрации на АТС. Оно отличается от внутреннего номера и используется исключительно для проверки подлинности подключения.
Как настроить префикс Auth Username в MikoPBX:
Перейдите в «Система» → «Общие настройки» → «SIP» и заполните поле «Префикс Auth Username для авторизации». Например, при префиксе MIKO внутренний номер 204 будет авторизоваться как 204MIKO.
После изменения Auth Username необходимо обновить настройки на каждом телефоне или софтфоне. В зависимости от производителя, настройка называется по-разному:
Производитель
Название настройки
Yealink
Register Name / Authentication User
Grandstream
Authenticate ID
Fanvil
Authentication User
Snom
Обычно эта настройка находится в разделе Account или SIP Account в веб-интерфейсе телефона.
Включите защиту от перебора паролей (Fail2Ban)
Fail2Ban автоматически блокирует IP-адреса, с которых идут подозрительные попытки подключения.
Перейдите в раздел «Сеть и Firewall» → «Защита от взлома» и проверьте указанную степень защиты от атак:
Слабая — 20 попыток за 10 мин, бан на 10 мин. Для первой настройки и доверенных сетей.
Нормальная — 10 попыток за 1 час, бан на 1 день. Рекомендуется для большинства.
Усиленная — 5 попыток за 6 часов, бан на 7 дней. Для серверов в интернете.
Паранойя — 3 попытки за 24 часа, бан на 30 дней. Для серверов под активной атакой.
Убедитесь, что в белом списке указаны адреса вашего офиса, чтобы случайно не заблокировать себя.
Fail2Ban не заменяет сложные пароли — даже с включённым Fail2Ban простой пароль может быть подобран.
Раздел "Защита от взлома"
Не публикуйте АТС на публичном IP-адресе
Если АТС доступна напрямую из интернета — она становится мишенью для автоматических сканеров, которые круглосуточно ищут уязвимые системы.
Разместите АТС за NAT-маршрутизатором
Для удалённых сотрудников используйте VPN-подключение
Если публичный IP неизбежен — обязательно настройте сетевой экран и Fail2Ban
В разделе «Сеть и Firewall» → «Сетевые интерфейсы» правильно укажите топологию сети и внешний адрес. (Подробнее читайте ).
Финансовая защита
Даже при хорошей технической защите стоит подстраховаться финансово. Если взлом всё-таки произойдёт, эти меры ограничат возможный ущерб.
Установите лимит расходов у провайдера
Свяжитесь с вашим провайдером телефонии и попросите:
Установить суточный лимит расходов на исходящие звонки
Включить запрет работы при отрицательном балансе
Заблокировать звонки на международные и платные направления, если вы ими не пользуетесь
Не держите на счёте большие суммы
Пополняйте баланс небольшими суммами по мере необходимости
Настройте уведомления о расходах у провайдера, если такая возможность есть
Что делать, если взлом уже произошёл?
Если вы обнаружили, что АТС была взломана, действуйте по следующей схеме:
Шаг 1 — Немедленно изолируйте АТС
Закройте доступ к станции извне через сетевой экран. Смените все пароли — SIP-аккаунтов, веб-интерфейса, SSH.
Шаг 2 — Сохраните логи и записи разговоров
Сохраните файлы записей разговоров и логи системы отдельно — они могут понадобиться как доказательства. Со временем они могут быть перезаписаны.
Шаг 3 — Уведомите оператора связи
Свяжитесь с вашим провайдером телефонии и сообщите об инциденте. Оператор может помочь заблокировать дальнейшие звонки и зафиксировать факт взлома.
Шаг 4 — Подайте заявление в УФСБ
Обратитесь в территориальное управление ФСБ с заявлением об инциденте в сфере ИТ-безопасности. Кратко опишите что произошло, укажите что звонки совершались без вашего ведома и что вы готовы предоставить логи и записи разговоров.
Обращаться следует именно в УФСБ, а не в МВД — это инцидент в сфере ИТ-безопасности, а не мошенничество с вашей стороны. На месте можно указать, что письменный ответ не требуется.
Чек-лист безопасности
Пройдитесь по этому списку и убедитесь, что все пункты выполнены:
Главная страница UTM. Создание новой виртуальной машины.
Выбор типа виртуальной машины
Выбор типа операционной системы
Выбор файла образа диска для виртуальной машины
Конфигурация ВМ
Указание размера системного диска
Раздел "Shared Directory"
Итоговая конфигурация
Настройки ВМ
Раздел "Drives"
Создание второго диска
Запуск ВМ
MikoPBX в режиме LiveCD
Выбор диска для установки системы
Подтверждение выбора диска
Выбор диска для хранения записей разговоров
IP-адрес MikoPBX
Web-интерфейс MikoPBX
Провайдеры телефонии
Подключение и настройка провайдеров телефонии в MikoPBX
«Провайдеры телефонии» в MikoPBX — это раздел системы, где настраиваются подключения к внешним операторам связи через интернет-протоколы для IP-телефонии. Здесь администраторы могут добавлять и настраивать учетные записи SIP-транков или других типов соединений, которые позволяют системе совершать и принимать звонки с городских и мобильных номеров.
Чтобы совершать или принимать внешние телефонные звонки по телефонной сети общего пользования или Интернет, вы должны создать, по крайней мере, одну учетную запись провайдера.
Каждая технология имеет свой тип учетной записи. Для добавления новой учетной записи или изменения существующей, перейдите в "Маршрутизация" -> "Провайдеры телефонии":
Раздел "Провайдеры телефонии"
Обзор провайдеров содержит список всех доступных поставщиков услуг. Зеленый значок перед именем поставщика означает, что MikoPBX зарегистрировала этого провайдера, и Вы можете начать работу с этим провайдером.
С помощью переключателя слева можно включать использование провайдера и отключать соответственно:
Переключение статуса провайдера
Для подключения новой учетной записи провайдера нажмите Подключить SIP или Подключить IAX в зависимости по типа подключаемой учетной записи:
Настройка SIP провайдера
Общие настройки
Инструкции по подключению наиболее популярных поставщиков услуг можно найти в .
В общих настройках SIP провайдера укажите следующие настройки:
Название провайдера - произвольное удобное вам наименование. Оно будет отображаться в списках выбора в соответствующих меню.
Тип учетной записи - тип регистрации учетной записи провайдера. .
Хост или IP адрес - может быть либо URL либо IP-адресом
Логин и Пароль, который предоставляет ваш провайдер
Режим DTMF - определяет, как DTMF сигналы передаются через SIP. Cуществуют различные стандарты, используемые для передачи DTMF SIP-провайдерам. Попробуйте использовать различные стандарты для того, чтобы найти режим, который подойдет вам.
inband передает нажатия клавиш в качестве «тона». Для использования этого стандарта вам необходим аудио кодек высокого качества. Auto, rfc и info передают нажатия клавиш в SIP кодирование.
Расширенные настройки SIP провайдера
Дополнительные адреса провайдера
В этом разделе следует перечислить все адреса поставщика услуг связи, с которых могут приходит входящие звонки. Доступ для этих адресов к портам SIP и RTP будет автоматически открыт на firewall.
Порт соединения SIP
По умолчанию принимает значение 5060. SIP протокол описывает, каким образом клиентское приложение (например, софтфон) может запросить начало соединения у другого, возможно, физически удалённого клиента, находящегося в той же сети, используя его уникальное имя.
Протокол определяет способ согласования между клиентами об открытии каналов обмена на основе других протоколов, которые могут использоваться для непосредственной передачи информации (например, RTP).
Транспортный протокол
Позволяет указать используемый транспортный протокол для данной учетной записи провайдера.
Outbound proxy
Это SIP прокси сервер провайдера для обработки запросов. Реальный SIP сервер, может отличаться от этого адреса. Outbound proxy принимает на себя первичные запросы и перенаправляет на нужный сервер.
Режим NAT
Режим NAT - Это механизм в сетях TCP/IP, позволяющий преобразовывать IP-адреса транзитных пакетов.
force_rport,comedia опция заменяющая nat=yes;
force_rport даже если ни одного параметра rport не было указано, действовать, так, как если бы он был;
comedia отправлять RTP пакеты обратно к порту с которого они были получены, игнорируя требуемый порт в SDP заголовке;
Поддерживать NAT сессию
При включение этой опции Asterisk будет отправлять SIP Options пакеты. Это необходимо для поддержки NAT туннелирования на вашем маршрутизаторе.
Укажите частоту, с которой Asterisk будет отправлять SIP сообщение типа OPTIONS для проверки, что данное устройство работает и доступно для совершения вызовов.
Если данное устройство, не ответит в течение заданного периода (60 секунд по умолчанию), тогда Asterisk рассматривает это устройство как выключенное и недоступное для совершения вызовов.
Переопределение SIP заголовка "From"
Можно отключить использование поля fromuser заголовка SIP-пакета.
Параметры файла pjsip.conffromuser и fromdomain используются для вызовов исходящих от Asterisk в сторону SIP устройства.
Можно переопределить:
имя пользователя в поле From в SIP пакетах (fromuser);
имя домена в поле From в SIP пакетах (fromdomain).
Для этого служат поля User и Domain соответственно.
Дополнительные параметры
В этом поле вы можете изменять конфигурационные файлы Asterisk.
Переопределять можно практически все параметры. К примеру при использовании chan_pjsip провайдер описывается следующими секциями:
Для переопределения полей в секциях следует заполнить поле Дополнительные параметры следующим образом:
Для завершения настройки нажмите Сохранить.
Несколько провайдеров на одном IP
Бывают случаи, когда необходимо подключить несколько учетных записей одного поставщика услуг связи. В этом случае настройки Хост или IP адрес и Порт соединения SIP могут оказаться одинаковыми для всех учетных записей.
Asterisk такую ситуацию обыгрывает по-своему. АТС не сможет корректно «приземлить» вызов на нужного провайдера и вызов оборвется.
В качестве решения, в старых версиях АТС можно было для какой учетной записи описать дополнительные входящие маршруты и заполнить поле Дополнительный номер (DID) значением Логин. И так для каждой учетной записи требовалось создать некоторое количество дополнительных маршрутов, равное количеству аккаунтов провайдера.
Альтернатива инструкции . Такой подход был не очевиден.
Поле Логин в большинстве случаев при входящем звонке будет использоваться в качестве номера назначения Дополнительный номер (DID). И, учитывая, что выходящие маршруты для всех Логин будут описаны, вызов будет корректно обработан телефонной станцией.
Подробнее про тип регистрации
Исходящая регистрация
Этот вариант используется при подключении большинства провайдеров.
Необходимость регистрации возникает в случае, когда провайдер не может знать, с какого IP-адреса будет подключаться клиент, к примеру, когда АТС расположена за NAT. Сервер провайдера обычно на публичном IP-адресе.
Входящая регистрация
Этот вариант актуален для работы некоторых FXO / GSM шлюзов - когда внешнее устройство должно подключиться к вашей АТС по логину и паролю.
Также этот вариант актуален, когда удаленное устройство находится за NAT и MikoPBX не может знать его IP адрес.
Аутентификация по IP адресу, без пароля
Актуально для безопасных частных сетей. Так к примеру Ростелеком часто ведет свой сетевой кабель и подключает клиента к своей локальной сети.
АТС и провайдер в данном случае должны находиться в одной и той же сети.
Очереди вызовов
Создание и настройка очередей вызовов.
Очереди позволяют:
Распределять телефонные звонки между группой сотрудников (агентов): Вы можете создать очередь вызовов и добавить в нее несколько сотрудников. Когда поступает звонок, система автоматически направляет его к доступному сотруднику в очереди, обеспечивая более равномерное распределение нагрузки и повышая эффективность обработки вызовов.
Удерживать клиента на линии, если все сотрудники заняты: Если все сотрудники в очереди заняты обработкой других вызовов, клиент будет удерживаться на линии, пока не освободится один из сотрудников. Это помогает избежать потери вызовов и обеспечивает более качественное обслуживание клиентов.
Оповещать клиента о позиции в очереди и приблизительном времени ожидания: При нахождении клиента в очереди система может предоставлять информацию о его текущей позиции в очереди и ориентировочное время ожидания. Это помогает удержать клиента в курсе ситуации и улучшает его опыт общения.
Передавать на телефон сотрудника имя очереди, вместе с номером клиента: Когда сотрудник принимает вызов из очереди, на его телефоне отображается не только номер клиента, но и имя соответствующей очереди. Это помогает сотруднику более эффективно обрабатывать вызовы и предоставлять персонализированное обслуживание.
Для настройки очередей вызовов в MikoPBX следует перейти в раздел "Телефония" и выбрать "Очереди вызовов". Здесь вы сможете создать и настроить свои очереди в соответствии с требованиями вашего бизнеса и потребностями обслуживания клиентов.
Длительность вызова на очередь по умолчанию равна 300 секундам. После истечения этого времени вызов будет завершен. Для обхода этого ограничения следует настроить Сценарий 1 (см. далее инструкции Маршрутизация звонков при сбоях).
Основные параметры
Для добавления новой очереди выполните действие Создать новую очередь.
Укажите Название очереди - при настройке маршрутизации вы будете ориентироваться на него.
Заполните описание в поле Заметка - оно будет доступно в списке очередей.
Стратегия и операторы очереди
В разделе Операторы очереди можно добавить произвольное число сотрудников (агентов очереди) и указать стратегию распределения вызовов.
Вызов на любого свободного
"Вызов поступает на любого свободного участника очереди кроме участника, обработавшего последний вызов" - эта стратегия также именуется как "rrmemory" - Round Robin Memory.
АТС помнит, кому был направлен последний вызов, и следующий вызов отправляется следующему оператору в списке.
Порядок списка сотрудников можно определить в разделе "Операторы очереди", перетаскиванием можно переместить оператора вверх или вниз.
Пример:
Если у вас описаны: Оператор1, Оператор2, Оператор3, и последний вызов был направлен Оператор2, то следующий вызов пойдёт Оператор3, потом Оператор1, и т.д. — в цикле, не с начала, а с "места остановки".
"Время попытки дозвона операторам" - для данной стратегии параметр определяет длительность попытки звонка оператору. Если оператор не ответил, то АТС пытается звонить следующему доступному согласно условиям стратегии.
Вызов одновременно на всех
Вызов поступает одновременно на всех участников очереди, включая тех, кто занят (по умолчанию) - также эта стратегия именуется как "ringall"
АТС будет инициировать вызов всем оператором очереди одновременно. Следует учитывать, что скорость поступления вызову оператору зависит от сети предприятия.
Пример:
Если в очереди определены операторы
Оператор с внутренним номером, подключен стационарный IP телефон в локальной сети - вызов поступит мнгновенно
Оператор с внутренним номером, подключен софтфон на смартфон через LTE - вызов поступит с задержкой
Оператор с мобильным номером - вызов поступит с значительной задержкой 5-8 секунд
Задержка поступления вызова связана с особенностями внешних сетей (относительно предприятия), но начало вызова происходит одновременно.
"Время попытки дозвона операторам" - спустя это время вызов всем операторам завершится и инициируется новый вызов.
Вызов на того, кто дольше не принимал вызовы
Вызов поступает на участника очереди, который дольше всех не принимал звонки - также эта стратегия именуется как "leastrecent"
Каждый новый вызов направляется оператору, который дольше всех не принимал вызовов, анализируется только последний отвеченный вызов.
Пример:
101 — последний вызов: 10:00
102 — последний вызов: 10:05
103
Как "Время попытки дозвона операторам" = 20 влияет на вызов:
АТС набирает номер 103 (он дольше всех не принимал вызов).
Проходит 20 секунд → оператор не ответил.
АТС считает, что агент недоступен, и НЕ обновляет время последнего вызова (вызов не был принят!)
Очередь выбирает снова 103 (он дольше всех не принимал вызов).
⚠️ Ключевой момент: если агент не ответил — он всё ещё считается "не занятым", и может быть выбран снова в ближайшем будущем, потому что его "время последнего вызова" не обновилось.
Счетчик отвеченных вызовов сбрасывается при перегрузке АТС.
Вызов на того, кто меньше отвечал на вызовы
Вызов поступает на участника очереди, который обработал меньше всего звонков - также эта стратегия именуется как "fewestcalls"
Каждый новый вызов направляется оператору, который меньше всех принимал вызовов, анализируется только количество отвеченных вызов.
Пример:
101 — всего вызов: 1 ← меньше всего вызовов
102 — всего вызов: 5
Счетчик отвеченных вызовов сбрасывается при перегрузке АТС.
Как "Время попытки дозвона операторам" = 20 влияет на вызов:
АТС выбирает 101 (меньше всех обработал вызов).
Проходит 20 секунд → оператор не ответил.
АТС считает, что агент недоступен, и НЕ обновляет количество вызовов (вызов не был принят!),
Очередь выбирает снова 101 (меньше всех обработал вызов).
⚠️ Ключевой момент: если агент не ответил — он всё ещё считается "не занятым", и может быть выбран снова в ближайшем будущем, потому что его "количество отвеченных вызовов" не обновилось.
Вызов на любого свободного
Вызов поступает на любого свободного участника очереди - также эта стратегия именуется как "random" - вызов случайного оператора.
"Время попытки дозвона операторам" - спустя это время вызов оператору завершится и инициируется вызов на следующего произвольного сотрудника
Вызов поступает на каждого участника очереди по порядку
Также эта стратегия именуется как "linear".
Пример операторов:
101 ← вызов всегда будет поступать сперва на этого сотрудника
102 - спустя "Время попытки дозвона операторам" вызов оператору завершится и инициируется вызов на следующего
103
В asterisk есть ограничение: "Changing to the linear strategy currently requires asterisk to be restarted"
После изменения стратегии в это значение потребуется перегрузка asterisk.
Можно в консоли выполнить команду:
asterisk -rx'core restart now'
это действие завершит все активные телефонные звонки и сбросит счетчики очередей.
Расширенные настройки
В этом разделе можно дополнительно указать:
Номер телефона для этой очереди - по этому номеру можно позвонить на очередь с любого внутреннего номера сотрудника. Также на этот номер можно перевести вызов.
Краткое название очереди - для отображения перед CallerID абонента на телефонном аппарате, например consult.
Настройки очереди для операторов
Время попытки дозвона агенту - время в секундах, в течение которого вызов будет идти на одного агента очереди. По завершении этого времени вызов агенту сохраняется в историю звонков как пропущенный. По завершении времени попытки дозвона до одного агента вызов направится на следующего агента согласно выбранной стратегии.
Время отдыха агента после обработки вызова, перед тем как начать принимать новые звонки - время в секундах, которое отсчитывается с момента завершения разговора агентом очереди до момента поступления нового телефонного звонка агенту.
Получать новые звонки во время разговора
Настройки очереди для вызывающего абонента
Что абонент слышит во время ожидания - во время ожидания ответа на свой звонок клиент может слышать музыку на удержании или сигнал вызова.
Фоновая музыка (MOH) - можно указать уникальный звуковой файл для воспроизведения клиенту во время ожидания, к примеру рекламные материалы.
Оповещать о текущей позиции в очереди - если все операторы (агенты очереди) заняты, то включив этот переключатель, можно оповестить клиента о его позиции в очереди. Если активирована опция Дополнительный звуковой анонс, то этот анонс дополнит информацию о позиции.
Маршрутизация звонков при сбоях
Сценарий 1 - в данном сценарии можно настроить максимально допустимое время ожидания клиента в очереди. Если в течение заданного времени никто из агентов очереди не смог ответить клиенту, то можно задать номер, на который будет в дальнейшем перенаправлен вызов.
Сценарий 2 - если в очереди нет агентов (то есть в данный момент ни один агент не зарегистрирован на АТС), то можно указать номер, на который будет переведен вызов клиента.
В данных сценариях в качестве номера переадресации можно выбрать не только внутренний номер, а также конференцию, очередь, IVR, приложение диалплана служебный номер.
Длительность вызова на очередь по умолчанию равна 300 секундам. Если необходим больший интервал, то задайте в Сценарий 1, большую длительность и укажите резервный номер.
Приложения диалпланов
Создание и настройка приложений диалплана
Приложения диалпланов - это программируемые голосовые приложения на PHP и Asterisk Dialplan.
MikoPBX поставляется с несколькими предварительно сконфигурированными приложениями. С некоторыми базовыми знаниями планов набора Asterisk можно легко создавать дополнительные приложения. Как и учетная запись телефона, приложения могут иметь внутренний номер, присвоенный в настройках.
Ниже вы увидите описание базовых приложений, включенных в MikoPBX:
Номер приложения
Описание приложения
Сотрудники
Настройка сотрудников и основных телефонных номеров
Сотрудники в MikoPBX - это индивидуальные пользователи системы, которым назначены внутренние номера для совершения и приема звонков. Они имеют персональные учетные записи, позволяющие настроить права доступа, переадресацию вызовов и другие персональные настройки в системе.
Список сотрудников
В разделе Сотрудники представлен список внутренних учетных записей сотрудников. Слева от сотрудника отображается статус авторизованного устройства. Если устройство успешно авторизовано под данной внутренней учетной записью, то кружок отображается зеленым цветом, иначе серым.
Регистрация в маркетплейсе модулей
Описание процесса регистрации
Общая информация
Регистрация в Маркетплейсе MikoPBX не влияет на базовый функционал системы. Вы можете использовать MikoPBX для работы со звонками без регистрации и установки дополнительных модулей. Однако, Мы рекомендуем пройти процедуру регистрации в маркетплейсе для получения возможности расширения функционала системы.
Регистрация даст вам доступ к дополнительным модулям и расширениям.
Есть бесплатные модули, который мы вынесли из базового функционала для упрощения первоначальной настройки, а также платные модули от нас и других разработчиков.
Если вы разработчик, то можете связаться с нами, написав на почту [email protected] для получения инструкций о том, как разработать собственный модуль и добавить его в Marketplace.
— последний вызов:
09:50
← самый старый
103
— всего вызов:
3
- переключатель включает / отключает возможность принятия новых звонков во время текущего разговора.
Оповещать о расчетном времени ожидания - если все операторы (агенты очереди) заняты, то включив этот переключатель, можно оповестить клиента о примерном времени ожидания ответа на вызов. Если активирована опция Дополнительный звуковой анонс, то этот анонс дополнит информацию о расчетном времени.
Дополнительный звуковой анонс - звуковое сообщение проигрывается только если все участники очереди заняты.
Время в секундах для периодического повтора всех оповещений - описывает c каким интервалом произносить оповещение о позиции в очереди, времени ожидания и анонс.
[REG-AUTH-***]
type = auth
; ----
[REG-***]
type = registration
transport = transport-udp
; ----
[***-OUT]
type = auth
; ----
[***]
type = aor
max_contacts = 1
; ----
[***]
type = identify
; ----
[***]
type = endpoint
context = incoming
; ----
[registration-auth]
; описываем параметры авторизации для [REG-AUTH-***]
[registration]
; описываем параметры регистрации на удаленном сервере [REG-***]
[endpoint-auth]
; описываем параметры авторизации для исходящих звонков через провайдера
[identify]
; Секция отвечает за сопоставление регистрации и endpoint. При поступлении входящего звонка
; согласно INVITE будет проведена проверка соответствия identify параметров с endpoint.
[aor]
; Правка секции AOR для endpoint
[endpoint]
; Правка параметров endpoint
Приложение считывает внутренний номер сотрудника, используемое для вызова приложения, и озвучивает его сотруднику, т.е. сотруднику озвучивается его внутренний номер на АТС
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)
Нажмите Сохранить для завершения настройки.
Встроенные приложения диалпланов
000063
В строке поиска можно найти необходимый контакт. Поиск можно осуществлять по имени сотрудника, внутреннему номеру, мобильному номеру, адресу электронной почты.
Поиск сотрудника по электронной почте
На форме также есть возможность сортировки списка сотрудников по имени, внутреннему номеру, мобильному номеру, адресу электронной почты. Имеются кнопки копирования пароля для SIP учетной записи в буфер обмена, редактирования учетной записи и её удаления.
Сортировка сотрудников и функции в главном меню
Добавление сотрудника
Существует два способа добавления сотрудников:
1) Поштучное добавление с вводом данных в Web-интерфейсе.
2) Импорт нескольких сотрудников из CSV файла.
Поштучное добавление сотрудников
Для добавления нового сотрудника необходимо нажать кнопку Добавить сотрудника.
Элемент "Добавить нового сотрудника"
Импорт и экспорт сотрудников из CSV файла
Существует возможность экспорта и импорта сотрудников для удобства настройки. Для этого, нажмите для стрелочку справа от кнопки "Добавить нового сотрудника".
Доступны 3 опции:
Импорт из CSV - загрузить сотрудников из CSV файла в MikoPBX.
Экспорт в CSV - загрузить сотрудников в CSV файл из MikoPBX (сотрудники не будут удалены со станции).
Скачать шаблон - загрузить шаблон CSV таблицы для заполнения и дальнейшего импорта в MikoPBX.
Возможности для группового импорта/экспорта сотрудников
Импорт
Нажмите на "Выбрать CSV файл" и выберите ранее оформленный файл с данными в таблице. Рекомендуется использовать шаблоны из вкладки "Шаблон".
Раздел "Импорт"
После выбора файла, будет отображена информация по всем обнаруженным пользователям в таблице. Выберите стратегию обработки дубликатов и нажмите "Подтвердить импорт" для начала процесса.
Параметры импорта сотрудников
После окончания процесса, Вы увидите статус создания сотрудников, а так же уведомление об окончании импорта.
Нажмите "Назад к списку" для возвращения к списку сотрудников.
Успешный импорт сотрудников
Экспорт
Существует возможность экспорта CSV файла со всеми данными текущих сотрудников. Есть несколько форматов экспорта:
Минимальный:
number - Внутренний номер (обязательное)
user_username - ФИО сотрудника (обязательное)
user_email - Email адрес
mobile_number - Мобильный номер
sip_secret - Пароль SIP (если не указать будет сгенерирован)
fwd_ringlength - Время звонка (секунды) до переадресации
fwd_forwarding - Номер переадресации если не ответил
Стандартный:
Все параметры из Минимального.
mobile_dialstring - Номер для набора мобильного
sip_dtmfmode - DTMF режим (auto/rfc4733/info/inband)
sip_transport - Транспорт (udp/tcp/tls) по-умолчаню udp,tcp
sip_enableRecording - Запись разговоров (true/false)
fwd_forwardingonbusy - Номер переадресации если занят
fwd_forwardingonunavailable - Номер переадресации если недоступен
Полный:
Все параметры из Минимального и Стандартного.
user_avatar - URL фотографии
sip_manualattributes - Дополнительные SIP параметры
Так же Вы можете указать диапазон внутренних номеров сотрудников, которых необходимо экспортировать (раздел "Фильтр по диапазону номеров").
Нажмите "Экспортировать сотрудников". Файл будет загружен на Ваше устройство.
Раздел "Экспорт"
Шаблон
На этой вкладке, Вы можете скачать шаблон пустого файла с указаными "столбцами" для заполнения и дальнейшего импорта в MikoPBX.
На вкладке Основные параметры задаются общие настройки внутренней учетной записи сотрудника:
ФИО пользователя - допускается использование кириллицы. Это значение будет использоваться при подстановке CALLERID(name) абонента, будет отображаться в соответствующем поле экрана телефона.
Внутренний номер - он же используется в качестве Логин при подключении телефона.
Мобильный номер - используется для дополнительной маршрутизации.
Адрес электронной почты - используется для email оповещений.
Пароль для SIP
Установите сложные пароли на учетные записи (пароль для SIP)! Пароль должен удовлетворять следующим требованиям:
длина пароля должна быть длиннее восьми символов;
пароль должен содержать буквы ВЕРХНЕГО и нижнего регистра;
пароль должен содержать цифры и специальные знаки: «-», «_», «[]», «{}», «@», «;».
Расширенные параметры учетной записи
Открываются путем нажатия на раскрывающийся список Расширенные настройки.
Вкладка расширенных настроек учетной записи
Переопределение строки набора
В поле Переопределение строки набора введите правило набора мобильного номера для Вашего провайдера.
Например, в основных настройках номер мобильного телефона указан в формате 89164577878, согласно правилам исходящей маршрутизации для провайдера звонок возможен только на номера, начинающиеся с 7.Следовательно в поле Переопределение строки набора следует указать номер 79164577878.
Максимальное количество параллельных звонков
Количество вызовов, при котором номер считается «занятым». В таком статусе начинают работать правила маршрутизации. Это описание не распространяется на очередь вызовов.
Режим DTMF
Настройка определяет, как DTMF-сигналы передаются через SIP.
Транспортный протокол
Позволяет указать используемый транспортный протокол для данной учетной записи.
Сетевой фильтр
Подсеть, которая описана в разделе Cетевой экран. Указывает на разрешенную подсеть для этой учетной записи. Подключение из прочих подсетей будет вызывать ошибку авторизации.
Дополнительные параметры SIP учетки
Данное поле служит для изменения/переопределения конфигурационных файлов asterisk.
Переопределять можно практически все параметры. К примеру при использовании chan_pjsip SIP аккаунт сотрудника описывается следующими секциями:
Для переопределения полей в секциях следует заполнить поле Дополнительные параметры следующим образом:
Настройки маршрутизации
Раздел "Настройки маршрутизации"
На данной вкладке вы можете настроить правила переадресации вызовов в случае, если сотрудник не может ответить на звонок, занят или недоступен.
Период времени в секундах определяет, сколько времени будет продолжаться попытка вызова на внутреннюю учетную запись сотрудника. Если в течение этого времени сотрудник не сможет ответить на вызов, вы можете указать на какой номер следует направить вызов дальше. По умолчанию, вызов будет переадресован на мобильный номер сотрудника.
Кроме того, вы можете указать номера, на которые следует направить вызов в случае занятости и недоступности сотрудника. Таким образом, если сотрудник занят или недоступен, вызов будет переадресован на указанные номера.
Вы можете настроить эти параметры в соответствии с вашими предпочтениями и требованиями.
Сама MikoPBX - бесплатное решение и не требует никакой регистрации. Отсутствие лицензии никак не влияет на звонки. Вы в любой момент можете зарегистрироваться, а также отменить регистрацию в Marketplace.
Для начала регистрации в маркетплейсе вам необходимо перейти во вкладку "Модули" -> "Маркетплейс модулей":
Раздел "Модули" -> "Маркетплейс модулей"
В случае, если у Вас не выполнена регистрация в Маркетплейсе, раздел будет выглядеть вот так:
Раздел Маркетплейса, в случае, если не выполнена регистрация
Процесс регистрации
В случае переноса MikoPBX на другой хост или восстановлении из бекапа, необходимо выполнить сброс привязок лицензий на модули в личном кабинете lm.mikopbx.com
При регистрации выдается 1 ключ на компанию. Это значит, что если Вы используйте несколько станций MikoPBX в своей компании - вам достаточно будет одной регистрации.
Нажмите синюю кнопку "Регистрация в маркетплейсе" для начала регистрации:
Кнопка "Регистрация в маркетплейсе" в разделе "Модули" -> "Маркетплейс"
Лицензионный ключ используется для хранения всех ваших лицензий от любых продуктов МИКО. Если у вас уже есть ключ, вы можете просто вписать его в одноименное поле. Если ключ у вас был, но вы его забыли, вы можете поискать письмо в вашей электронной почте входящие письма по адресу [email protected]
Лицензионный ключ
Получить новый ключ можно автоматически, заполнив регистрационную форму ниже:
Название организации - введите имя вашей компании/организации.
Адрес электронной почты контактного лица - введите адрес электронной почты вышей компании/организации.
Контактное лицо - введите данные контактного лица.
Телефон контактного лица (необязательно).
Уникальный идентификатор компании (ИНН, ИИН, УНП и т.д.) (необязательно).
Нажмите "Зарегистрироваться"
Регистрационная форма для маркетплейса
В случае успешной регистрации, вы увидите следующий экран:
Уведомление об успешной регистрации системы.
Наведите курсор на поле с лицензионным ключом, если вам необходимо его увидеть или скопировать. По умолчанию значение ключа размыто.
Успешная регистрация в маркетплейсе
Управление лицензией
Для управления лицензией перейдите в раздел Маркетплейс -> Управление лицензией. Нажмите на одноименный элемент:
Для управления лицензией введите ваш лицензионный ключ в поле "Введите ваш лицензионный ключ или активированный ранее купон":
Нажмите "Login"
Введённый лицензионный ключ
Вы попадете в систему, где находятся 9 секций:
Система SaaS
Перейдите в раздел "Монитор сессий":
Раздел "Монитор сессий"
Слева для каждой привязки в колонке Информация есть кнопка i, которая позволяет посмотреть подробную информацию о хосте, к которому привязана лицензия.
Информация о хосте
Для каждой привязки в колонке "Действие" есть кнопка "Сброс", которая позволяет сбросить активную привязку лицензии от хоста.
Сброс лицензии на хосте.
Возможные проблемы
Проблема при регистрации в Маркетплейсе
При регистрации может возникать проблема отсутствии у MikoPBX связи с интернетом, а именно с отсутствием связи с серверами lic.miko.ru и lic.mikopbx.com по порту 443(https)
Решение: проверить доступ к станции из интернета, проверить настройки firewall и общего доступа к вышеупомянутым ресурсам.
Иконка перечеркнутого ключа
MikoPBX переодически обращается к серверам лицензирования для проверки установленных модулей. Если лицензия на модуль недоступна, то он будет отключен, а рядом с названием модуля появится соответствующая иконка в виде перечеркнутого ключа.
Установка с записью образа на USB-носитель (Live USB)
Установка системы с помощью записи образа на USB-носитель
Запись образа на USB-носитель
Windows
Перед началом процесса, отформатируйте Ваш носитель со следующими параметрами:
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
Принимает текстовую строку из канала, если он поддерживает эту возможность.
Проговаривает дату и время, согласно заданному формату. (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 кнопки
File system - FAT32
Allocation unit size - 8192 bytes
Форматирование диска
Для записи образа будет использована утилита Rufus. Скачать ее можно по ссылке.
Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!
Утилита Rufus
После установки утилиты, перейдите в ее интерфейс. В разделе "Device" выберите Ваш носитель, нажмите SELECT и выберите ранее загруженный .iso образ. Начнется его проверка.
Выбранный образ и носитель
После окончания проверки, установите следующие параметры и нажмите "START":
File system - FAT32
Cluster size - 8192 Bytes
Quick format - отмечено
Create extended label and icon files - убрать галочку
Начало записи образа
После этого, во всплывающем окне выберите "Write in DD Image mode". Нажмите "OK".
Параметр "Write in DD image mode"
Во всплывающем предупреждении, о том, что все данные на диске будут удалены, нажмите "ОК".
Подтверждение форматирования диска
Дождитесь окончания записи образа. По его завершении, Вы увидите надпись "READY". Далее перейдите к разделу "Установка системы".
Успешная запись образа на USB-носитель
MacOS
Подключите Ваш usb-носитель и откройте Terminal.
Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!
Выполните команду:
Будет отображена информация про все подключенные диски. Нас интересует диск с маркировкой (external, physical). В нашем случае это disk4, в Вашем случае номер может быть другим. Используйте его номер для выполнения дальнейших шагов в этой инструкции.
Список дисков
Далее необходимо отформатировать USB носитель. Для этого используйте команду:
Все данные на диске будут удалены! Еще раз проверьте название диска который Вы форматируете!
Для подтверждения введите пароль администратора, дождитесь окончания форматирования.
Форматирование USB-носителя
Отмонтируйте (отключите) диск, используя следующую команду:
Выполнение команды unmount
Запишите образ на USB-носитель, используя следующую команду:
Дождитесь окончания записи образа. Далее перейдите к разделу "Установка системы".
Запись образа на USB-носитель
Linux
В данной инструкции в качестве примера, запись образа будет произведена на Ubuntu 24.04.
Подключите Ваш usb-носитель и откройте Terminal.
Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!
Выполните команду:
Будет отображена информация про все подключенные диска. Найдите в этом списке Ваш usb-носитель и запомните его наименование. В нашем случае, это диск sdb.
Команда lsblk
Далее необходимо отформатировать usb-носитель, используя следующую команду:
Все данные на диске будут удалены! Еще раз проверьте название диска который Вы форматируете!
Для подтверждения введите пароль администратора, дождитесь окончания форматирования.
Форматирование диска
Отмонтируйте (отключите) диск, используя следующую команду:
Команда umount
Запишите образ на USB-носитель, используя следующую команду:
Дождитесь окончания записи образа. Далее перейдите к разделу "Установка системы".
Успешная запись образа на диск
Установка системы
Запуститесь с USB-носителя. При возникновении ошибок (черный экран) - убидитесь, что:
Secure Boot - Disabled
CSM (Compatibility Support Module) - Enabled
Загруженная система с USB-носителя
Система загружена в режиме LiveCD, об этом нам говорит красная надпись. Необходимо произвести установку. Для этого, передвигаясь стрелочками на клавиатуре, перейдите в раздел "[8] Install". Нажмите "Enter".
Раздел "[8] Install"
Выберите диск, который будет использоваться для установки системы. Для этого введите его ID (название), например sdc в нашем случае.
Выбор системного диска
Подтвердите Ваш выбор, введите "y" для продолжения.
Все данные с выбранного диска будут удалены!
Подтверждение выбора диска
После установки системы, Вам будет предложено выбрать диск для хранения записей разговоров. По аналогии с первым диском, сделайте выбор.
Выбор диска для хранения записей разговоров
После этого система перезагрузится и будет готова к работе и первой авторизации в Web-интерфейс.
Успешно установленная система
Для перехода в Web-интерфейс, введите IP-адрес Вашей MikoPBX в строку браузера. Используйте стандартные данные для авторизации.
Для работы с MikoPBX в контейнере необходимо установить docker и docker compose, а также создать пользователя и папки для хранения настроек конфигурации и записей разговоров по инструкции
Вот пример файла docker-compose.yml, который может быть использован для управления вашим контейнером MikoPBX через Docker Compose:
docker-compose.yml
services:
mikopbx:
container_name: "mikopbx"
image: "ghcr.io/mikopbx/mikopbx-x86-64"
network_mode: "host"
cap_add:
- NET_ADMIN
entrypoint: "/sbin/docker-entrypoint"
hostname: "mikopbx-in-a-docker"
volumes:
- /var/spool/mikopbx/cf:/cf
- /var/spool/mikopbx/storage:/storage
tty: true
environment:
- ID_WWW_USER=${ID_WWW_USER}
- ID_WWW_GROUP=${ID_WWW_GROUP}
# Изменение имени станции через переменные окружения
- PBX_NAME=MikoPBX-in-Docker
# Изменение стандартного порта SSH на 23
- SSH_PORT=23
# Изменение стандартного порта WEB на 8080
- WEB_PORT=8080
# Изменение стандартного порта WEB HTTPS на 8443
- WEB_HTTPS_PORT=8443
Сохраните содержимое в файл docker-compose.yml, выполните необходимые корректировки и запускайте MikoPBX коммандой:
Запуск нескольких MikoPBX на одном хосте
Режим без изоляции сети хоста от контейнеров (–net=host)
Также можно оганизовать запуск нескольких контенеров MikoPBX на одном хосте, но здесь надо учитывать особенности работы Docker с портами, если не использовать режим –net=host то это приведет к высокой нагрузке на процессор хостовой системы, т.к. Docker создает для каждого выделенного порта отдельное правило в Iptables.
С включенным режимом –net=host вам необходимо вручную следить за распределением доступных портов между запускаемыми контейнерами и встроенными приложениями.
Например, для запуска двух контейнеров с MikoPBX на одном хосте, можно использовать следующий конфигурационный файл:
Сохраните содержимое в файл docker-compose.yml, выполните необходимые корректировки и запускайте MikoPBX коммандой:
Режим сетевого моста (–net=bridge)
Существует вариант запуска контейнеров с MikoPBX в режиме –net=bridge, но как описано выше для использования этого режима необходимо или существенно ограничить диапазон RTP портов, или открывать к ним доступ на хостовой машине не используя возможности Docker.
Для этого вам необходимо написать небольшой скрипт, для определения имени текущего мостового интерфейса и IP адреса каждого контейнера, и после запуска docker compose добавить необходимые правила iptables для диапазона RTP портов следующим образом:
Опишем несколько контейнеров в файле docker-compose.yaml, определим разные порты для веб интерфейса, SIP портов и диапазоны RTP портов, чтобы они не пересекались.
Создаем папку для скриптов
Сохраняем файлы start-multiple-mikopbx.sh и docker-compose.yaml в эту папку.
Устанавливаем необходимые зависимости для работы скрипта.
Переходим в нашу папку, добавляем права на выполнение и запускаем наш скрипт.
Пока ожидаем запуск контейнеров, проверяем настройки брендмауера на хосте, при необходимости открваем те порты, которые указаны в нашем docker-compose.yaml файле, а именно:
TCP/UDP порты 5060 и 6060 для SIP
UDP диапазоны 10000-10800 и 20000-20800 для передачи звука по RTP
TCP порты 8443 и 9443 для HTTPS протокола, для работы Web интерфейса.
Входим по очереди на каждую из станций по адресам:
https://<IP хостовой машины>:8443
https://<IP хостовой машины>:9443
Для входа в веб-интерфейс первой АТС MikoPBX используйте логин admin и пароль mikopbx-first-password
Для входа в веб-интерфейс второй АТС MikoPBX используйте логин admin и пароль mikopbx-second-password
В каждой машине должен быть включен режим NAT, указывая что контейнер находится за маршрутизатором в настройках сетевого интерфейса. Если станции будут использоваться внутри локальной сети, то в поле внешнего IP прописваем локальный IP адрес хостовой машины, в противном случе ее публичный IP адрес.
Важное замечание!
Один из наших контейнеров использует проброс с SIP порта с изменением его значения 5060 -> 6060.
В данном случае, для корректной работы системы, необходимо добавить внешнее значение SIP порта в настройках NAT в разделе сетевых интерфейсов MikoPBX.
Эту настройку также можно сделать задав соответвующее значение переменной окружения EXTERNAL_SIP_PORT=6060 в файле docker-compose.
На этом настройка завершена, можно настраивать учетные записи и выполнять звонки.
Переменные окружения для конфигурирования MikoPBX
Ниже перечислены некоторые переменные окружения, которые позволят скорректировать используемые MikoPBX порты и настройки.
SSH_PORT - порт для SSH (22)
WEB_PORT - порт для работы web интерфейса по протоколу HTTP (80)
WEB_HTTPS_PORT - порт для работы web интерфейса по протоколу HTTPS (443)
Полный список всех возможных параметров настроек доступен в исходном коде .
Общие настройки
Описание настроек основных параметров системы
В этом разделе настраиваются основные параметры системы. Рекомендуется выполнить эти настройки сразу после установки АТС.
Раздел "Система" -> "Общие настройки" в веб-интерфейсе MikoPBX
Основные
Название PBX системы — отображается на главной странице MikoPBX.
Дополнительное описание — видно только администраторам системы.
Язык звуковых сообщений системы — язык голосовых оповещений.
Максимальная длина внутренних номеров — максимальная длина внутреннего номера сотрудника.
Разрешить входящие звонки с любых серверов - разрешает принимать SIP звонки от неавторизованных устройств и серверов без регистрации.
Включение этой опции может создать угрозу безопасности. Убедитесь, что ваша сеть надежно защищена и используются правила фильтрации!
Перезапуск PBX каждую ночь — автоматический рестарт Asterisk в ночное время (в 01:00 ночи по системному времени).
Отправлять разработчикам информацию о сбоях — при возникновении ошибки её описание отправляется разработчикам (требуется доступ в интернет).
Нажмите "Сохранить".
Запись разговоров
Запись разговоров — включить или отключить запись всех разговоров.
Запись внутренних разговоров — включить или отключить запись звонков между сотрудниками.
Ниже можно выбрать звуковые файлы, которые будут использоваться в качестве предупреждения о записи разговора (для входящих и исходящих звонков могут быть выбраны разные звуковые файлы).
Телефонные звонки сохраняются в формате WebM с кодеком Opus. Размер файла зависит от качества звонка: если хотя бы один из участников разговора использует качественный кодек (например, G.722 или Opus), запись сохраняется с повышенным битрейтом — это занимает больше места на диске, но улучшает качество распознавания речи.
Ориентировочно 1 час разговора занимает 14–28 МБ места на диске в зависимости от качества записи.
Переводы вызовов
Парковка (удержание)
Парковка — способ временно поставить клиента на удержание, пока вы уточняете информацию. Во время ожидания клиенту воспроизводится мелодия.
В MikoPBX доступны два способа парковки:
Введите *2 во время разговора — вызов будет поставлен на удержание, а вам сообщат номер парковочного слота. Любой сотрудник может забрать вызов, набрав этот номер.
В настройках задайте номер для парковки — при переадресации вызова на этот номер MikoPBX поставит звонок на удержание и сообщит номер слота. Вызов также может забрать любой сотрудник.
Диапазон парковочных слотов и номер для парковки настраиваются в этом же разделе:
Номер для парковки вызова — номер, на который нужно перевести вызов для постановки на удержание, по умолчанию 800.
Диапазон слотов для парковки — диапазон номеров парковочных слотов, по умолчанию 801–820.
Переводы вызовов
MikoPBX поддерживает два вида переводов:
Консультативный (условный) перевод — вы можете предварительно поговорить с коллегой, прежде чем переключить на него вызов. Клиент в это время находится на удержании. Перевод завершается после того, как вы кладёте трубку.
Безусловный (слепой) перевод — вызов переводится сразу, без предварительного разговора с коллегой. Удобно, когда поступает второй звонок, а вы уже заняты — вызов можно мгновенно перевести на свободного сотрудника.
Комбинации клавиш для переводов можно изменить в этом же разделе:
Комбинация для консультативного перевода — по умолчанию ##.
Комбинация для безусловного перевода — по умолчанию **.
Комбинации вводятся с телефона во время активного разговора, после чего набирается внутренний номер сотрудника, на которого выполняется перевод.
Таймауты
Время возврата вызова — если после консультативного перевода никто не ответил, вызов вернётся обратно. Задаётся в секундах, по умолчанию 45 сек.
Максимальный таймаут между цифрами при вводе добавочного номера — время ожидания следующей цифры при наборе номера. Задаётся в миллисекундах, по умолчанию 2500 мс.
Перехват вызова (Pickup)
Если звонит телефон коллеги, вы можете перехватить вызов, не вставая с места:
*8 — перехватить любой входящий вызов, если номер коллеги неизвестен.
Комбинацию для перехвата можно изменить в поле «Комбинация для перехвата входящих вызовов», по умолчанию *8.
SIP
Session Initiation Protocol (SIP) — сигнальный протокол, используемый большинством VoIP-телефонов. Вы можете изменить SIP-порт (по умолчанию 5060) для повышения безопасности.
Настройки портов для SIP сигнализации и диапазона RTP
RTP (Real-time Transport Protocol) определяет стандартный формат передачи аудио и видео по IP-сетям. По умолчанию используется диапазон портов 10000–10800. Для некоторых маршрутизаторов и брандмауэров может потребоваться дополнительная настройка диапазона. Ещё одна причина для его расширения — большое количество параллельных звонков: каждый активный вызов использует два RTP-порта, то есть при 200 портах возможно не более 100 одновременных звонков. Если нагрузка выше — расширьте диапазон.
Порт SIP — порт для регистрации телефонов на станции, по умолчанию 5060. Изменение порта может повысить безопасность системы.
Порт SIP TLS — порт для шифрованных звонков, по умолчанию 5061.
Диапазон RTP портов — диапазон портов для передачи аудио, по умолчанию 10000–10800.
Дополнительные параметры
Адрес STUN сервера — помогает при работе АТС за NAT, в том числе при использовании WebRTC.
Префикс Auth Username — по умолчанию имя пользователя (username) для авторизации на SIP-аккаунте соответствует внутреннему номеру сотрудника (пример — 101). При заполнении этой настройки к имени авторизации будет добавляться указанный префикс: username останется 101, а AuthUsername станет 101MIKO. Такой подход значительно усложняет подбор пароля для SIP-аккаунта.
Настройки продолжительности действия регистрации
Некоторые брандмауэры закрывают порты после периода неактивности — в таких случаях стоит уменьшить таймаут регистрации. Также разные SIP-провайдеры могут требовать различные значения тайм-аутов.
Стандартное время Keep-alive — интервал отправки keep-alive пакетов в секундах, по умолчанию 120 секунд.
Минимальное время регистрации (SIPMiniExpiry) — по умолчанию 60 секунд.
Максимальное время регистрации (SIPMaxExpiry) — по умолчанию 3600 секунд.
Аудио/видео кодеки
В этом разделе настраиваются разрешённые аудио и видео кодеки для всей АТС.
AMI&ARI
Asterisk Manager Interface (AMI) — мощный и удобный программный интерфейс (API) Asterisk для управления системой из внешних программ. Благодаря AMI внешние программы могут осуществлять соединения с Asterisk посредством TCP-протокола, инициировать выполнение команд, считывать результат их выполнения, а также получать уведомления о происходящих событиях в реальном времени. AMI часто используют для интеграции с бизнес-процессами и системами, программным обеспечением CRM (Customer Relationship Management — управление взаимоотношениями с клиентами).
Asynchronous Javascript Asterisk Manager (AJAM) — технология, которая позволяет веб-браузерам или другим приложениям с поддержкой HTTP напрямую обращаться к интерфейсу Asterisk Manager (AMI) через HTTP/HTTPS.
Asterisk REST Interface (ARI) — RESTful API с поддержкой WebSocket, который даёт полный контроль над каналами, мостами и медиапотоками Asterisk в реальном времени. Предназначен для разработки собственных телефонных приложений.
Настройки AMI
Использовать AMI интерфейс — включить или отключить AMI.
Порт AMI — порт для подключения внешних программ к AMI, по умолчанию 5038. Клиентская программа подключается к AMI через этот порт и аутентифицируется, после чего Asterisk отвечает на запросы и отправляет извещения об изменениях состояния заданных подсистем.
Настройки HTTP сервера
HTTP порт (AJAM и ARI) — порт для подключения по HTTP, по умолчанию 8088.
HTTPS порт (AJAM и ARI) — порт для подключения по HTTPS, по умолчанию 8089.
Настройки AJAM
Использовать AJAM интерфейс — включить или отключить AJAM.
Настройки ARI
Использовать ARI интерфейс — включить или отключить ARI. По умолчанию отключён.
Разрешённые источники CORS — домены, с которых разрешены запросы к ARI. CORS — механизм безопасности браузера, ограничивающий кросс-доменные запросы к API.
Никогда не используйте * в продакшне. Указывайте только доверенные домены по HTTPS.
SSH
SSH (Secure Shell) — зашифрованный протокол, который часто используется для взаимодействия и удалённого управления серверами. SSH-сервер может выполнять аутентификацию пользователей с помощью различных алгоритмов. Самый популярный — аутентификация по паролю. Он достаточно прост, но не очень безопасен: пароли передаются по безопасному каналу, однако недостаточно сложны для противостояния попыткам перебора. Вычислительная мощность современных систем в сочетании со специальными скриптами делает перебор очень простым.
Существует более безопасный способ аутентификации — SSH-ключи. Каждая пара состоит из открытого и закрытого ключа: закрытый хранится у клиента, открытый загружается на сервер в файл ~/.ssh/authorized_keys. При подключении сервер отправляет сообщение, зашифрованное открытым ключом — если клиент расшифровывает его закрытым и возвращает правильный ответ, аутентификация считается пройденной.
В MikoPBX аутентификация по паролю по умолчанию отключена — для подключения необходимо использовать SSH-ключи. Добавить его необходимо в данном разделе или при создании виртуальной машины в облаке (он автоматически будет подставлен при установке MikoPBX).
Подробнее про подключение по SSH к MikoPBX Вы можете узнать .
Параметры раздела
SSH порт — порт для подключения по SSH, по умолчанию 22.
Логин для SSH консоли — имя пользователя для подключения.
Отключить авторизацию по паролю — по умолчанию включено в MikoPBX (авторизация по паролю отключена).
HTTP/HTTPS
Для повышения безопасности можно изменить HTTP-порт (по умолчанию 80) или активировать режим HTTPS. HTTPS шифрует трафик между браузером и АТС с помощью протоколов SSL/TLS. По умолчанию используется TCP-порт 443.
HTTP порт — порт для доступа к веб-интерфейсу по HTTP, по умолчанию 80.
HTTPS порт — порт для доступа к веб-интерфейсу по HTTPS, по умолчанию 443.
Редирект на HTTPS — при открытии веб-интерфейса по HTTP пользователь будет автоматически перенаправлен на HTTPS.
Публичный ключ HTTPS (SSL/TLS сертификат)
SSL/TLS сертификат — цифровой документ, подтверждающий подлинность сервера и обеспечивающий шифрование данных между браузером и АТС. В MikoPBX сертификат используется для:
HTTPS доступа к веб-интерфейсу
WebRTC соединений (обязательно для браузерных звонков)
Безопасных AJAM и ARI подключений через HTTPS
Защищённого REST API для интеграций
Сертификат должен быть в формате PEM — начинается с -----BEGIN CERTIFICATE----- и заканчивается -----END CERTIFICATE-----. Если у вас есть промежуточные сертификаты (intermediate), добавьте их после основного в том же поле.
Покупка у центра сертификации (DigiCert, Comodo, GlobalSign и др.)
Самоподписанный сертификат — генерируется автоматически при первом запуске АТС, но вызывает предупреждения в браузерах.
Рекомендуем использовать модуль Let's Encrypt для автоматического управления сертификатами. Подробнее .
Приватный ключ HTTPS
Секретный ключ для расшифровки SSL/TLS соединений. Должен точно соответствовать публичному сертификату — при несоответствии HTTPS работать не будет.
Ключ должен быть в формате PEM — начинается с -----BEGIN RSA PRIVATE KEY----- или -----BEGIN PRIVATE KEY-----.
Никогда не передавайте приватный ключ третьим лицам. Компрометация ключа позволит злоумышленнику перехватывать зашифрованный трафик. При компрометации - немедленно замените пару ключей.
Рекомендации по безопасности:
Храните резервную копию ключа в защищённом месте.
Используйте ключи длиной минимум 2048 бит (рекомендуется 4096).
Регулярно обновляйте сертификаты и ключи.
Пароль WEB интерфейса
В этом разделе можно изменить логин и пароль для входа в веб-интерфейс, а также настроить вход с помощью Passkeys.
Авторизация в MikoPBX по умолчанию:
Логин: admin
Пароль: admin — рекомендуется сразу изменить.
Логин — имя пользователя для входа в веб-интерфейс.
Пароль — пароль для входа в веб-интерфейс.
Passkeys (биометрическая аутентификация)
Passkeys — современный способ входа без пароля с использованием биометрии или аппаратного ключа безопасности: Face ID, Touch ID, Windows Hello или YubiKey. Это быстрее и безопаснее традиционных паролей.
Чтобы добавить Passkey, нажмите кнопку «+ Добавить Passkey» и следуйте инструкциям браузера.
Подробнее Вы можете прочитать .
Удаление настроек системы
Этот раздел позволяет полностью сбросить систему до заводского состояния. При удалении будут безвозвратно удалены все настройки, история вызовов, файлы записей разговоров и установленные модули расширений.
Это действие необратимо. Перед очисткой системы убедитесь, что у вас есть резервная копия всех важных данных.
Для подтверждения введите в поле ввода фразу удалить всё и нажмите «Сохранить».
Доступ к ARI
Короткое описание ARI (Asterisk REST Interface)
ARI — это RESTful API с поддержкой WebSocket, который даёт полный контроль над каналами, мостами и медиапотоками Asterisk в реальном времени. В отличие от , ARI работает напрямую с ядром Asterisk и предназначен для разработки собственных телефонных приложений.
По умолчанию отключён — включите при необходимости в разделе «Система» → «Общие настройки» → «AMI&ARI».
Подробная документация по ARI доступна на официальном сайте Asterisk:
Использовать WebRTC — будут произведены дополнительные настройки для работы с WebRTC-соединением. Например, для внутреннего номера 201 будет создан дополнительный endpoint, подключиться к которому можно по протоколу WebRTC с использованием URL sip:201-WS@IP_PBX.
SSH пароль — пароль для входа (доступен только если авторизация по паролю не отключена).
Авторизованные SSH ключи — добавьте сюда публичный SSH-ключ с помощью кнопки «+ Добавить ключ». Если ключей несколько - добавьте каждый отдельно.
Публичный SSH ключ системы — публичный SSH-ключ текущей АТС. Его можно скопировать в поле «Авторизованные SSH ключи» на другой станции — это позволит подключаться к удалённому серверу без дополнительной авторизации.
REST API — управление объектами Asterisk: каналами, мостами, записями
WebSocket (/asterisk/ari/events) — получение асинхронных событий в реальном времени: входящий звонок, завершение звонка, нажатие DTMF и т.д.
Stasis — приложение диалплана, которое передаёт канал под управление вашего ARI приложения
Типичный сценарий: звонок попадает в диалплан → Stasis() передаёт канал вашему приложению → приложение управляет звонком через REST API и получает события через WebSocket.
Настройка ARI пользователя
Перед началом, необходимо включить ARI интерфейс (по умолчанию он выключен). Для этого перейдите в раздел "Система" -> "Общие настройки".
Раздел "Система" -> "Общие настройки" в MikoPBX
Далее во вкладку "AMI&ARI", переключите тумблер "Использовать ARI интерфейс". В поле «Разрешённые источники CORS» укажите домены, с которых будут выполняться запросы к ARI. CORS — механизм безопасности браузера, который ограничивает кросс-доменные запросы к API.
Значение
Когда использовать
(пусто)
Доступ только с того же домена
http://localhost:3000
Локальная разработка
https://app.mycompany.com
Продакшн приложение
*
Никогда не используйте * в продакшне. Указывайте только доверенные домены по HTTPS.
Подключение ARI
Перейдите в раздел «Система» → «Доступ к ARI».
Раздел "Система" -> "Доступ к ARI" в MikoPBX
Нажмите «Добавить пользователя».
Кнопка "Добавить пользователя" в разделе "Доступ к ARI"
Заполните следующие параметры:
Имя пользователя - логин для подключения, например ari_user.
Пароль - пароль для подключения.
Описание - описание для текущего пользователя, например "WebRTC Demo".
Приложения - укажите имена Stasis приложений, к которым имеет доступ пользователь. Оставьте поле пустым для доступа ко всем приложениям.
Распространенные приложения
ari-app: Основное приложение для ARI
stasis: Базовое Stasis приложение
external-media: Работа с внешними медиа-потоками
bridge-app: Управление мостами вызовов
channel-spy:Прослушивание каналов
Сохраните настройки.
Параметры создаваемого ARI-пользователя
Параметры подключения
WebSocket
Тип
URL
Обычный
ws://your-mikopbx.com:8088/asterisk/ari/events
Защищённый (TLS)
wss://your-mikopbx.com:8089/asterisk/ari/events
Замените [application] на имя вашего Stasis приложения.
REST API
Тип
URL
HTTP
http://your-mikopbx.com:8088/asterisk/ari
HTTPS
https://your-mikopbx.com:8089/asterisk/ari/
Аутентификация: HTTP Basic Auth — логин и пароль ARI пользователя.
Рекомендуется использовать защищённые подключения (wss:// и https://) с валидным SSL сертификатом. Обычные ws:// и http:// допустимы только в изолированной тестовой среде.
Пример: Hello World
Это минимальный пример работы с ARI — канал входит в Stasis приложение, приложение воспроизводит звуковой файл и завершает звонок.
В MikoPBX перейдите в «Маршрутизация» → «Приложения диалплана», создайте приложение с типом «Диалплан Asterisk» и кодом:
Назначьте приложение на нужный входящий маршрут.
Шаг 3 — позвоните на номер
При входящем звонке WebSocket получит событие StasisStart:
Шаг 4 — воспроизведите звук через REST API
Откройте новое окно терминала и выполните следующую команду:
Используйте id канала из события StasisStart!
При успешном проигрывании Вы увидите следующий вывод в терминал:
Шаг 5 — завершите звонок
После завершения звонка WebSocket пришлёт StasisEnd:
Пример: монитор присутствия
Живая таблица статусов сотрудников в терминале — не требует настройки
входящих маршрутов и Stasis приложений. Работает через подписку на все
события станции.
Установите зависимости:
При совершении вызовов, информация в таблице будет обновляться:
import asyncio
import websockets
import json
import os
from datetime import datetime
ARI_HOST = 'your-mikopbx.com'
ARI_USER = 'ari_user'
ARI_PASS = 'your-ari-password'
peers = {}
STATES = {
'NOT_INUSE': ('🟢', 'Свободен'),
'BUSY': ('🔴', 'Занят'),
'UNAVAILABLE': ('⚫', 'Недоступен'),
}
def draw():
print('\033[2J\033[H', end='')
now = datetime.now().strftime('%H:%M:%S')
print(f'MikoPBX — монитор присутствия [{now}]')
print('─' * 50)
print(f' {"Номер":<10} {"Имя":<20} {"Статус":<15} {"Обновлён"}')
print('─' * 50)
for number, info in sorted(peers.items()):
icon, label = STATES.get(info['state'], ('❓', info['state']))
print(f' {number:<10} {info["name"]:<20} {icon} {label:<12} {info["updated"]}')
print('─' * 50)
print(f' Сотрудников: {len(peers)}')
async def run():
uri = (
f"wss://{ARI_USER}:{ARI_PASS}@{ARI_HOST}:8089/asterisk/ari/events"
f"?app=auto-receptionist&subscribeAll=true"
)
async with websockets.connect(uri) as ws:
draw()
async for message in ws:
event = json.loads(message)
etype = event.get('type')
if etype == 'DeviceStateChanged':
ds = event.get('device_state', {})
name = ds.get('name', '')
state = ds.get('state', '')
if not name.startswith('PJSIP/'):
continue
number = name.replace('PJSIP/', '')
if number not in peers:
peers[number] = {'name': number, 'state': state, 'updated': '—'}
peers[number]['state'] = state
peers[number]['updated'] = datetime.now().strftime('%H:%M:%S')
draw()
elif etype == 'PeerStatusChange':
ep = event.get('endpoint', {})
number = ep.get('resource', '')
state = ep.get('state', '')
if not number:
continue
if number not in peers:
peers[number] = {'name': number, 'state': 'unknown', 'updated': '—'}
if state == 'online':
peers[number]['state'] = 'NOT_INUSE'
elif state == 'offline':
peers[number]['state'] = 'UNAVAILABLE'
peers[number]['updated'] = datetime.now().strftime('%H:%M:%S')
draw()
elif etype == 'ContactStatusChange':
ep = event.get('endpoint', {})
number = ep.get('resource', '')
ci = event.get('contact_info', {})
status = ci.get('contact_status', '')
if not number:
continue
if number not in peers:
peers[number] = {'name': number, 'state': 'unknown', 'updated': '—'}
if status == 'Reachable':
peers[number]['state'] = 'NOT_INUSE'
elif status in ('Unreachable', 'NonQualified'):
peers[number]['state'] = 'UNAVAILABLE'
peers[number]['updated'] = datetime.now().strftime('%H:%M:%S')
draw()
asyncio.run(run())
MikoPBX — монитор присутствия [11:34:43]
──────────────────────────────────────────────────
Номер Имя Статус Обновлён
──────────────────────────────────────────────────
202 202 🟢 Свободен 11:34:25
243 243 ⚫ Недоступен 11:34:43
252 252 🔴 Занят 11:34:41
──────────────────────────────────────────────────
Сотрудников: 3
Все источники — только для тестов
Примеры использования REST API
Инструкция с примерами по созданию и использованию API-ключей
Работа с REST API построена по стандарту OpenAPI. Для получения актуального списка эндпоинтов используйте раздел «Документация» внутри АТС. Ниже приведены примеры работы с основными возможностями REST интерфейса MikoPBX.
Если у вас отсутствует доверенный сертификат — добавьте verify=False в каждый запрос и отключите предупреждения:
import urllib3
urllib3.disable_warnings()
Настоятельно рекомендуется выпустить доверенный сертификат. Самый простой способ сделать это — с помощью модуля Let's Encrypt.
Подключение
Для выполнения всех примеров из этой инструкции создайте API-ключ и настройте следующие права доступа (подробнее в ):
Ресурс
Уровень доступа
Для каких примеров
В этой статье, мы будем работать с Python, поэтому необходимо установить необходимые зависимости:
Ниже приведён шаблон подключения к станции через API-ключ. Используйте его перед всеми скриптами из этой инструкции. API-ключ передаётся напрямую в заголовке запроса — никакой дополнительной аутентификации не требуется:
В шаблоне замените следующие параметры:
your-mikopbx.com — на IP-адрес или URL вашей станции.
ваш-api-ключ
Работа с сотрудниками
Эндпоинт:POST /pbxcore/api/v3/employees
Ниже приведена таблица с параметрами для такого запроса.
Поле
Обяз.
Тип / ограничения
Описание
Создание одного сотрудника
Пример ответа API (HTTP 201):
Возможные коды ответов:
Код
Описание
В случае успешного выполнения запроса вы увидите следующий вывод в консоль:
На станции будут созданы сотрудники 243 и 244.
Вывод списка сотрудников
В случае успешного выполнения запроса Вы увидите следующий вывод в консоль:
Массовое создание сотрудников
В случае успешного выполнения запроса вы увидите следующий вывод в консоль:
На станции будут создано 3 сотрудника.
Работа с SIP-провайдерами
Эндпоинт:POST /pbxcore/api/v3/sip-providers
Поле
Обяз.
Тип
Описание
Создание провайдера
В случае успешного выполнения запроса вы увидите следующий вывод в консоль:
На станции будет создан провайдер:
Вывод списка всех провайдеров
В случае успешного выполнения запроса вы увидите следующий вывод в консоль:
Вывод истории звонков (CDR)
Эндпоинт:GET /pbxcore/api/v3/cdr — только чтение.
Параметр
Тип
Описание
В случае успешного выполнения запроса вы увидите следующий вывод в консоль:
Статистика за период
В случае успешного выполнения запроса вы увидите следующий вывод в консоль:
Звонки со статусом CHANUNAVAIL не учитываются в статистике «Отвечено», «Пропущено», «Средняя длит.».
Поля CDR-записи
Поле
Тип
Описание
Мониторинг: статусы SIP и активные звонки
Статусы регистрации сотрудников и SIP-провайдеров
Эндпоинты:GET /pbxcore/api/v3/sip , GET /pbxcore/api/v3/sip-providers
В случае успешного выполнения запроса вы увидите следующий вывод в консоль:
Статусы сотрудников (поле status)
Значение
Описание
Статусы провайдеров (поле state)
Значение
Описание
Активные звонки в реальном времени
Эндпоинт:GET /pbxcore/api/v3/pbx-status
В случае успешного выполнения запроса вы увидите следующий вывод в консоль:
Полный список эндпоинтов и интерактивная документация — в разделе
Чтение
Статусы регистрации сотрудников и транков
Call Records
Чтение
История звонков (CDR)
PBX Status
Чтение
Активные звонки в реальном времени
SIP Providers
Чтение и запись
Создание и редактирование SIP провайдеров
— на ранее созданный API-ключ с необходимыми правами.
ФИО сотрудника
sip_secret
✅
string, 5–100 символов
Пароль SIP-аккаунта
user_email
—
string email, ≤255
Email для уведомлений
mobile_number
—
string E.164, ≤50
Мобильный (+7...) для переадресации
mobile_dialstring
—
string, ≤255
Строка набора мобильного
sip_transport
—
udp / tcp / tls / udp,tcp
Транспорт SIP (по умолч.: udp)
sip_dtmfmode
—
auto / rfc4733 / inband / info
Режим DTMF (по умолч.: auto)
sip_enableRecording
—
boolean
Запись разговоров (по умолч.: true)
sip_networkfilterid
—
number | "none"
ID сетевого фильтра
sip_manualattributes
—
string, ≤1024
Дополнительные SIP-параметры
fwd_ringlength
—
integer, ≤180
Время дозвона до переадресации (сек, по умолч.: 45)
Создан: 243 (Иванов Иван), id=113
Создан: 244 (Петрова Анна), id=114
Process finished with exit code 0
def list_employees(search: str = '', limit: int = 100, offset: int = 0) -> list:
params = {'limit': limit, 'offset': offset}
if search: params['search'] = search
r = requests.get(f'{BASE_URL}/employees', headers=HEADERS, params=params)
return r.json().get('data', {}).get('data', [])
for emp in list_employees():
print(f" {emp.get('number'):>6} {emp.get('user_username', '')}")
202 Brown Brandon
203 Collins Melanie
201 Smith James
243 Иванов Иван
244 Петрова Анна
Process finished with exit code 0
import time
employees = [
{'number': '251', 'name': 'Иванов Иван', 'secret': 'Pass#9201'},
{'number': '252', 'name': 'Петрова Анна', 'secret': 'Pass#9202'},
{'number': '253', 'name': 'Сидоров Пётр', 'secret': 'Pass#9203'},
]
created, failed = [], []
for emp in employees:
r = requests.post(
f'{BASE_URL}/employees',
headers=HEADERS,
json={
'number': emp['number'],
'user_username': emp['name'],
'sip_secret': emp['secret'],
}
)
result = r.json()
if result.get('result'):
created.append(emp['number'])
print(f" {emp['number']} {emp['name']}")
else:
failed.append(emp['number'])
print(f" {emp['number']}: {result.get('messages', {}).get('error', [])}")
time.sleep(0.2) # небольшая пауза между запросами
print(f'Создано: {len(created)}, Ошибок: {len(failed)}')
251 Иванов Иван
252 Петрова Анна
253 Сидоров Пётр
Создано: 3, Ошибок: 0
Process finished with exit code 0
def create_sip_provider(
description: str,
host: str,
username: str = '',
password: str = '',
registration_type: str = 'outbound',
qualify: bool = True,
) -> dict:
payload = {
'description': description,
'host': host,
}
if username: payload['username'] = username
if password: payload['secret'] = password
if registration_type: payload['registration_type'] = registration_type
if not qualify: payload['qualify'] = qualify
r = requests.post(f'{BASE_URL}/sip-providers', headers=HEADERS, json=payload)
result = r.json()
if result.get('result'):
print(f" Провайдер создан: {description}")
else:
print(f" Ошибка: {result.get('messages', {}).get('error', [])}")
return result
create_sip_provider(
description='Zadarma',
host='sip.zadarma.com',
username='316811',
password='mysecretpass',
)
Провайдер создан: Zadarma
Process finished with exit code 0
def list_providers() -> list:
r = requests.get(f'{BASE_URL}/sip-providers', headers=HEADERS)
return r.json().get('data', [])
for prov in list_providers():
print(f" {prov.get('id'):<20} {prov.get('description', '')} [{prov.get('type', '')}]")
SIP-TRUNK-34F7CAFE [SIP]
SIP-TRUNK-7B5977ED [SIP]
Process finished with exit code 0
from datetime import datetime, timedelta
def get_cdr(
offset: int = 0,
limit: int = 20,
date_from: str = None,
date_to: str = None,
src_num: str = None,
dst_num: str = None,
disposition: str = None,
) -> list:
params = {'offset': offset, 'limit': min(limit, 100)}
if date_from: params['dateFrom'] = date_from
if date_to: params['dateTo'] = date_to
if src_num: params['src_num'] = src_num
if dst_num: params['dst_num'] = dst_num
if disposition: params['disposition'] = disposition
r = requests.get(f'{BASE_URL}/cdr', headers=HEADERS, params=params)
return r.json().get('data', {}).get('records', [])
now = datetime.now()
then = now - timedelta(days=7)
for row in get_cdr(
date_from=then.strftime('%Y-%m-%dT%H:%M:%S'),
date_to=now.strftime('%Y-%m-%dT%H:%M:%S'),
):
print(
str(row.get('start', ''))[:16],
row.get('src_num', ''), '→', row.get('dst_num', ''),
row.get('disposition', ''), row.get('totalBillsec', 0), 'с'
)
2026-03-17 13:30 252 → 202 ANSWERED 48 с
2026-03-17 13:30 243 → 252 BUSY 0 с
2026-03-17 13:30 243 → 89161111111 CHANUNAVAIL 0 с
2026-03-17 13:29 202 → 243 NOANSWER 0 с
2026-03-17 13:29 202 → 202 ANSWERED 2 с
2026-03-17 13:29 202 → 243 NOANSWER 0 с
2026-03-17 13:29 202 → 10003246 NOANSWER 0 с
2026-03-17 13:28 202 → 243 NOANSWER 0 с
Process finished with exit code 0
def cdr_stats(days: int = 1) -> dict:
now = datetime.now()
then = now - timedelta(days=days)
records = get_cdr(
date_from=then.strftime('%Y-%m-%dT%H:%M:%S'),
date_to=now.strftime('%Y-%m-%dT%H:%M:%S'),
limit=100
)
answered = [r for r in records if r.get('disposition') == 'ANSWERED']
missed = [r for r in records if r.get('disposition') in ('NO ANSWER', 'NOANSWER')]
total_dur = sum(r.get('totalBillsec', 0) for r in answered)
return {
'total': len(records),
'answered': len(answered),
'missed': len(missed),
'avg_sec': total_dur // len(answered) if answered else 0,
}
stats = cdr_stats(days=7)
print(f"Звонков за 7 дней: {stats['total']}")
print(f"Отвечено: {stats['answered']}")
print(f"Пропущено: {stats['missed']}")
print(f"Средняя длит.: {stats['avg_sec']}с")
Звонков за 7 дней: 13
Отвечено: 2
Пропущено: 5
Средняя длит.: 25с
Process finished with exit code 0
from datetime import datetime
def show_employees():
r = requests.get(f'{BASE_URL}/sip:getStatuses', headers=HEADERS)
peers = r.json().get('data', {})
for number, info in peers.items():
icon = '🟢' if info.get('status') == 'Available' else '🔴'
print(f" {icon} {number:>6} {info.get('callerid', '')} [{info.get('status', '')}]")
def show_providers():
r = requests.get(f'{BASE_URL}/sip-providers:getStatuses', headers=HEADERS)
providers = r.json().get('data', {}).get('sip', {})
for prov_id, info in providers.items():
icon = '🟢' if info.get('state') == 'registered' else '🔴'
print(f" {icon} {info.get('description', prov_id):>20} {info.get('username', '')}@{info.get('host', '')} [{info.get('state', '')}]")
if __name__ == '__main__':
print(f'MikoPBX Monitor [{datetime.now().strftime("%Y-%m-%d %H:%M:%S")}]')
print('\n── Сотрудники ──────────────────────────────')
show_employees()
print('\n── Провайдеры ───────────────────────────────')
show_providers()
MikoPBX Monitor [2026-03-17 16:47:35]
── Сотрудники ──────────────────────────────
🔴 201 Smith James [Unavailable]
🟢 202 Brown Brandon [Available]
🔴 203 Collins Melanie [Unavailable]
🔴 243 Иванов Иван [Unavailable]
🟢 244 Петрова Анна [Available]
🔴 251 Иванов Иван [Unavailable]
🟢 252 Петрова Анна [Available]
🔴 253 Сидоров Пeтр [Unavailable]
── Провайдеры ───────────────────────────────
🔴 Demo provider [email protected] [rejected]
🟢 Zadarma [email protected] [registered]
Process finished with exit code 0
Активных звонков: 1
243 → 252 [Иванов Иван → Петрова Анна]
Process finished with exit code 0
Интерактивная документация и список эндпоинтов
Описание документации и таблицы эндпоинтов для работы с REST API в MikoPBX
Работа с REST API MikoPBX построена по стандарту OpenAPI. Интерактивная документация встроена прямо в АТС и всегда содержит актуальный список эндпоинтов, параметров и схем для вашей версии системы.
Как открыть документацию
Перейдите в раздел «Система» → «API ключи».
Нажмите кнопку «Документация API».
Возможности интерактивной документации
Документация построена на базе стандарта OpenAPI и предоставляет полное описание всех эндпоинтов REST API MikoPBX.
Навигация по эндпоинтам — в левой панели все эндпоинты сгруппированы по разделам.
Для каждого эндпоинта отображается краткое описание, метод запроса (GET, POST, PUT, PATCH, DELETE), endpoint с подставленым адресом АТС. Ниже отображаются все доступные параметры запроса.
Примеры кода — для каждого эндпоинта доступны готовые примеры запросов на разных языках. Переключатель находится под панелью параметров — по умолчанию показывается Shell / cURL, доступны также и другие языки (нажмите на название языка для его смены - в этой инструкции Python 3).
Ниже находится пример ответа сервера.
Выполнение запросов онлайн — документация позволяет отправлять реальные запросы прямо из браузера и получать ответы от вашей АТС. Сервер определяется автоматически по адресу текущей страницы.
Внизу страницы Вы найдете возможные номера ответов на запрос и краткое пояснение к ним. Так же будут отображены все параметры тела выбранного ответа.
Список эндпоинтов
Базовый префикс всех путей: /pbxcore/api/v3
Телефония и маршрутизация
Сотрудники
Метод
Путь
Описание
Внутренние номера
Метод
Путь
Описание
SIP провайдеры
Метод
Путь
Описание
IAX провайдеры
Метод
Путь
Описание
Провайдеры (общий список SIP + IAX)
Метод
Путь
Описание
Очереди звонков
Метод
Путь
Описание
IVR меню
Метод
Путь
Описание
Входящая маршрутизация
Метод
Путь
Описание
Исходящая маршрутизация
Метод
Путь
Описание
Нерабочее время
Метод
Путь
Описание
Конференц-комнаты
Метод
Путь
Описание
Приложения диалплана
Метод
Путь
Описание
Звуковые файлы
Метод
Путь
Описание
Кастомизация системных файлов
Метод
Путь
Описание
Мониторинг и статистика
Состояние АТС
Метод
Путь
Описание
SIP устройства
Метод
Путь
Описание
SIP провайдеры (мониторинг)
Метод
Путь
Описание
IAX провайдеры (мониторинг)
Метод
Путь
Описание
Провайдеры (мониторинг)
Метод
Путь
Описание
Журнал звонков (CDR)
Метод
Путь
Описание
Советы и рекомендации
Метод
Путь
Описание
Аутентификация и доступ
Аутентификация
Метод
Путь
Описание
API ключи
Метод
Путь
Описание
AMI пользователи
Метод
Путь
Описание
ARI пользователи
Метод
Путь
Описание
Ключи доступа (Passkeys)
Метод
Путь
Описание
Пароли
Метод
Путь
Описание
Пользователи
Метод
Путь
Описание
Сетевые фильтры
Метод
Путь
Описание
Системные настройки
Системные операции
Метод
Путь
Описание
Общие настройки
Метод
Путь
Описание
Сетевые интерфейсы и маршрутизация
Метод
Путь
Описание
Сетевой фильтр (Firewall)
Метод
Путь
Описание
Защита от взлома (Fail2Ban)
Метод
Путь
Описание
Настройки времени
Метод
Путь
Описание
Настройки почты
Метод
Путь
Описание
Хранилище
Метод
Путь
Описание
S3 Облачное хранилище
Метод
Путь
Описание
Дополнительные модули
Метод
Путь
Описание
Лицензирование
Метод
Путь
Описание
Операции с файлами
Метод
Путь
Описание
Диагностика
Информация о системе
Метод
Путь
Описание
Системные логи
Метод
Путь
Описание
Документация OpenAPI
Метод
Путь
Описание
Поиск
Метод
Путь
Описание
Ссылки на документацию
Метод
Путь
Описание
Отслеживание активности пользователей
Метод
Путь
Описание
/employees/{id}
Получить сотрудника по ID
PUT
/employees/{id}
Обновить сотрудника
PATCH
/employees/{id}
Частично обновить сотрудника
DELETE
/employees/{id}
Удалить сотрудника
GET
/employees:getDefault
Получить значения по умолчанию
POST
/employees:batchCreate
Массовое создание сотрудников
POST
/employees:batchDelete
Массовое удаление сотрудников
POST
/employees:import
Импортировать сотрудников (предпросмотр)
POST
/employees:confirmImport
Подтвердить импорт
POST
/employees:export
Экспортировать сотрудников
POST
/employees:exportTemplate
Экспортировать шаблон
/extensions:available
Проверить доступность номера
GET
/extensions:getForSelect
Получить добавочные для выпадающего списка
POST
/extensions/{id}:getPhoneRepresent
Получить представление телефона
POST
/extensions:getPhonesRepresent
Получить представление телефонов
/sip-providers/{id}
Получить SIP провайдера по ID
PUT
/sip-providers/{id}
Обновить SIP провайдера
PATCH
/sip-providers/{id}
Частично обновить SIP провайдера
DELETE
/sip-providers/{id}
Удалить SIP провайдера
GET
/sip-providers/{id}:copy
Скопировать SIP провайдера
GET
/sip-providers:getDefault
Получить шаблон SIP провайдера
/iax-providers/{id}
Получить IAX провайдера по ID
PUT
/iax-providers/{id}
Обновить IAX провайдера
PATCH
/iax-providers/{id}
Частично обновить IAX провайдера
DELETE
/iax-providers/{id}
Удалить IAX провайдера
GET
/iax-providers/{id}:copy
Скопировать IAX провайдера
GET
/iax-providers:getDefault
Получить шаблон IAX провайдера
/providers:getForSelect
Получить провайдеров для выпадающего списка
/call-queues/{id}
Получить очередь по ID
PUT
/call-queues/{id}
Обновить очередь
PATCH
/call-queues/{id}
Частично обновить очередь
DELETE
/call-queues/{id}
Удалить очередь
GET
/call-queues/{id}:copy
Копировать очередь
GET
/call-queues:getDefault
Получить значения по умолчанию
/ivr-menu/{id}
Получить IVR меню по ID
PUT
/ivr-menu/{id}
Обновить IVR меню
PATCH
/ivr-menu/{id}
Частично обновить IVR меню
DELETE
/ivr-menu/{id}
Удалить IVR меню
GET
/ivr-menu/{id}:copy
Копировать IVR меню
GET
/ivr-menu:getDefault
Получить значения по умолчанию
/incoming-routes/{id}
Получить входящий маршрут по ID
PUT
/incoming-routes/{id}
Обновить входящий маршрут
PATCH
/incoming-routes/{id}
Частично обновить входящий маршрут
DELETE
/incoming-routes/{id}
Удалить входящий маршрут
POST
/incoming-routes/{id}:copy
Копировать входящий маршрут
GET
/incoming-routes:getDefault
Получить значения по умолчанию
GET
/incoming-routes:getDefaultRoute
Получить маршрут по умолчанию
POST
/incoming-routes:changePriority
Изменить приоритет маршрутов
/outbound-routes/{id}
Получить исходящий маршрут по ID
PUT
/outbound-routes/{id}
Обновить исходящий маршрут
PATCH
/outbound-routes/{id}
Частично обновить исходящий маршрут
DELETE
/outbound-routes/{id}
Удалить исходящий маршрут
GET
/outbound-routes/{id}:copy
Копировать исходящий маршрут
GET
/outbound-routes:getDefault
Получить значения по умолчанию
POST
/outbound-routes:changePriority
Изменить приоритет маршрутов
/off-work-times/{id}
Получить временное условие по ID
PUT
/off-work-times/{id}
Обновить временное условие
PATCH
/off-work-times/{id}
Частично обновить временное условие
DELETE
/off-work-times/{id}
Удалить временное условие
GET
/off-work-times/{id}:copy
Копировать временное условие
GET
/off-work-times:getDefault
Получить значения по умолчанию
POST
/off-work-times:changePriorities
Изменить приоритеты условий
/conference-rooms/{id}
Получить конференц-комнату по ID
PUT
/conference-rooms/{id}
Обновить конференц-комнату
PATCH
/conference-rooms/{id}
Частично обновить конференц-комнату
DELETE
/conference-rooms/{id}
Удалить конференц-комнату
GET
/conference-rooms:getDefault
Получить шаблон конференц-комнаты
/dialplan-applications/{id}
Получить dialplan приложение по ID
PUT
/dialplan-applications/{id}
Обновить dialplan приложение
PATCH
/dialplan-applications/{id}
Частично обновить dialplan приложение
DELETE
/dialplan-applications/{id}
Удалить dialplan приложение
GET
/dialplan-applications/{id}:copy
Скопировать dialplan приложение
GET
/dialplan-applications:getDefault
Получить шаблон dialplan приложения
/sound-files/{id}
Получить звуковой файл по ID
PUT
/sound-files/{id}
Обновить звуковой файл
PATCH
/sound-files/{id}
Частично обновить звуковой файл
DELETE
/sound-files/{id}
Удалить звуковой файл
GET
/sound-files:getDefault
Получить значения по умолчанию
GET
/sound-files:getForSelect
Получить для выпадающего списка
GET
/sound-files:playback
Воспроизвести звуковой файл
POST
/sound-files:uploadFile
Загрузить звуковой файл
POST
/sound-files:convertAudioFile
Конвертировать аудио файл
/custom-files/{id}
Получить пользовательский файл по ID
PUT
/custom-files/{id}
Обновить пользовательский файл
PATCH
/custom-files/{id}
Частично обновить пользовательский файл
DELETE
/custom-files/{id}
Удалить пользовательский файл
GET
/custom-files:getDefault
Получить значения по умолчанию
/sip:getRegistry
Получить статус регистрации (legacy)
POST
/sip:processAuthFailures
Обработать ошибки аутентификации
GET
/sip/{id}:getStatus
Получить статус SIP устройства
GET
/sip/{id}:getStats
Получить статистику SIP устройства
GET
/sip/{id}:getHistory
Получить историю подключений
GET
/sip/{id}:getSecret
Получить SIP пароль
GET
/sip/{id}:getAuthFailureStats
Получить статистику ошибок аутентификации
POST
/sip/{id}:clearAuthFailureStats
Очистить статистику ошибок
POST
/sip/{id}:forceCheck
Принудительно проверить статус
/sip-providers/{id}:getHistory
Получить историю подключений
GET
/sip-providers/{id}:getStats
Получить статистику SIP провайдера
POST
/sip-providers/{id}:forceCheck
Принудительно проверить регистрацию
POST
/sip-providers/{id}:updateStatus
Обновить статус провайдера
/iax-providers/{id}:getHistory
Получить историю подключений
GET
/iax-providers/{id}:getStats
Получить статистику IAX провайдеров
POST
/iax-providers/{id}:forceCheck
Принудительно проверить регистрацию
POST
/iax-providers/{id}:updateStatus
Обновить статус провайдера
GET
/iax:getRegistry
Получить статус регистрации IAX провайдеров
/providers/{id}:getHistory
Получить историю провайдера
GET
/providers/{id}:getStats
Получить статистику провайдера
POST
/providers/{id}:updateStatus
Обновить статус провайдера
/cdr/{id}
Удалить CDR запись
GET
/cdr:getMetadata
Получить метаданные CDR
GET
/cdr:playback
Воспроизвести запись разговора
GET
/cdr:download
Скачать запись разговора
/auth:logout
Выйти из системы
/api-keys/{id}
Получить API ключ по ID
PUT
/api-keys/{id}
Обновить API ключ
PATCH
/api-keys/{id}
Частично обновить API ключ
DELETE
/api-keys/{id}
Удалить API ключ
GET
/api-keys:getDefault
Получить значения по умолчанию
POST
/api-keys:generateKey
Сгенерировать новый ключ
/asterisk-managers/{id}
Получить AMI пользователя по ID
PUT
/asterisk-managers/{id}
Обновить AMI пользователя
PATCH
/asterisk-managers/{id}
Частично обновить AMI пользователя
DELETE
/asterisk-managers/{id}
Удалить AMI пользователя
GET
/asterisk-managers/{id}:copy
Копировать AMI пользователя
GET
/asterisk-managers:getDefault
Получить значения по умолчанию
/asterisk-rest-users/{id}
Получить ARI пользователя по ID
PUT
/asterisk-rest-users/{id}
Обновить ARI пользователя
PATCH
/asterisk-rest-users/{id}
Частично обновить ARI пользователя
DELETE
/asterisk-rest-users/{id}
Удалить ARI пользователя
GET
/asterisk-rest-users:getDefault
Получить значения по умолчанию
/passkeys/{id}
Получить passkey по ID
PATCH
/passkeys/{id}
Обновить passkey
DELETE
/passkeys/{id}
Удалить passkey
GET
/passkeys:checkAvailability
Проверить наличие passkeys
GET
/passkeys:authenticationStart
Начать аутентификацию через passkey
POST
/passkeys:authenticationFinish
Завершить аутентификацию через passkey
POST
/passkeys:registrationStart
Начать регистрацию passkey
POST
/passkeys:registrationFinish
Завершить регистрацию passkey
/passwords:checkDictionary
Проверить пароль в словаре
POST
/passwords:batchValidate
Пакетная проверка паролей
POST
/passwords:batchCheckDictionary
Пакетная проверка словаря
/network-filters:getForSelect
Получить фильтры для выпадающего списка
/system:datetime
Получить системное время
GET
/system:getAvailableLanguages
Получить доступные языки
GET
/system:checkForUpdates
Получить детальную информацию об обновлении
GET
/system:checkIfNewReleaseAvailable
Быстрая проверка наличия новой версии
GET
/system:getDeleteStatistics
Получить статистику удаления
POST
/system:reboot
Перезагрузить систему
POST
/system:shutdown
Выключить систему
POST
/system:upgrade
Обновить систему
POST
/system:restoreDefault
Восстановить настройки по умолчанию
POST
/system:changeLanguage
Изменить язык системы
POST
/system:convertAudioFile
Конвертировать аудиофайл
POST
/system:executeBashCommand
Выполнить bash команду
POST
/system:executeSqlRequest
Выполнить SQL запрос
POST
/system:updateMailSettings
Обновить настройки почты
/general-settings
Частично обновить общие настройки
GET
/general-settings/{id}
Получить конкретную настройку
GET
/general-settings:getDefault
Получить значения по умолчанию
POST
/general-settings:updateCodecs
Обновить настройки кодеков
/network/{id}
Удалить сетевой интерфейс
GET
/network:getConfig
Получить полную конфигурацию сети
GET
/network:getNatSettings
Получить настройки NAT
POST
/network:saveConfig
Сохранить конфигурацию сети
/firewall/{id}
Получить правило файервола по ID
PUT
/firewall/{id}
Обновить правило файервола
PATCH
/firewall/{id}
Частично обновить правило файервола
DELETE
/firewall/{id}
Удалить правило файервола
GET
/firewall:getDefault
Получить значения по умолчанию
GET
/firewall:getBannedIps
Получить список заблокированных IP
POST
/firewall:unbanIp
Разблокировать IP адрес
POST
/firewall:enable
Включить файервол
POST
/firewall:disable
Выключить файервол
/fail2ban
Частично обновить настройки Fail2Ban
/mail-settings
Частично обновить настройки почты
DELETE
/mail-settings
Сбросить настройки почты
GET
/mail-settings:getDefault
Получить значения по умолчанию
GET
/mail-settings:getDiagnostics
Получить диагностику настроек почты
GET
/mail-settings:getOAuth2Url
Получить URL авторизации OAuth2
POST
/mail-settings:refreshToken
Обновить OAuth2 токен
POST
/mail-settings:testConnection
Проверить подключение к SMTP серверу
POST
/mail-settings:sendTestEmail
Отправить тестовое письмо
/storage:mount
Смонтировать устройство хранения
POST
/storage:umount
Размонтировать устройство хранения
POST
/storage:mkfs
Форматировать устройство хранения
POST
/storage:statusMkfs
Получить статус форматирования
/s3-storage
Частично обновить конфигурацию S3
GET
/s3-storage:stats
Получить статистику синхронизации S3
GET
/s3-storage:testConnection
Тестировать S3 соединение
/modules/{id}
Получить модуль по ID
PUT
/modules/{id}
Обновить модуль
PATCH
/modules/{id}
Частично обновить модуль
DELETE
/modules/{id}
Удалить модуль
GET
/modules/{id}:getModuleInfo
Получить информацию о модуле
GET
/modules/{id}:getModuleLink
Получить ссылку на скачивание модуля
GET
/modules/{id}:getDownloadStatus
Получить статус загрузки
POST
/modules/{id}:startDownload
Начать загрузку модуля
POST
/modules/{id}:installFromRepo
Установить модуль из репозитория
POST
/modules:installFromPackage
Установить модуль из пакета
POST
/modules:getMetadataFromPackage
Получить метаданные из пакета
POST
/modules/{id}:enable
Включить модуль
POST
/modules/{id}:disable
Отключить модуль
POST
/modules/{id}:uninstall
Удалить модуль
POST
/modules:updateAll
Обновить все модули
GET
/modules:getAvailableModules
Получить доступные модули
GET
/modules:getInstallationStatus
Получить статус установки
GET
/modules:getDefault
Получить настройки модуля по умолчанию
/license:resetKey
Сбросить лицензионный ключ
GET
/license:sendPBXMetrics
Отправить метрики АТС
POST
/license:captureFeatureForProductId
Захватить функцию для продукта
POST
/license:processUserRequest
Обработать запрос пользователя
/files/{id}
Удалить файл
POST
/files:upload
Загрузить файл (чанками)
GET
/files:uploadStatus
Проверить статус загрузки
POST
/files:downloadFirmware
Скачать прошивку
GET
/files:firmwareStatus
Проверить статус скачивания прошивки
/sysinfo:getHypervisorInfo
Получить информацию о гипервизоре
GET
/sysinfo:getDMIInfo
Получить DMI информацию
/syslog:getLogTimeRange
Получить временной диапазон лога
POST
/syslog:eraseFile
Очистить лог файл
POST
/syslog:startCapture
Начать захват пакетов
POST
/syslog:stopCapture
Остановить захват пакетов
POST
/syslog:prepareArchive
Подготовить архив логов
POST
/syslog:downloadArchive
Скачать архив логов
POST
/syslog:downloadLogFile
Скачать лог файл
/openapi:getDetailedPermissions
Получить детальный список разрешений
GET
/openapi:getSimplifiedPermissions
Получить упрощенный список разрешений
GET
/openapi:getValidationSchemas
Получить схемы валидации
POST
/openapi:clearCache
Очистить кэш OpenAPI
GET
/employees
Получить список сотрудников
POST
/employees
Создать нового сотрудника
GET
GET
/extensions
Получить список добавочных номеров
GET
/extensions/{id}
Получить добавочный номер по ID
POST
GET
/sip-providers
Получить список SIP провайдеров
POST
/sip-providers
Создать SIP провайдера
GET
GET
/iax-providers
Получить список IAX провайдеров
POST
/iax-providers
Создать IAX провайдера
GET
GET
/providers
Получить список всех провайдеров
GET
/providers/{id}
Получить провайдера по ID
GET
GET
/call-queues
Получить список очередей
POST
/call-queues
Создать новую очередь
GET
GET
/ivr-menu
Получить список IVR меню
POST
/ivr-menu
Создать новое IVR меню
GET
GET
/incoming-routes
Получить список входящих маршрутов
POST
/incoming-routes
Создать входящий маршрут
GET
GET
/outbound-routes
Получить список исходящих маршрутов
POST
/outbound-routes
Создать исходящий маршрут
GET
GET
/off-work-times
Получить список временных условий
POST
/off-work-times
Создать временное условие
GET
GET
/conference-rooms
Получить список конференц-комнат
POST
/conference-rooms
Создать конференц-комнату
GET
GET
/dialplan-applications
Получить список dialplan приложений
POST
/dialplan-applications
Создать dialplan приложение
GET
GET
/sound-files
Получить список звуковых файлов
POST
/sound-files
Создать звуковой файл
GET
GET
/custom-files
Получить список пользовательских файлов
POST
/custom-files
Создать новый пользовательский файл
GET
GET
/pbx-status:getActiveCalls
Получить активные вызовы
GET
/pbx-status:getActiveChannels
Получить активные каналы
GET
/sip:getStatuses
Получить статусы всех SIP устройств
GET
/sip:getPeersStatuses
Получить статусы SIP peers (legacy)
GET
GET
/sip-providers:getStatuses
Получить статусы всех SIP провайдеров
GET
/sip-providers/{id}:getStatus
Получить статус SIP провайдера
GET
GET
/iax-providers:getStatuses
Получить статусы всех IAX провайдеров
GET
/iax-providers/{id}:getStatus
Получить статус IAX провайдера
GET
GET
/providers:getStatuses
Получить статусы всех провайдеров
GET
/providers/{id}:getStatus
Получить статус провайдера
GET
GET
/cdr
Получить список CDR записей
GET
/cdr/{id}
Получить CDR запись по ID
DELETE
GET
/advice:getList
Получить список системных уведомлений
GET
/advice:refresh
Обновить кеш уведомлений
POST
/auth:login
Войти в систему (логин/пароль)
POST
/auth:refresh
Обновить токен доступа
POST
GET
/api-keys
Получить список API ключей
POST
/api-keys
Создать новый API ключ
GET
GET
/asterisk-managers
Получить список AMI пользователей
POST
/asterisk-managers
Создать нового AMI пользователя
GET
GET
/asterisk-rest-users
Получить список ARI пользователей
POST
/asterisk-rest-users
Создать нового ARI пользователя
GET
GET
/passkeys
Получить список passkeys
POST
/passkeys
Создать новый passkey
GET
GET
/passwords:generate
Сгенерировать пароль
POST
/passwords:validate
Проверить надежность пароля
POST
GET
/users:available
Проверить доступность email
GET
/network-filters
Получить список сетевых фильтров
GET
/network-filters/{id}
Получить сетевой фильтр по ID
GET
GET
/system:ping
Проверить доступность системы
GET
/system:checkAuth
Проверить аутентификацию
GET
GET
/general-settings
Получить общие настройки
PUT
/general-settings
Обновить общие настройки
PATCH
GET
/network
Получить список сетевых интерфейсов
GET
/network/{id}
Получить сетевой интерфейс по ID
DELETE
GET
/firewall
Получить список правил файервола
POST
/firewall
Создать правило файервола
GET
GET
/fail2ban
Получить настройки Fail2Ban
PUT
/fail2ban
Обновить настройки Fail2Ban
PATCH
GET
/time-settings:getAvailableTimezones
Получить список доступных часовых поясов
GET
/mail-settings
Получить настройки почты
PUT
/mail-settings
Обновить настройки почты
PATCH
GET
/storage:usage
Получить статистику использования хранилища
GET
/storage:list
Получить список доступных устройств хранения
POST
GET
/s3-storage
Получить конфигурацию S3 хранилища
PUT
/s3-storage
Обновить конфигурацию S3 хранилища
PATCH
GET
/modules
Получить список модулей
POST
/modules
Создать модуль
GET
GET
/license:getLicenseInfo
Получить информацию о лицензии
GET
/license:ping
Проверить связь с сервером лицензий
GET
GET
/files/{id}
Получить содержимое файла
PUT
/files/{id}
Загрузить/обновить файл
DELETE
GET
/sysinfo:getInfo
Получить системную информацию
GET
/sysinfo:getExternalIpInfo
Получить внешний IP адрес
GET
GET
/syslog:getLogsList
Получить список лог файлов
POST
/syslog:getLogFromFile
Получить содержимое лога
POST
GET
/openapi:getSpecification
Получить OpenAPI спецификацию
GET
/openapi:getAclRules
Получить ACL правила API
GET
GET
/search:getSearchItems
Глобальный поиск
GET
/wiki-links:getLink
Получить ссылку на документацию
POST
/user-page-tracker:pageView
Зафиксировать просмотр страницы
POST
/user-page-tracker:pageLeave
Зафиксировать уход со страницы
Раздел "Система" -> "API ключи"
Кнопка «Документация API» в разделе API ключей
Меню навигации
Описание эндпоинта с параметрами запроса и примером тела