Additional modules allow you to expand the functionality of the main system. In this guide, you will find information on managing modules and installing applications using the built-in Marketplace.

Detailed instructions for configuring and operating each module can be found here.

You can find the Module Management section under "Modules" -> "Marketplace of modules".

Installed Modules

This section allows you to manage modules: connecting them, configuring them, and uploading your own custom modules. Documentation on developing your own modules can be found here.

All installed modules are listed under the tab of the same name:

You can upload your own module using the "Upload New Module" button. You need to upload .zip files. After uploading, the module will appear in the list under the "Installed Modules" tab.

You can also access the settings of any module for further configuration:

Additionally, you can enable or disable a module.

From the interface of an installed module, you can quickly access its documentation by clicking on the question mark to the right of the module's short description:

Quick Access to Modules

You can add any module to the sidebar menu for quick access, which can be useful if you need constant access to the module's settings to change parameters or its status.

To do this, follow these instructions:

1. Go to the settings of the module you want to add to the sidebar menu by clicking on the edit icon to the right of the module's version:

1. Click on the settings icon to the right of the module's status to access the display settings for the module in the sidebar menu:

1. In this section, you can:

• Toggle the display of the module in the sidebar menu—"Show module in sidebar menu".

• Choose the section where it will be displayed—in the example, the "Modules" section is selected.

• Specify a custom name for the module if desired.

After completing the settings, click "Save".

Marketplace

In this section, you can install modules from MIKO as well as from partner developers.

Each module has a button for downloading and installing it. Basic information about the module with a short description is also displayed here.

To the left of the module's name, you can find an icon indicating whether it is paid or free. For example, in the image above, the "Access Control Management" module is paid, while the "Backup&Recovery module" module is free.

Module Card

You can access a module's detailed page by clicking on its name in the Marketplace interface.

Here you can find the version of the current release, information about the developer, and whether the module is paid or free. There are also three sections:

Module Description

This section contains images illustrating the module's functionality and settings. Additionally, there is a basic description of the module and a "Useful Links" section with a link to detailed documentation on configuring and operating the module.

Version History

In this section, you can find the module's version history with detailed descriptions of changes, as well as the minimum compatible version of MikoPBX for proper operation. You can also install a specific version of the module by clicking on the blue link under its description.

Activating Coupons

If you purchase a module, you will receive a coupon. To activate it, go to Modules -> Marketplace of modules:

Then navigate to the "License Management" section.

In the "Activate Coupon" field, enter your coupon code and click "Activate Coupon"

General Information

Registering in the MikoPBX Module Marketplace is not required for the system’s basic functionality. You can fully utilize MikoPBX for handling calls without registration or installing additional modules. However, we recommend registering in the marketplace to expand your system’s capabilities.

Registration gives you access to additional modules and extensions. These include both free modules (moved out of the core system for easier initial setup) and paid modules from us and third-party developers. If you are a developer, you can contact us at [email protected] to get instructions on creating and adding your module to the Marketplace.

To begin the registration process, navigate to "Modules" -> "Marketplace of modules":

If you are not registered in the Marketplace, the section will look as follows:

Registration Process

To start the registration process, click the Register in Marketplace button:

The license key stores all your licenses for MikoPBX products. If you already have a key, you can enter it in the corresponding field. If you've forgotten your key, search your email inbox for messages from [email protected]

If you don’t have a key, you can generate a new one by completing the registration form:

• Organization Name – Enter your company/organization name.

• Contact Email – Enter your organization’s email address.

• Contact Person – Enter the name of the contact person.

• Contact Phone (optional) – Provide a contact number.

• Unique Company Identifier (e.g., Tax ID, VAT) (optional).

Click Register.

Upon successful registration, you will see the following screen:

• A notification confirming the system's registration.

• The license key field will display a blurred value by default. Hover over it to view or copy the key.

License Management

To manage your license, go to Marketplace -> License Management and click the corresponding option:

You will be redirected to the SaaS Licensing Server:

Enter your license key in the Enter your license key or activated coupon field and click Login:

You will access a system with nine sections:

Go to the Session monitor section:

In the Info column, click the i button for each binding to view detailed host information.

In the Action column, use the Drop button to unbind the license from the current host.

Potential Issues

Registration Issues

If you encounter issues during registration, check for internet access to the MikoPBX server. Ensure connectivity to lic.miko.ru and lic.mikopbx.com over port 443 (HTTPS). Verify firewall settings and network permissions.

Strikethrough Key Icon

MikoPBX periodically connects to licensing servers to verify installed modules. If a module license becomes unavailable, the module will be disabled, and a strikethrough key icon will appear next to its name.

Application dialplans are programmable voice applications in PHP and Asterisk Dialplan.

MikoPBX comes with several pre-configured applications. With some basic knowledge of Asterisk dialplan, you can easily create additional applications. Like a phone extension, applications can have an internal number assigned in the settings.

Below you will see a description of the basic applications included in MikoPBX:

Creating applications

MikoPBX applications are created from several plans of the Asterisk application suite. There are many examples of ready-to-run applications in the system. To add a new MikoPBX application, click on "Add a New" in the application menu.

In just a few steps, you can create your own applications. First, define the Name and Call Number for the application, and optionally fill in the Comment field.

Possible application code types:

• PHP-AGI script - AGI is an embedded method in Asterisk for executing external scripts (similar to CGI for HTTP servers), which can extend Asterisk's functionality using other programming languages, particularly PHP. AGI scripts can control call handling in the dialplan and are invoked from the extensions.conf file.

• Asterisk Dialplan - The configuration of the dialplan is contained in the Asterisk configuration file called extensions.conf. This is one of the most important configuration files where the processing and routing of incoming and outgoing calls are defined. This file governs the behavior of all connections passing through your PBX (Private Branch Exchange).

Let's clarify: we will refer to MikoPBX applications as "applications" and Asterisk dialplan functions as "functions". For example, Answer(), NoOP(), Set(), and Wait() are functions. These are individual target functions in Asterisk that are then combined in MikoPBX to create more powerful MikoPBX applications.

Describe the logical operations in the text field of the Programme Code. Please note that only one command is allowed per line, for example:

The figure shows an example of the simplest application for the number 000063. After dialing the number, you will hear the robot voice your internal number.

Description of Asterisk functions that you can use in your applications: