Предисловие

Добро пожаловать на ресурс документации по MikoPBX! Здесь Вы сможете найти пошаговые инструкции, связанные с взаимодействием с АТС MikoPBX. Для удобства, они собраны в разделы - прямо как в Web-интерфейсе, поэтому ориентироваться в документации очень легко.

Благодарим Вас за выбор MikoPBX! ❤️

Что такое MikoPBX?

MikoPBX - это бесплатный сервер телефонии с операционной системой и простым, удобным веб-интерфейсом. Она работает практически с любой телефонной технологией в мире.

MikoPBX — это полностью модульный интерфейс для Asterisk, написанный на PHP и Javascript. Это значит что в MikoPBX возможно реализовать абсолютно любой дополнительный функционал Asterisk телефонии. Более того, если вы разработаете полезный модуль, его можно поместить в общий репозиторий и сделать доступным для всех пользователей MikoPBX. Помимо этого, MikoPBX имеет очень низкие требования к аппаратному обеспечению ПК:

Для начала вам следует установить MikoPBX любым удобным для вас способом. Ниже находятся опции установки. Нажав на их название - вы можете перейти к подробным профильным статьям:

• Установка .

• Установка .

• Установка .

• Установка в .

После установки вы можете перейти к изучению вашей станции. В этом вам поможет дальнейшая документация "Руководство пользователя", которая подробно рассказывает про конкретные разделы:

• .

• .

• .

• .

За дополнительной помощью по "быстрому старту", вы можете обратиться к .

В случае, если вы разобрались с базовой настройкой и эксплуатацией MikoPBX, Вы можете расширить ее функционал с помощью модулей.

Они позволяют добавить дополнительные функции вашей системы. Разобраться в них подробнее вы можете по шагам:

1. - здесь подробно описан процесс регистрации и его особенности.

2. - здесь подробно описан процесс установки и управления модулями.

3. - в этом разделе вы найдете подробное описание каждого модуля, а так же шаги по его настройки и использованию.

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

Если у вас возник вопрос, который не разобран в данном разделе - Вы можете обратиться за помощью в , где пользователи MikoPBX помогают друг другу решить вопросы и потребности, связанные с АТС.

Первый вход в систему MikoPBX

Перейдите в консоль MikoPBX, вверху будет находиться IP-адрес, по которому вы можете подключиться через WEB-интерфейс. При установках не на локальный компьютер используйте внутренний IP-адрес. Скопируйте или запомните его.

Введите или вставьте IP-адрес MikoPBX в web-браузере. Отобразится страница авторизации в web-интерфейс. Введите логин и пароль по умолчанию.

После первой успешной авторизации, MikoPBX автоматически откроет настройки для смены пароля. Поменяйте пароль и нажмите "Сохранить".

После смены пароля система будет полностью готова к работе. Рекомендуется сразу же настроить правила firewall. Прочитать про то, как это сделать, можно по ссылке.

MikoPBX поддерживает установку на отдельный компьютер. Существуют два способа:

• Live USB - запись образа на флешку с последующей её установкой на другой диск.

• Bootable USB - установка системы на непосредственно сам USB-носитель с последующей возможностью загрузки с нее.

В данном разделе представлены варианты записи образов на всех возможных системах (Windows, MacOS, Linux)

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

MikoPBX поддерживает установку с помощью многих облачных сервисов. В данном разделе Вы можете найти подробные инструкции по ним. Нажмите на элемент в списке ниже для перехода к инструкции по конкретной виртуальной машине:

В сервисе Yandex Cloud есть возможность загрузить АТС MikoPBX из образа в маркетплейсе Яндекса или из образа на основе загруженного *.raw файла из дистрибутива 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

Самый простой способ установки MikoPBX — установка готового образа из AWS Marketplace. Если вы хотите запустить нестандартную версию MikoPBX, воспользуйтесь подробной инструкцией, где мы по шагам описали, каким образом можно создать AMI-образ из любого дистрибутива MikoPBX. Если же вы хотите управлять инфраструктурой как кодом и воспроизводить окружение автоматически — воспользуйтесь нашим Terraform-руководством, которое описывает полный цикл развёртывания MikoPBX в AWS: от импорта образа до запуска инстанса.

Утилита Yandex Cloud позволяет автоматизировать создание инстансов. Ее можно использовать в скриптах.

1. На странице продукта скопируйте значение image_id. В текущем примере fd83g1qbk6m3jnl5cvah (для версии 2022.3.15). Идентификатор образа следует укзаать в параметре create-boot-disk image-id

2. Получим список каталогов

yc resource-manager folder list

Выбираем каталог и указываем его имя в параметре folder-name

1. Список зон

Описываем зону в параметре zone

1. Запускаем инстанс

1. Список инстансов обновится

Используйте EXTERNAL IP для входа и ID в качестве пароля для пользователя admin web интерфейса

Раздел «Модули» в MikoPBX — это интерфейс для управления дополнительными функциональными компонентами системы, который включает два подраздела: «Управление модулями» и «Приложения диалплана».

Управление этими подразделами позволяет настроить MikoPBX максимально гибко и эффективно, расширяя функциональность телефонной системы и адаптируя ее под уникальные требования организации.

Регистрация в маркетплейсе модулей

Регистрация в Маркетплейсе MikoPBX не влияет на базовый функционал системы. Вы можете использовать MikoPBX для работы со звонками без регистрации и установки дополнительных модулей. Однако, Мы рекомендуем пройти процедуру регистрации в маркетплейсе для получения возможности расширения функционала системы.

Регистрация даст вам доступ к дополнительным модулям и расширениям.

Управление модулями

Управление модулями в MikoPBX — это интерфейс для управления дополнительными компонентами системы, расширяющими ее функциональность. Здесь администраторы могут устанавливать, обновлять, включать или отключать модули, добавляя новые возможности или интеграции с внешними сервисами. Этот раздел позволяет адаптировать систему под специфические потребности компании, обеспечивая гибкость и масштабируемость телефонной сети.

Приложения диалпланов в MikoPBX — это набор инструментов, которые позволяют настраивать индивидуальные сценарии обработки звонков внутри системы. С их помощью вы можете определить последовательность действий, которую система выполнит при поступлении или совершении вызова. Это может включать перенаправление звонка на определенный внутренний номер, воспроизведение специальных аудиосообщений, запрос дополнительной информации у звонящего или выполнение других функций.

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

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

Перед началом процесса, отформатируйте Ваш носитель со следующими параметрами:

• File system - FAT32

• Allocation unit size - 8192 bytes

Для записи образа будет использована утилита Rufus. Скачать ее можно .

MikoPBX можно запустить в Docker, используя два основных способа. Первый способ включает в себя запуск контейнера напрямую через команду Docker с указанием необходимых параметров. Второй способ предусматривает использование Docker Compose, что упрощает управление многоконтейнерными приложениями и позволяет описать всю конфигурацию в yaml-файле, что делает развертывание и обслуживание системы более удобным.

Перед началом работы с Docker, необходимо установить сам Docker и Docker Compose. Вот как это можно сделать:

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

Команда для подключения к консоли АТС:

Команда для подключения к консольному меню АТС:

Подключение к shgrep для анализа SIP

Раздел «Обслуживание» в MikoPBX — это интерфейс для управления техническими аспектами системы и обеспечения ее стабильной работы. Здесь администраторы могут выполнять задачи по резервному копированию и восстановлению данных, обновлению программного обеспечения, мониторингу состояния системы и управлению журналами событий. Этот раздел помогает поддерживать работоспособность телефонной системы, своевременно обнаруживать и устранять возможные проблемы.

Раздел «Обновление» в MikoPBX — это интерфейс для управления обновлениями программного обеспечения системы. Здесь администраторы могут проверять наличие новых версий, устанавливать обновления и просматривать историю изменений. Регулярное использование этого раздела обеспечивает актуальность, безопасность и стабильность работы MikoPBX.

Раздел «Диагностика системы» в MikoPBX — это инструмент для мониторинга и анализа состояния телефонной системы. Здесь администраторы могут просматривать журналы событий, проверять с помощью них статус различных сервисов и компонентов системы, а также выполнять тестирование соединений и вызовов. Использование этого раздела помогает своевременно обнаруживать и устранять технические проблемы, обеспечивая стабильную и эффективную работу MikoPBX.

Раздел «Перезагрузка и выключение системы»

Раздел «Сеть и Firewall» в MikoPBX — это интерфейс для настройки сетевых параметров и управления брандмауэром системы. Здесь администраторы могут настраивать IP-адреса, сетевые интерфейсы и создавать правила брандмауэра для защиты системы от несанкционированного доступа. Этот раздел обеспечивает безопасную и стабильную работу MikoPBX в сетевой инфраструктуре организации.

Раздел «Сетевые интерфейсы» в MikoPBX — это интерфейс для настройки параметров сетевых подключений системы. Здесь администраторы могут управлять IP-адресами, масками подсети, шлюзами и другими сетевыми настройками для каждого сетевого интерфейса. Это позволяет корректно интегрировать MikoPBX в сеть организации и обеспечить ее стабильную работу в соответствии с требованиями сетевой инфраструктуры.

Раздел «Сетевой экран» в MikoPBX — это интерфейс для настройки брандмауэра (Firewall) системы. Здесь администраторы могут создавать и управлять правилами фильтрации сетевого трафика, контролируя доступ к MikoPBX и защищая ее от несанкционированного доступа и сетевых угроз. Настройка сетевого экрана обеспечивает безопасность телефонной системы, предотвращая потенциальные атаки и обеспечивая стабильную работу в сетевой инфраструктуре организации.

Раздел «Защита от взлома (Fail2Ban)»

Глава "Телефония" в документации MikoPBX содержит подробную информацию и инструкции, связанные с настройкой и использованием телефонии в системе.

Сотрудники в MikoPBX — это индивидуальные пользователи системы, которым назначены внутренние номера для совершения и приема звонков. Они имеют персональные учетные записи, позволяющие настроить права доступа, переадресацию вызовов и другие персональные настройки в системе.

В данной статье Вы найдете подробную документацию по добавлению новых сотрудников в станцию, настройку их прав и профилей. Помимо этого, информацию про их дополнительные параметры.

Очереди вызовов в MikoPBX — это функция, позволяющая распределять входящие звонки между группой операторов, удерживая вызовы в очереди до момента, когда оператор станет доступен. Это обеспечивает эффективное управление большим потоком звонков и улучшает качество обслуживания клиентов.

В данной статье Вы найдете подробную документацию по созданию и настройке таких очередей.

Раздел «Маршрутизация» в MikoPBX — это интерфейс для настройки правил направления вызовов внутри телефонной системы. Здесь администраторы могут определить, как обрабатывать входящие и исходящие звонки, устанавливая условия и маршруты для эффективного распределения звонков между сотрудниками, отделами или внешними линиями.

Провайдеры телефонии в MikoPBX — это раздел системы, где настраиваются подключения к внешним операторам связи через интернет-протоколы для IP-телефонии. Здесь администраторы могут добавлять и настраивать учетные записи SIP-транков или других типов соединений, которые позволяют системе совершать и принимать звонки с городских и мобильных номеров.

В данной статье Вы найдете подробную документацию по подключению провайдеров к станции, их настройку и особенности.

Входящие маршруты в MikoPBX — это набор правил, определяющих, как система обрабатывает входящие звонки от внешних провайдеров телефонии. С их помощью администраторы могут настраивать направления вызовов в зависимости от различных условий, таких как номер вызывающего абонента, время суток или конкретный номер, на который поступил звонок. Это позволяет автоматически распределять входящие звонки на определенных сотрудников, отделы, IVR-меню или очереди вызовов. Настройка входящих маршрутов способствует оптимизации обработки вызовов и повышению качества обслуживания клиентов, обеспечивая гибкое и эффективное управление телефонными коммуникациями в компании.

Для получения уведомлений о пропущенных вызовах по электронной почте необходимо настроить SMTP-клиент. Подробная информация об уведомлениях в MikoPBX рассмотрена . В рамках данной инструкции будет рассмотрен пример настройки уведомлений о пропущенных вызовах для почтового сервиса Yandex.

1. Введем IP адрес АТС MikoPBX в браузере и перейдем в Система → Почта и уведомления.

Настройки SMTP клиента для сервиса Yandex:

Раздел «Дата и время» в MikoPBX — это интерфейс для настройки системных параметров даты и времени. Здесь администраторы могут установить текущую дату и время, выбрать часовой пояс и настроить синхронизацию с серверами точного времени (NTP). Корректная настройка даты и времени важна для точной регистрации событий, журналов вызовов и работы функций, зависящих от расписания, обеспечивая синхронизацию системы с другими сетевыми устройствами и сервисами.

Настройка производится в разделе «Система» - «Дата и время»:

Существует возможность установить время «вручную», без использования NTP сервера. По возможности, рекомендуем использовать автоматическое определение времени.

Для настройки времени вручную переключите тумблер "Корректировать время вручную"

Критическая уязвимость: через специально сформированную ссылку на прослушивание записей разговоров можно было скачать файл настроек АТС без ввода пароля. В этом файле хранятся пароли SIP-аккаунтов, пароль администратора и другие конфиденциальные данные.

Патч с исправлениями:

• Защита от подмены SQL-запросов к базе данных

• Защита от выполнения посторонних команд на сервере через загрузку файлов

Следуйте инструкциям шаг-за-шагом в том порядке, в котором они представлены для быстрой и успешной настройки системы.

Установка MikoPBX

MikoPBX - полноценная операционная система для вашего оборудования, не является отдельной программой. Поставляется в виде образа (файл *.iso, *.img, *.raw).

Она поддерживает многие способы установки:

• Установка на отдельный компьютер.

• Установка .

• Установка .

• Установка в .

Перейдите по ссылке к интересующему Вас способу установки и произведите её по данным инструкциям.

После установки Вам необходимо перейти в web-интерфейс MikoPBX для дальнейшей настройки системы. Для того, чтобы это сделать - найдите IP-адрес станции в консоли MikoPBX:

В данном примере - IP-адрес 172.25.233.36. Для перехода в web-интерфейс введите этот IP в адресную строку вашего браузера:

После первой авторизации, система попросит Вас поменять пароль.

Для стабильной работы АТС необходимо настроить сеть через раздел Сеть и Firewall → Сетевые интерфейсы. Ознакомится с подробной инструкцией по данным настройкам можно .

В MikoPBX все локальные подсети возможно описать в разделе Сеть и Firewall → Сетевой экран. Сетевой экран предназначен для ограничения доступа к станции по типу трафика и подсетям. Выполните настройку по .

Fail2ban блокирует IP адреса с нестандартной активностью, он способен снизить скорость неудачных попыток аутентификации, позволяет защитить Вашу АТС от взлома. Инструкцию, которая поможет в настройке можно найти .

После окончания первоначальной настройки АТС, Вы можете перейти к созданию учетных записей ваших сотрудников. В этом вам поможет .

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

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

Для создания правил маршрутизации Вам так же могут понадобиться следующие функции:

Маркетплейс позволяет расширить стандартный функционал системы с помощью модулей:

• Подробнее про Модули в MikoPBX Вы можете прочитать в .

• Про регистрацию в Маркетплейсе MikoPBX Вы можете прочитать в .

Конференции в MikoPBX — это функция, позволяющая организовывать групповые телефонные звонки с участием нескольких абонентов одновременно. Она позволяет проводить коллективные обсуждения, совещания и встречи по телефону, улучшая коммуникацию как внутри компании, так и с внешними партнерами.

Создание конференц-комнат

Список конференц-комнат располагается в разделе "Телефония" -> "Конференции".

Для создания новой конференц-комнаты нажмите кнопку Добавить конференцию.

Необходимо указать название конференции и ее внутренний номер, позвонив на который можно в эту конференцию зайти.

Для того чтобы в конференцию не могли зайти сотрудники, для которых это обсуждение не предназначено, можно защитить конференц-комнату паролем. Для этого заполните поле PIN-код. В это поле можно вводить только цифры, минимум одна цифра.

В этом случае для того чтобы попасть в данную конференцию сотруднику после набора номера конференции необходимо будет ввести пин-код.

• Все собеседники общаются только голосом (никаких других способов передачи информации, кроме речевого, не предоставляется);

• все собеседники могут говорить и слышать друг друга одновременно (то есть обеспечивается дуплексная связь);

• участники используют для общения телефоны (аппаратные или программные).

• Каждый участник конференции звонит на номер конференции. Первый участник слышит музыку на удержании до тех пор, пока к конференции не присоединится хотя бы еще один участник.

• Сотрудник может перевести своего собеседника в конференцию, реализовав перевод с помощью комбинации стар-кодов на своем телефоне. Перевести в конференцию можно как внутренний номер, так и внешний. Комбинация для переводов задается в разделе "Система" -> "Общие настройки" -> "Переводы вызовов". Пример: Сотрудник набирает комбинацию **1111 (комбинация для безусловного перевода) и его собеседник попадает в конференцию и становится её первым участником. У переводившего сотрудника вызов завершается, и, чтобы попасть в конференцию он звонит на номер конференции 1111.

Перезагрузка станции через интерфейс MikoPBX

Меню выключения/перезагрузки системы вы можете найти в MikoPBX в "Перезагрузка" -> "Обслуживание".

При открытии страницы будет отображен список активных звонков на АТС. Отображается дата начала звонка, «Кто» и «Кому» звонит.

• «Перезагрузить АТС» - команда начинает перезагрузку станции.

• «Выключение АТС» - завершает все процессы и отключает станцию.

Вы можете перезагрузить станцию через консольное меню. Для этого выберете раздел «[3] Перезагрузить систему».

Если вы хотите перезагрузить станцию: нажмите «[1] Перезагрузить MikoPBX».

Если вы хотите выключить станцию: нажмите «[2] Выключить».

В случае аварийной перезагрузки АТС (например, выключение электроэнергии) может потребоваться выполнить проверку диска на ошибки.

В консольном меню АТС введите команду «[9] Консоль(Shell)» и нажмите Enter

Система запустит консоль АТС.

Введите команду Reboot. Нажмите Enter

Система перезагрузится с проверкой диска.

Сетевой экран в MikoPBX — это интерфейс для настройки брандмауэра (Firewall) системы. Здесь администраторы могут создавать и управлять правилами фильтрации сетевого трафика, контролируя доступ к MikoPBX и защищая ее от несанкционированного доступа и сетевых угроз. Настройка сетевого экрана обеспечивает безопасность телефонной системы, предотвращая потенциальные атаки и обеспечивая стабильную работу в сетевой инфраструктуре организации.

В MikoPBX все локальные подсети возможно описать в разделе «Сеть и Firewall» → «Сетевой экран». Сетевой экран предназначен для ограничения доступа к станции по типу трафика и подсетям.

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

Общие настройки

Название - задайте произвольное имя для нового правила сетевого экрана. Справа от адреса подсети находится поле Маска подсети в формате 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 протоколу.

• У каждой подсети есть флаг «Это VPN или локальная сеть». При установке этого флага MikoPBX будет представляться всем локальным подсетям локальным IP, а не внешним.

• Флаг «Никогда не блокировать адреса из этой сети» следует включать только для доверенных подсетей. Если включен данный флаг, то правила защиты от взлома на данную подсеть не распространяются.

В Docker (bridge-режим) внутренние правила файрвола MikoPBX и fail2ban не защищают веб-интерфейс: контейнер не управляет iptables хоста, а HTTP-клиенты приходят со шлюза docker0. SIP-защита продолжает работать (UDP-DNAT сохраняет source IP).

Для защиты веб-интерфейса в Docker используйте один из двух подходов:

• network_mode: host для контейнера (если хост выделен под АТС);

• Внешний bouncer (CrowdSec-совместимый) поверх API MikoPBX — подробнее в разделе .

Загрузка образа

1. Скачайте актуальный образ системы с расширением .raw на сайте

2. Выполните авторизацию на портале https://vscale.io

3. Перейдите в раздел "Облако" - "Образы" - кликните по кнопке "Создать"
4. Выберите тип образа - "File" (п.1)

5. Формат образа - "raw" (п.3)

6. Операционная система - "Linux" (п.4)

7. Выберите файл для загрузки (п.2)

8. Кликните по кнопке "Создать" (п.5) и дождитесь завершения операции

1. Перейдите в раздел "Облако" - "Серверы" - кликните по кнопке "Создать"

2. Введите имя сервера

3. В поле "Флейвор" выберите конфигурацию сервера

4. Выберите загруженный ранее образ MikoPBX

После создания сервера можно перейти к его статусу в разделе "Облако" - "Серверы"

Пароль для входа в вэб интерфейс по умолчанию устанавливается в значение, равному "instance-id", на текущий момент нет возможности получить этот идентификатор из web интерфейса Vscale.

Для получения пароля от web интерфейса в перейдите на вкладку "Логи":

Теперь можно перейти по публичному адресу и начать настройку АТС.

Звуковые файлы в MikoPBX — это аудиозаписи, которые используются системой для воспроизведения различных сообщений, таких как приветствия, объявления, инструкции в IVR-меню или сигналы ожидания. Они позволяют персонализировать аудиоконтент, который слышат звонящие, улучшая взаимодействие с системой и предоставляя необходимую информацию.

Загрузка звукового файла на АТС

Звуковые файлы в MikoPBX используются в различных сценариях звонков и интерактивных голосовых меню (в IVR меню, в Нерабочем времени, в Очередях вызовов и для разных системных оповещений, а также В музыке на удержании) для воспроизведения голосового приветствия или оповещения клиента.

Список доступных звуковых файлов отображается в разделе "Телефония" -> "Звуковые файлы".

Для добавления нового звукового файла нажмите "Добавить звуковой файл".

Нажмите Загрузить и выберите звуковой файл.

Откорректируйте наименование файла при необходимости.

Сохраните изменения.

Пользовательские звуковые файлы хранятся на АТС по пути /storage/usbdisk1/mikopbx/media/custom. Музыка на удержании хранится в /storage/usbdisk1/mikopbx/media/moh.

Если клиент при звонке попадает в очередь или ожидает переадресацию, АТС проигрывает для него мелодию. Есть возможность загрузить свои мелодии для прослушивания во время ожидания. Это можно сделать на вкладке Музыка на удержании описанным выше способом.

Генерация SMTP токена

1. Для начала, перейдите в настройки своего аккаунта Proton (ссылка).

1. Далее перейдите в раздел "Proton Mail" -> "IMAP/SMTP".

1. Далее пролистайте до секции "SMTP submission". Нажмите "Generate token".

1. Введите произовольное название в поле "Token name" - MikoPBX в нашем случае, так же выберите Email address для которого Вы создаете токен.

Будет создан токен. Его параметры будут показаны один раз и когда Вы закроете окно, станут недоступны. Сохраните их, мы будем использовать их для дальнейшей настройки.

1. Перейдите в раздел "Система" -> "Почта и уведомления".

1. Перейдите в "Настройки SMTP". Заполните все необходимые параметры:

• Адрес отправителя - Ваш адрес электронной почты, под которым Вы генерировали токен.

• Имя отправителя - имя от которого отправляется почта.

• Тип аутунтификации - "Логин и пароль".

• SMTP логин - SMTP Username из окна с данными токена.

Нажмите "Сохранить".

Нажмите "Проверить подключение". Вы увидите следующее окно, подтверждающее правильность введенных данных:

Раздел «Система» в MikoPBX — это интерфейс для управления общими настройками и параметрами телефонной системы. Здесь администраторы могут настраивать основные системные параметры, управлять обновлениями, датой и другими функциями, обеспечивающими стабильную и безопасную работу MikoPBX. Этот раздел позволяет контролировать и оптимизировать работу системы на уровне всей инфраструктуры.

Общие настройки

В разделе «Общие настройки» в MikoPBX администраторы могут управлять основными параметрами системы, такими как настройки срока хранения записей разговоров, уведомления, параметры журналов, язык звуковых оповещений и многими другими системными опциями. Этот раздел обеспечивает контроль над общими функциями и поведением MikoPBX, позволяя оптимизировать работу системы под потребности организации.

Дата и время

Раздел «Дата и время» в MikoPBX — это интерфейс для настройки системных параметров даты и времени. Здесь администраторы могут установить текущую дату и время, выбрать часовой пояс и настроить синхронизацию с серверами точного времени (NTP). Корректная настройка даты и времени важна для точной регистрации событий, журналов вызовов и работы функций, зависящих от расписания, обеспечивая синхронизацию системы с другими сетевыми устройствами и сервисами.

Почта и уведомления

Раздел «Почта и уведомления» в MikoPBX позволяет настроить отправку системных уведомлений через электронную почту. Здесь администраторы указывают параметры SMTP-сервера, определяют события для уведомлений, такие как голосовые сообщения или системные ошибки, и редактируют шаблоны писем. Этот раздел помогает своевременно информировать пользователей и администраторов о важных событиях, обеспечивая эффективный контроль за работой системы.

Раздел «Доступ к AMI» в MikoPBX — это интерфейс для настройки доступа к Asterisk Manager Interface (AMI). Здесь администраторы могут управлять параметрами подключения к AMI, такими как включение или отключение доступа, указание логинов и паролей для аутентификации. Настройка доступа к AMI позволяет внешним приложениям или скриптам взаимодействовать с системой MikoPBX для мониторинга и управления звонками, расширяя функциональные возможности телефонной системы.

Раздел «Кастомизация системных файлов» в MikoPBX предоставляет администраторам возможность напрямую изменять или дополнять стандартные конфигурационные файлы системы. Здесь вы можете внести индивидуальные настройки, которые не доступны через стандартный веб-интерфейс, и адаптировать поведение системы под специфические требования вашей организации.

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

• Редактировать конфигурационные файлы: вносить изменения в существующие файлы или добавлять новые параметры.

• Переопределять стандартные настройки: изменять значения по умолчанию для определенных функций или модулей.

• Добавлять собственные скрипты или модули: расширять функциональность системы путем интеграции пользовательских решений.

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

Fail2ban включается вместе с Сетевым экраном переключателем в разделе Сеть и Firewall → Сетевой экран.

Сервис Fail2ban блокирует IP адреса с нестандартной активностью. При неудачной попытке авторизации в лог АТС попадет информация об ошибке, Fail2ban анализирует все неудачные попытки авторизации и считает их. Когда количество неудачных попыток авторизации превышает максимально допустимое количество, IP-адрес отправляется в бан.

Настройки защиты от взлома можно найти в боковом меню:

• Если происходит определенное число неудачных попыток входа "Количество попыток для блокировки" в течение определенного периода "В течение (секунд)", IP адрес будет заблокирован в течение заданного периода времени "Блокировать на (секунд)".

• Белый список адресов определяет IP - адреса, которые не будут заблокированы Fail2ban. Указывать можно как ip адрес 93.188.40.10, так и подсеть 93.188.40.0/24. В качестве разделителя используется «пробел».

• Обратите внимание, что если Вы в разделе «Сетевой экран» для подсети указали настройку «Никогда не блокировать адреса из этой сети», то подсеть автоматом попадает в белый список и добавлять ее вручную не требуется. Не нужно пытаться наполнять вручную список белых IP-адресов, желательно в исключительных случаях прописывать IP-адреса.

• Максимальное количество входящих пакетов SIP - опция позволяет ограничить количество пакетов с одного IP адреса в секунду. Если ограничение будет превышено, новые пакеты будут отброшены. Это может повысить устойчивость сервера к атакам.

Список заблокированных адресов показывает , какие IP-адреса в настоящее время заблокированы.

Так же вы можете разблокировать адрес кликом на соответствующую кнопку в таблице.

1. Выберите Действие / Создать / Виртуальная машина

2. На вкладке Укажите имя и местонахождение введите имя виртуальной машины, например mikopbx-vm

1. Перейдите к следующей вкладке Укажите поколение, выберите поколение - Поколение 1

Авторизуйтесь в сервисе Amazon Web Services

Приступим к настройке

1. Откройте Services / Compute / EC2 и перейдите в раздел Images / AMI Catalog

2. На открытой вкладке в поисковой строке введите MikoPBX

Авторизуйтесь на платформе

MikoPBX в Google Cloud Маркетплейс:

Приступим к настройке

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

Если сервисной учетной записи нет, создайте и добавьте ей нужные роли

1. Откройте Navigation menu / Products & solutions / Management / IAM & Admin

В данной инструкции мы пошагово произведем установку MikoPBX с помощью облачной платформы DigitalOcean.

Перед началом Вам необходимо скопировать ссылку на актуальный образ MikoPBX с расширением .raw. Сделать это можно на .

1. Перейдите в "Manage" -> "Backups & Snapshots"

1. Перейдите в "Custom Images" -> "Import via URL":

В данной инструкции мы пошагово произведем установку MikoPBX с помощью облачной платформы Selectel.

Перед началом вам необходимо скачать актуальный образ MikoPBX с расширением .raw. Сделать это можно по .

1. Перейдите в раздел Облачная платформа -> Образы.

1. Нажмите "Создать образ".

«Нерабочее время» в MikoPBX — это инструмент для настройки правил обработки вызовов в периоды, когда компания не работает, например, ночью, в выходные или праздничные дни. С его помощью администраторы могут определить, как система будет обрабатывать входящие звонки в нерабочие часы: перенаправлять на автоответчик, воспроизводить специальные голосовые сообщения или переадресовывать вызовы на мобильные номера дежурных сотрудников. Это позволяет обеспечить корректное взаимодействие с клиентами вне рабочего времени и поддерживать высокий уровень обслуживания.

Чтобы добавить новое правило нажмите на кнопку Добавить интервал времени.

Откроется форма создания нового правила.

В ней есть возможность указать:

Необходимо создать специальный пароль для входа в почтовую программу. С обычным паролем от почты войти не получится. Чтобы создать такой пароль, к почте должен быть привязан телефон. Перейдите в и проверьте, привязан ли он. Если нет — привяжите.

1. Откройте . В левом нижнем углу перейдите в "Настройки" → "Все настройки" → "Безопасность" → "."

1. Нажмите Создать.

Создание виртуальной машины

1. Создаем новую виртуальную машину.

1. После скачивания последней версии образа (ссылка), указываем ISO файл с установочным дистрибутивом.

Нажимаем "Continue"

1. Выбираем тип операционной системы Other Linux 5.x and later kernel 64-bit

Нажимаем "Continue"

1. Выбираем тип биоса Legacy

Нажимаем "Continue"

1. Нажимаем "Finish"

1. После создания виртуальной машины, дождитесь ее загрузки

1. Перейдите в раздел "[3] Reboot the system"

1. Выберите "[2] Shutdown"

1. После выключения виртуальной машины, перейдите в настройки

1. Выберите "Add device"

1. Выберите "New Hard Disk"

Нажмите "Add..."

1. Выберите размер жесткого диска(мы рекомендуем не менее 50ГБ)

Нажмите "Apply"

1. Запустите виртуальную машину

1. Выберите пункт "[8] Install"

1. Введите имя диска, на который будет установлена MikoPBX

В нашем случае - sdb, введите его название и нажмите Enter

1. Подтвердите выбор диска: введите y

1. Выберите диск для записи разговоров

В нашем случае - sdc, введите его название и нажмите Enter

1. Система перезагрузится и MikoPBX будет готова к использованию.

1. В АТС отображается IP адрес станции, по которому к ней можно подключится

1. Введите IP адрес станции в строку браузера и у вас откроется меню входа в MIkoPBX

Логин и пароль по умолчанию - "admin"

В данной иснтрукции будет произведена установка на UTM. Перед ее началом скачайте файл образа диска с расширением ".iso". Сделать это можно по ссылке.

Создание виртуальной машины

1. Перейдите в UTM. Нажмите "Create a New Virtual Machine" для создания новой виртуальной машины.

1. В качестве типа виртуальной машины выберите "Virtualize".

1. В качестве типа операционной системы выберите "Preconfigured" - "Linux".

1. Выберите ранее загруженный файл образа диска в разделе "Boot ISO Image". Для этого нажмите на "Browse...".

1. Далее укажите характеристики Вашей виртуальной машины. В нашем случае будут использованы 2 ГБ ОЗУ и 2 ядра процессора.

1. Далее укажите размер для системного диска. В нашем случае - 1 Гб.

1. Нажмите Continue.

1. Будет отображена итоговая конфигурация виртуальной машины. Задайте ей желаемое имя (поле "Name"). И нажмите "Save".

1. Перейдите в настройки ВМ. Для этого нажмите правой кнопкой мыши по её названию, далее "Edit".

1. Перейдите в "Drives". Нажмите "New..."

1. Создайте новый диск со следующими параметрами:

• Interface - VirtlO

• Size - не менее 50Гб (в этой документации для тестовой машины будет использовано 10Гб)

Нажмите "Create".

1. Запустите виртуальную машину.

1. После загрузки Вы увидите надпись PBX is running in Live or Recovery mode. Это означает, что система загружена из образа диска в Live режиме. Необходимо произвести установку системы. Для этого перейдите к разделу "[8] Install on Hard Drive".

1. Выберите диск для установки системы. В нашем случае доступны диски vda и vdb, для установки выбираем диск vda.

1. Подтвердите выбор: введите "y" с клавиатуры и нажмите Enter.

1. Далее выберите диск для хранения записей разговоров. В нашем случае единственный оставшийся размером 10 Гб.

После этого система будет перезагружена и доступна в обычном режиме (надпись "PBX is running in Live or Recovery mode" пропадет).

Введите этот IP-адрес в строку браузера для перехода в Веб-интерфейс.

В данном разделе необходимо создать правила и шаблоны распределения входящих звонков для созданных в MikoPBX провайдеров. Правила входящих звонков описывают маршрут звонка с момента его поступления в АТС до момента его завершения. Вы можете создавать неограниченное количество правил входящей маршрутизации. Для одного провайдера можно создать несколько правил.

Приоритет правил маршрутизации и маршрут по умолчанию

Правила располагаются в списке в порядке их приоритета. Если за указанный в правиле интервал времени никто не ответит на входящий вызов, то вызов направится на следующее по приоритету правило. Правила можно перемещать в списке вверх-вниз, то есть изменять их приоритет, перетаскивая их за стрелки.

Если ни по одному из правил на звонок не ответили, применяется входящий маршрут по умолчанию.

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

• Воспроизвести сигнал занято - клиент будет воспроизведен сигнал занято и входящий вызов будет завершен;

• Положить трубку;

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

Для одного провайдера можно описать несколько входящих маршрутов.

Сперва вызов идет по верхнему маршруту. Если клиент не дозвонился, то вызов идет по нижнему правилу (более низкий приоритет). Если клиент не дозвонился и по второму маршруту, то вызов идет по маршруту по умолчанию.

Чтобы добавить новое правило входящей маршрутизации нажмите на кнопку Добавить новое правило.

В поле Заметка опишите маршрут, который хотите реализовать. В дальнейшем это поможет вам в отладке схемы звонка.

Выберите Провайдера, для которого создаете новый шаблон распределения входящих звонков.

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

Голосовое приветствие - необязательное поле, допускается выбрать медиа файл для воспроизведения звонящему.

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

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

Если спустя указанный интервал времени никто не ответит на входящий вызов, то вызов направится на следующее по приоритету правило.

IVR меню в MikoPBX — это интерактивное голосовое меню, которое позволяет звонящим взаимодействовать с телефонной системой с помощью тонового набора (DTMF). Оно автоматически направляет вызовы к нужным отделам или сотрудникам, улучшая эффективность обработки звонков и повышая качество обслуживания клиентов.

Предварительная настройка

Перед созданием IVR меню необходимо загрузить звуковые файлы, которые будут проигрываться клиенту при звонке в Вашу компанию. Звуковые файлы добавляются в разделе Телефония → Звуковые файлы

Также есть возможность записать файл с помощью микрофона, если с АТС соединиться по https.

Создание IVR-меню

Перейдите в Телефония → IVR меню.

Нажмите Создать новое IVR меню. Задайте наименование IVR меню, номер и при необходимости комментарий. Выберите звуковой файл, который вы загрузили на предыдущем этапе.

Настройте Действия при донаборе. В первой колонке укажите цифру или комбинацию цифр, которую набирает абонент, а во второй выберите номер, куда будет направлен вызов.

Задайте Количество повторов перед переводом на номер по умолчанию.

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

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

Включите переключатель Разрешить набор любого внутреннего номера при необходимости.

Введите номер IVR меню, позвонив на который, можно на это IVR попасть.

Нажмите Сохранить.

• При звонке на голосовое меню (Номер IVR меню) начинает проигрываться звуковой файл Голосовое приветствие.

• Во время проигрывания голосового меню можно выбирать пункты меню или набирать внутренний номер сотрудника. За донабор внутренних номеров отвечает флаг Разрешить донабор любого внутреннего номера. Он разрешает набор внутренних номеров сотрудников с SIP-аккаунтом; переходы на очереди, IVR, конференции и другие направления настраиваются отдельными действиями при донаборе.

• После проигрывания голосового меню происходит ожидание в течение значения Таймаут ожидания ввода добавочного номера для набора добавочного. Общее время для набора номера = длительность звукового файла + таймаут ожидания ввода добавочного номера

Создание бакета

1. Перейдите в консоль Yandex Cloud (ссылка).

2. Перейдите в раздел "Все сервисы" -> "Object Storage".

1. Нажмите "Создать бакет".

1. Заполните следующие параметры для создаваемого бакета:

• Имя — укажите название бакета (в нашем примере - mikopbx-s3-storage). Имя должно быть уникальным в рамках всего Yandex Cloud.

• Макс. размер — задайте максимальный объём бакета. Рекомендуется установить значение, соответствующее вашим потребностям (не менее 50 ГБ для рабочей станции), чтобы контролировать расход облачного пространства. Если ограничение не нужно — отметьте «Без ограничения».

• Доступ — для всех трёх параметров (Чтение объектов, Чтение списка объектов, Чтение настроек) выберите значение «С авторизацией».

После заполнения всех параметров нажмите кнопку «Создать бакет».

1. Перейдите в раздел "Все сервисы" -> "Identity and Access Management".

1. Нажмите "Создать сервисный аккаунт".

1. Укажите следующие параметры:

• Имя — введите название сервисного аккаунта (например, mikopbx-s3-access).

• Роли в каталоге — нажмите «Добавить роль», в строке поиска введите storage и выберите роль storage.editor. Эта роль даёт необходимые права.

После заполнения параметров нажмите «Создать».

1. Перейдите в дашбоард созданного сервисного аккаунта, нажав на его название.

1. Нажмите "Создать новый ключ" -> "Создать статический ключ доступа".

6. Введите описание для создаваемого ключа и нажмите "Создать".

Будут отображены идентифкатор ключа и секретный ключ. Сохраните эти значения, они понадябтся позже для подключения хранилища к MikoPBX.

1. Перейдите во вкладку "Обслуживание" -> "Хранилище".

1. Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:

• Автоматическая загрузка записей в облачное хранилище — включите переключатель.

• URL точки доступа S3 — введите https://storage.yandexcloud.net

• Регион S3 — укажите регион Вашего аккаунта в Yandex Cloud, в этой инструкции - ru-central1

Настройте ползунок «Локальное хранение (режим S3)» — выберите, как долго записи будут храниться локально до удаления после выгрузки в облако.

Нажмите «Сохранить».

После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Подключено к S3» и начнется синхронизация записей телефонных разговоров.

Раздел «Хранилище» в MikoPBX позволяет контролировать использование дискового пространства и управлять настройками хранения данных. Здесь отображается подробная разбивка занятого места по категориям: записи разговоров, системные логи, резервные копии и другие файлы. Помимо мониторинга локального хранилища, раздел предоставляет возможность настроить автоматическую выгрузку записей в облачное хранилище S3.

Расположение раздела: "Обслуживание" -> "Хранилище".

Информация о хранилище

На вкладке «Информация о хранилище» отображается общая картина использования дискового пространства.

В верхней части страницы находится блок с горизонтальной диаграммой, которая наглядно показывает, какую долю от общего объёма диска занимает каждая категория данных.В примере занято 56.0 GB из 100.0 GB. Каждый сегмент диаграммы окрашен в свой цвет в соответствии с легендой:

• 🟠 Записи разговоров

• 🟣 История разговоров

• 🔵 Системные логи

• 🟢 Дополнительные модули

• 🩵 Резервные копии

• 🔴 Системные кеши

• ⚫ Прочие файлы

В нижней части страницы находится список категорий данных и количество памяти, которая каждая из них занимает.

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

• 30 дней (1 месяц) - минимальный период хранения.

• 90 дней (3 месяца) - рекомендуется для малого бизнеса.

• 1 год - для соблюдения требований законодательства.

• Бесконечно - хранить все записи без ограничений.

На этой вкладке настраивается автоматическая выгрузка записей разговоров во внешнее S3-совместимое хранилище (например: Amazon S3, Яндекс Cloud, VK Cloud).

В верхней части вкладки находится переключатель «Автоматическая загрузка записей в облачное хранилище» — он включает или отключает функцию выгрузки.

Для подключения к бакету необходимо заполнить следующие поля:

• URL точки доступа S3 — адрес сервиса хранилища (например, https://storage.yandexcloud.net для Yandex Cloud S3).

• Регион S3 — регион размещения бакета (например, ru-central1).

• Имя бакета S3 — название бакета, в который будут загружаться записи.

Нажмите "Сохранить" для сохранения настроек.

Далее нажмите кнопку «Проверить соединение» — система выполнит тестовое подключение и отобразит результат в верхней части страницы. При успешном подключении появится сообщение «Подключено к S3» и начнется синхронизация записей телефонных разговоров.

В нижней части вкладки расположен ползунок «Локальное хранение (режим S3)» — он определяет, как долго записи будут сохраняться локально на станции перед тем, как они будут выгружены в облачное хранилище и удалены со станции (локально). Срок локального хранения не может превышать общий срок хранения.

Для начала зарегистрируйтесь в сервисе Yandex Cloud.

Приступим к настройке

Создание виртуальной машины

1. Откройте Все сервисы / Инфраструктура и сеть / Compute Cloud

2. Перейдите в раздел Виртуальные машины

3. На вкладке выберите Создать ВМ

4. Введите имя виртуальной машины, например vm-mikopbx

5. Укажите зону доступности

1. Укажите параметры вычислительных ресурсов виртуальной машины, исходя из ожидаемой нагрузки на АТС и вашего бюджета. Для тестовой машины можно указать Гарантированная доля vCPU - 20%, RAM - 1 Гб

1. В разделе Выбор образа/загрузочного диска выберите Marketplace / Показать все продукты Marketplace / VoIP / MikoPBX IP АТС

2. В разделе Диски и файловые хранилища скорректируйте размер загрузочного диска до 1 Гб

1. В разделе Диски и файловые хранилища выберите Добавить диск

2. На открытой вкладке введите имя диска для хранения данных, например storage-mikopbx

3. Укажите тип диска HDD

4. Укажите размер диска не менее 50 Гб

1. В разделе Сетевые настройки выберите существующую или создайте новую облачную сеть

2. В поле Подсеть в выпадающем меню выберите Добавить подсеть

3. На открытой вкладке введите имя подсети, например local-mikopbx

4. В поле CIDR укажите диапазон адресов, например 172.16.32.0/24

1. Публичный адрес и Внутренний IPv4-адрес оставьте в положении Автоматически

1. В разделе Доступ укажите Сервисный аккаунт

2. Введите Логин и SSH-ключ, предварительно сгенерированный по

3. В разделе Дополнительные настройки установите флажок Разрешить доступ к серийной консоли

1. Завершив ввод значений, нажмите кнопку Создать ВМ

1. Дождитесь запуска созданной виртуальной машины, обычно первый запуск занимает 6-8 минут. Статус Running, еще не означает что система полностью развернулась

2. Откройте созданную виртуальную машину и перейдите в раздел Серийная консоль

1. Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

2. Для входа используйте указанные во вкладке Серийная консоль логин и пароль

Создание бакета и ключей

1. Перейдите в консоль DigitalOcean (ссылка).

2. Перейдите в раздел "Manage" -> "Spaces Object Storage". Нажмите "Create a Spaces Bucket" для создания нового бакета.

1. На странице создания бакета, в разделе "Choose a datacenter region", выберите ближайший к серверу MikoPBX регион. Выберите "Standart Storage".

1. В поле "Choose a unique Spaces Bucket name" укажите произвольное название для бакета.

Нажмите "Subscribe & Create Bucket".

1. Перейдите на страницу созданного бакета (нажмите на его название в разделе "Buckets").

1. Перейдите на вкладку "Settings".

1. Пролистайте до раздела "Access Keys". Нажмите "Create Access Key" для создания новой связки ключей.

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

• Select access scope - Limited Access.

• Buckets - выберите ранее созданный бакет.

• Permissions - Read/Write/Delete.

• Give this access key a name - укажите произвольное название для идентификации связки ключей.

Нажмите "Create Access Key".

Будет отображены значения связки ключей (Access Key ID и Secret Key). Сохраните эти значения, они понадобятся в будущем при настройке на стороне MikoPBX.

1. Перейдите во вкладку "Обслуживание" -> "Хранилище".

1. Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:

• Автоматическая загрузка записей в облачное хранилище — включите переключатель.

• URL точки доступа S3 — введите https://sgp1.digitaloceanspaces.com - замените sgp1 на Ваш регион.

• Регион S3 — укажите регион Вашего бакета в DigitalOcean, в этой инструкции - sgp1.

Настройте ползунок «Локальное хранение (режим S3)» — выберите, как долго записи будут храниться локально до удаления после выгрузки в облако.

Нажмите «Сохранить».

После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Соединение с S3 успешно» и начнется синхронизация записей телефонных разговоров.

REST API MikoPBX позволяет автоматизировать управление станцией и интегрировать её с внешними системами — CRM, helpdesk, корпоративными порталами и собственными сервисами. Для доступа к API используются API ключи.

Авторизация

Все запросы к REST API авторизуются через заголовок Authorization: Bearer <token>. MikoPBX поддерживает два типа токенов:

Для внешних интеграций всегда используйте API ключ — он создаётся вручную, имеет настраиваемые права доступа и может быть отозван в любой момент.

1. Перейдите в раздел «Система» → «API ключи».

1. Нажмите «Добавить API ключ».

• Заполните поле Описание (например: CRM Integration)

• Скопируйте сгенерированный API-ключ — он отображается только один раз

Важно: сохраните ключ сразу после создания. После закрытия страницы восстановить его невозможно — придётся создавать новый.

Придерживайтесь принципа минимальных привилегий — каждый ключ должен иметь доступ только к тем ресурсам, которые реально нужны.

При создании ключа доступны два варианта:

• Полные права доступа — ключ получает доступ ко всем ресурсам API на чтение и запись. Используйте только если это действительно необходимо.

• Ручная настройка — для каждого ресурса API отдельно указывается уровень доступа: только чтение, чтение и запись, или нет доступа.

Сетевой фильтр: выберите один из двух вариантов:

• Только локальные подключения — ключ будет работать только из локальной сети. Рекомендуется если интеграция работает внутри инфраструктуры.

• Разрешены подключения с любых адресов — ключ доступен без ограничений по IP. Используйте только если клиент находится за пределами локальной сети.

Соблюдение следующих требований защищает API от перехвата токенов и несанкционированного доступа:

1. Валидный SSL сертификат:

Используйте доверенный SSL сертификат на стороне сервера MikoPBX. Самый простой способ — выпустить бесплатный сертификат через модуль Let's Encrypt (инструкция по работе с модулем находится ).

Работа без валидного сертификата допустима только в изолированной тестовой среде без доступа из интернета.

1. Доверие к сертификату на стороне клиента:

Клиент обязан проверять сертификат сервера при каждом запросе. Отключение проверки (verify=False в Python, -k в curl) недопустимо в production: без неё возможна атака типа «человек посередине» (MITM), при которой злоумышленник перехватывает Bearer-токен в открытом виде.

1. Ограничение прав (scope) ключа:

Каждый ключ должен иметь доступ только к тем ресурсам, которые реально используются интеграцией. Не используйте «Полные права доступа» без необходимости — компрометация такого ключа даёт атакующему полный контроль над API.

1. Ограничение сетевого доступа:

Если интеграция работает внутри локальной сети — выбирайте «Только локальные подключения». Это исключает возможность использования скомпрометированного ключа из внешней сети.

Вариант «Разрешены подключения с любых адресов» используйте только когда клиент физически находится за пределами локальной сети, и убедитесь что остальные меры безопасности соблюдены — валидный SSL сертификат и минимальные права ключа.

Нажмите на карточку для перехода:

Раздел «Почта и уведомления» в MikoPBX позволяет настроить отправку системных уведомлений через электронную почту. Здесь администраторы указывают параметры SMTP-сервера, определяют события для уведомлений, такие как голосовые сообщения или системные ошибки, и редактируют шаблоны писем. Этот раздел помогает своевременно информировать пользователей и администраторов о важных событиях, обеспечивая эффективный контроль за работой системы.

Общие настройки

• Использовать оповещения - позволяет включить/отключить все оповещения на email, включая голосовую почту.

• Отправлять уведомления о пропущенных вызовах - позволяет включить/отключить уведомления о пропущенных вызовах.

• Единый Email для уведомлений о пропущенных вызовах - общий адрес электронной почты для отправки уведомлений о пропущенных внешних вызовах (если у сотрудника не указан email, используется этот общий адрес).

• Отправлять уведомления о голосовых сообщениях - позволяет включить/отключить уведомления о голосовых сообщениях.

• Единый Email для уведомлений о голосовых сообщениях - общий адрес электронной почты для отправки уведомлений о голосовых сообщениях (приоритет: 1. Личный email сотрудника; 2. Указанный email в этом поле)

• Отправлять уведомления о входах в систему - позволяет включить/отключить уведомления о входах в систему.

• Отправлять системные уведомления - позволяет включить/отключить отправку системных уведомлений.

• Email системного администратора - адрес, на который будут отправляться системные уведомления.

• Адрес отправителя, Имя отправителя - от имени этого адреса и имени будут отправляться электронные письма.

• Тип аутентификации:

  • Логин и пароль - классический тип аутентификации при подключении к SMTP-серверу, при котором используется адрес почтового ящика (логин) и пароль от него. Все параметры (сервер, порт, шифрование, логин и пароль) вводятся и хранятся вручную

• SMTP логин, SMTP пароль - параметры авторизации.

• SMTP хост - адрес почтового сервера.

• SMTP порт - порт почтового сервера.

• Тип шифрования:

• SMTP логин - параметры авторизации.

• Провайдер OAuth2 - почтовый сервис, через который выполняется OAuth-аутентификация (например, Microsoft/Outlook, Google/Gmail).

• Идентификатор приложения (Client ID) - уникальный идентификатор приложения, созданного в панели управления выбранного OAuth-провайдера. Используется для того, чтобы провайдер понимал, какое именно приложение запрашивает доступ к почтовому ящику.

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

• Аутентификация по логину и паролю:

• Аутентификация oAuth2:

Создание приложения в Yandex

1. Авторизуйтесь в Ваш аккаунт Яндекс и далее перейдите на страницу создания приложения. Нажмите "Создать".

1. В диалоговом окне выберите опцию "Для атворизации пользователей". Нажмите "Перейти к созданию".

1. Далее заполните необходимую информацию:

• Название - произвольное.

• Иконка сервиса - произвольное изображение.

• Почта для связи - почта на которую будут приходить уведомления об авторизации.

Нажмите "Продолжить".

1. Далее выберите в качестве платформы "Веб-сервисы". В поле "Redirect URl" вставьте следующую ссылку:

Замените 192.168.100.60 на ip-адрес Вашей станции.

Нажмите "Продолжить".

1. Далее на странице "Права доступа к данным пользователей" в разделе "Дополнительные" впишите "smtp" и выберите доступ "Отправка писем через Яндекс.Почту по протоколу SMTP".

1. На следующей странице нажмите "Всё верно, создать приложение".

После создания приложения будет выведены ClientID и Client Secret. Далее они понадобятся нам для настройки внутри web-интерфейса MikoPBX.

1. Перейдите в Web-интерфейс MikoPBX. Далее "Система" -> "Почта и уведомления" -> "Настройки SMTP".

Заполните все необходимые данные:

• Адрес отправителя, Имя отправителя - Ваша почта и от какого имени будут отправляться письма.

• Тип аутентификации - OAuth2.

• SMTP логин - Ваша почта.

• Провайдер OAuth2 - Yandex Mail.

Все остальные настройки оставьте по умолчанию. Более подробное описание Вы можете найти в главное статье о параметрах почты ().

После этого нажмите "Сохранить"!

1. Нажмите "Подключить через OAuth2". Войдите в Ваш аккаунт Яндекс. После авторизации, нажмите "Log in as...".

1. При успешной авторизации Вы увидите соответствующее окно.

1. Создаём новую виртуальную машину

2. Указываем Имя, Тип и Версию виртуальной машины, как показано на изображении ниже.

Для начала зарегистрируйтесь в сервисе .

Приступим к настройке

1. Откройте Все сервисы / Инфраструктура и сеть / Compute Cloud

2. Перейдите в раздел Виртуальные машины

3. На вкладке выберите Создать ВМ

Для начала авторизуйтесь на сайте

Приступим к настройке

1. Откройте Виртуальные сети / Сети

2. На вкладке Сети выберите Создать

3. Введите имя новой сети, например pbx_network

Для начала авторизуйтесь на сайте

Приступим к настройке

1. Откройте Виртуальные сети / Сети

2. На вкладке Сети выберите Создать

3. Введите имя новой сети, например pbx_network

История вызовов в MikoPBX — это журнал, который сохраняет информацию о всех входящих и исходящих звонках через систему. Она предоставляет детальные данные о каждом вызове, включая время, длительность, номера участников и статус, что позволяет анализировать коммуникации и оптимизировать работу телефонной сети компании. Располагается в разделе "Телефония" -> "История вызовов".

История вызовов в MikoPBX позволяет:

• Отобразить все вызовы;

Docker-контейнер MikoPBX не обновляется файлами .img или .iso. Для перехода на новую версию нужно скачать новый Docker image и пересоздать контейнер, сохранив каталоги /cf, /storage, сетевые параметры и переменные окружения.

1. Создайте резервную копию настроек MikoPBX. Если модуль резервного копирования недоступен в непривилегированном контейнере, подготовьте резервное копирование каталогов или volumes на стороне Docker-хоста.

Эта инструкция подходит для MikoPBX, установленной как полноценная виртуальная машина в VMware, VirtualBox, Hyper-V, KVM, Proxmox VE и других гипервизорах.

Для такой установки доступны два способа обновления:

• через web-интерфейс — основной и наиболее удобный способ;

• с ISO-образа — резервный способ, если web-интерфейс недоступен или требуется восстановление системы.

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

Подробные инструкции по настройке и эксплуатации каждого модуля вы можете найти .

Найти раздел Управления модулями вы можете в "Модули" -> "Маркетплейс модулей".

В данном разделе происходит основное управление модулями: их подключение, настройка, а так же загрузка своих, "кастомных" модулей. Документацию по разработке своих модулей вы можете найти .

Все установленные модули находятся в списке, в одноимённой вкладке:

Есть возможность загрузить свой модуль, используя кнопку "Загрузить новый модуль". Необходимо загружать файлы .zip. После загрузки модуль появится в списке на вкладке "Установленные модули

Регистрация в Маркетплейсе MikoPBX не влияет на базовый функционал системы. Вы можете использовать MikoPBX для работы со звонками без регистрации и установки дополнительных модулей. Однако, Мы рекомендуем пройти процедуру регистрации в маркетплейсе для получения возможности расширения функционала системы.

Регистрация даст вам доступ к дополнительным модулям и расширениям. Есть бесплатные модули, который мы вынесли из базового функционала для упрощения первоначальной настройки, а также платные модули от нас и других разработчиков. Если вы разработчик, то можете связаться с нами, написав на почту developers@mikopbx.com для получения инструкций о том, как разработать собственный модуль и добавить его в Marketplace.

Для начала регистрации в маркетплейсе вам необходимо перейти во вкладку "Модули" -> "Маркетплейс модулей":

В случае, если у Вас не выполнена регистрация в Маркетплейсе, раздел будет выглядеть вот так:

Нажмите синюю кнопку "Регистрация в маркетплейсе" для начала регистрации:

Asterisk Manager Interface (AMI) - мощный и удобный программный интерфейс (API) Asterisk для управления системой из внешних программ. Благодаря AMI внешние программы могут осуществлять соединения с Asterisk посредством TCP протокола, инициировать выполнение команд, считывать результат их выполнения, а так же получать уведомления о происходящих событиях в реальном времени. AMI часто используют для интеграции с бизнес-процессами и системами, программным обеспечением CRM (Customer Relationship Managment — управление взаимодействия с клиентами). Управление Asterisk часто осуществляется из консоли CLI, но при использовании AMI не требуется прямой доступ к серверу, на котором запущен Asterisk. AMI — это наиболее простой инструмент, который в руках разработчика может оказаться очень мощным и гибким средством для интеграции с другими программными продуктами. Он дает возможность разработчикам использовать информацию, генерируемую Asterisk, в реальном масштабе времени.

Первое что необходимо сделать, это включить AMI и завести пользователя, с помощью которого клиентская программа будет аутентифицироваться. «Система» - «Доступ к AMI»

Для добавления новой учетной записи необходимо указать Имя пользователя и Пароль. Кроме того, необходимо задать Сетевой фильтр, т.е. из какой подсети разрешено подключение к пользователю AMI. Вы можете разрешить подключения с любых адресов, либо указать конкретную сеть, настройку который Вы произвели в разделе