1 of 20

Scenarios and cases

Generate extensions by REST API

Example of using REST API to generate employees

In release 2023.2, an API for quickly creating a large number of employees was implemented. During testing, we described the algorithm for generating new employees in ChatGPT and conducted stress testing for creating 700 random accounts in different languages. It took about 1 minute to complete the load test, and it was successful.

To perform this task, a request to ChatGPT was written with the following content.

{"jsonapi":{"version":"1.0"},
    "result":true,
    "data":
        {
            "type":"SIP",
            "show_in_phonebook":"1",
            "is_general_user_number":"1",
            "public_access":"0",
            "number":"275",
            "user_id":"",
            "user_avatar":"",
            "user_username":"",
            "user_email":"",
            "mobile_uniqid":"EXTERNAL-7870338E",
            "mobile_number":"",
            "mobile_dialstring":"",
            "sip_uniqid":"SIP-PHONE-5A230111",
            "sip_secret":"Nk9oOFI2ZXdDMEU9",
            "sip_type":"peer",
            "sip_qualify":"1",
            "sip_qualifyfreq":60,
            "sip_enableRecording":"1",
            "sip_dtmfmode":"auto",
            "sip_transport":" ",
            "sip_networkfilterid":"none",
            "sip_manualattributes":"",
            "fwd_ringlength":45,
            "fwd_forwarding":"",
            "fwd_forwardingonbusy":"",
            "fwd_forwardingonunavailable":""
        },
    "messages":[],
    "function":"getRecord",
    "processor":"MikoPBX\\PBXCoreREST\\Lib\\Extensions\\GetRecord::main",
    "pid":42448,
    "meta":{
        "timestamp":"2023-09-06T08:51:51+03:00",
        "hash":"a16f973985cb3d0cbe75abb2c10a7c39b2203a87"
        }
}

If the result parameter in the response is true, we will take the data for creating a new user from the data parameter and make a POST request to the address http://127.0.0.1:8081/pbxcore/api/extensions/saveRecord, using the modified array of form fields in x-www-form-urlencoded format.

The script should be written in Python without using NodeJS and should allow creating 100 different employees. In the user_username field, enter the name and surname of a random person so that national alphabets are used. In the user_email field, enter any email address. In the mobile_number field, enter random mobile phone numbers, only digits, without duplicates. In the fwd_forwarding and fwd_forwardingonbusy fields, fill in with mobile_number values.

When creating an employee, print user_username, user_email, and number to the console and report the result.

If the result of the saveRecord or getRecord request is false, also print the messages parameter from the received response. If the response results in an error of another type or cannot be parsed, print the complete text received from the API server to the console.

As a result, a Python script was generated that allowed us to perform this test.

Save file content in /tmp/CreateRandomExtensions.py and run in with the following approach.

As a result of the script's execution, you will see a list of created employees in the console, and new user accounts will appear in the web interface.

It's important to note that since the system is read-only, you need to install Python libraries after each reboot, and the /tmp folder will be cleared. Development and refinement of the script should be done in an external system.

When making REST API requests from external addresses, it's necessary to authenticate with an administrative username and password or create a user with the necessary permissions in the employee rights management module and authenticate with it.

When making requests, as in this example, from the address 127.0.0.1, no authentication is required.

Missed Call Telegram Notifications

This article describes two ways to implement Telegram notifications for missed calls.

Dialplan-Based Example

on working with a Telegram bot using curl.

Go to the "System File Customization" section:

Open the "extensions.conf" file for editing. Set the mode to "Append to the end of the file" and insert the following context:

[add-trim-prefix-clid-custom]
exten => _[0-9*#+a-zA-Z][0-9*#+a-zA-Z]!,1,NoOp(start check blacklist)
	same => n,Set(CHANNEL(hangup_handler_push)=hangup-ext-queues,h,1);
	same => n,Return()

[hangup-ext-queues]
exten => h,1,ExecIf($["${M_DIALSTATUS}" = "ANSWER"]?return)
    same => n,Set(TOKEN=5118292900:AAEWCOAXkay5fXb8AJptZmDyqkNk8QbP200)
    same => n,Set(CHAT_ID=939950800)
    same => n,Set(URL=https://api.telegram.org/bot${TOKEN}/sendMessage)
    same => n,Set(TEXT=MISSED CALL from: ${CALLERID(name)}, did: ${FROM_DID}, callid: ${CHANNEL(callid)})
    same => n,SHELL(curl -s -X POST '${URL}' -d chat_id='${CHAT_ID}' -d text='${TEXT}')
    same => n,Set(MISSED=${SHELL(curl -s -X POST '${URL}' -d chat_id='${CHAT_ID}' -d text='${TEXT}')})
    same => n,return

In this context, replace:

TOKEN with your Telegram bot’s token.
CHAT_ID with the chat ID where messages should be sent.

Save your changes.

Go to "modules.conf" for editing. Set the mode to "Append to the end of the file" and insert the following line:

Save your changes.

Go to "Dialplan Applications" and create a new application by clicking "Add a new":

Provide the following parameters for the dialplan:

Name – any name
Number to Call the Application – any number
Code Type – "PHP-AGI script"

Go to the "Program Code" tab and insert the following PHP-AGI script:

In this context, replace:

API_KEY with your Telegram bot token.
CHAT_ID with the chat ID where you want to send the message.

You can modify the notification text in the $TEXT variable.

After saving the script, copy its identifier from the browser’s address bar, which looks like "DIALPLAN-APP-1B2B846E":

Go to "System file customization":

Open "extensions.conf" for editing. Set the mode to "Append to the end of the file" and insert the following context:

Save your changes.

Call the company from your mobile and dial an extension to call a third-party company

This functionality is convenient for mobile employees. When it is important that the conversation is recorded and recorded on the PBX in the call history. When it is not possible to use a softphone / or "IP-SIM".

Add a new dialplan application (see )

Assign an internal number, for example 2200109

Sending an incoming fax to email

Add a new dialplan application (see Dialplan Applications).

Assign an internal number, for example, 2200110.

Insert the following code into the "Programme Code" tab:

Go to the "System file customization" section.

Open the "extensions.conf" file for editing.

Add the folowwing code to the end of file:

Replace "2200100" with the number of your application.

In the code, replace "SIP-1687941868" with your provider's ID. You can find it in the provider's card in the browser's address bar.

Open the "modules.conf" file for editing.

Add the following code to the end of the file:

In the provider's card, in the advanced settings, in additional parameters, specify:

Customer's assessment of the quality of service

Improving the quality of the organization's service is an extremely important component of the successful operation of the company. The mechanism for evaluating the work of an operator will be useful to any business.

In the current article, we offer an example of the implementation of the quality assessment mechanism by the client for PBX MikoPBX.

To begin with, let's add the logic of processing incoming calls:

Go to "Routing" → "Telephony Providers". Open the provider's account for editing. Copy in the address bar the ID of the provider through which subscribers call you to the company. Please note that in our example, the only provider Zadarma is used. If you have configured the connection of several providers, then the following steps must be performed for each provider.

Simulation of external calls

Configuring simulated external calls

A useful tool for configuring MikoPBX is to simulate incoming and outgoing external calls without connecting a real provider, thus saving costs.

Go to "Call Routing" → "Telephony Providers":

Add a new SIP Provider:

Disabling "off-hours" for VIP numbers

Connect providers registered on the same host as described in the instructions.
Go to System → System file customization

Open the extensions.conf configuration file for editing.

Set the "Add to end of file" mode. In the black window, add the following code snippet:

Registering multiple accounts from one provider

Instructions for connecting a provider account can be found .

Many telecom operators cannot offer multiple SIP numbers in a single trunk (as one provider account) and provide separate registration details for each number. For example, when using the provider Zadarma, to connect the phone number +60(3)-2293-042, you should use the login 847706 and password XXXXXX, while to connect the phone number +60(3)-6382-584, you should use the login 847900 and password YYYYYY. The host for both accounts will be the same: sip.zadarma.com.

Task: For each number, specific incoming routing needs to be configured. For example, calls to +60(3)-2293-042 should be routed to the sales department (call queue), while calls to +60(3)-6382-584 should be routed to an IVR menu.

Potential Issue: The issue is that all incoming calls will go through the first Zadarma provider account defined in MikoPBX. Calls from the second provider will never be routed through MikoPBX.

Solution

In the Routing → Telephony Providers section, create two provider accounts from the same service provider. In our example, this is Zadarma. Enter the correct login, password, and host.

In the advanced options, specify:

In the Routing → Incoming routing section, set up an incoming call rule for each provider. In the Direct inward dialing number field, enter the login from the provider account. In the Provider field, select Provider-independent...

Setting up individual non-working hours for several providers on one host

Task

We have two accounts from the Zadarma provider, configured in MikoPBX following this guide.

Each Zadarma number needs to have its own non-working hours. For example, the number +60 17 308 9237 has working hours from 9:00 AM to 6:00 PM, while the number +60 17 308 2584 has working hours from 8:00 AM to 8:00 PM.

Solution

Go to System → System File Customization.

Open the extensions.conf configuration file for editing. Set the mode to "Append to the end of the file". In the black editing window, add the following code snippet:

In the above code fragment, you need to specify the logins for your provider accounts. In our example, the following data was used:

584611 - the login for the provider account linked to the phone number +60 17 308 9237.
The working hours are from 9:00 to 18:00. Therefore, two intervals for non-working hours need to be set: 00:00-09:00 and 18:00-23:59.
420296 - the login for the provider account linked to the phone number +60 17 308 2584.
The working hours are from 8:00 to 20:00. Therefore, two intervals for non-working hours need to be set: 00:00-08:00 and 20:00-23:59.

Below, the fragments highlighted in red are the ones you need to modify:

Let's break down the ExecIfTime command in more detail. This command executes the specified Asterisk application if the current time matches the given time specification. In our case, the command plays an audio file located in the directory /offload/asterisk/sounds/other/out_work_times in MikoPBX. Command syntax:

times - Time ranges in 24-hour format
weekdays - Days of the week (mon, tue, wed, thu, fri, sat, sun)
mdays - Days of the month (1-31)

In our example, a time range and a range of weekdays are specified. Instead of specifying days of the month and months, a * is used, meaning "for all other cases."

Disable forwarding to mobile for internal calls

In the extension settings you can configure routing. If an employee is not available, the call can be directed to his mobile phone number. This function is not necessary for all cases. For example, clients often ask to turn it off for internal calls.

Go to the “System” section -> “System file customization”

Select the file “/etc/asterisk/extensions.conf” to edit.

Select the “Add to end of file” mode.

Add the code to the second field:

Unique background music for the queue

The function can be useful if there is a need to play an advertising audio file instead of background music. You can assign your own file to each queue.

Go to the section "Telephony" -> "Sound files" -> "Music on hold"

Add media files:

Pause for Queue agent

For the case when an employee has moved away and cannot answer a call, it is convenient to put the agent on pause. For example, an employee dials a special extension number *46 and leaves for lunch.

New calls to the employee will stop coming.

When the employee returns, he dials *46 again and disables the pause. In modern phones, everything can be reduced to pressing a single button.

Go to "Modules" -> "Dialplan Applications"

Dynamic Queue Agents

The "Dynamic Queue Agents" application in MikoPBX is a feature designed to enhance the flexibility and efficiency of call center operations.

From time to time there is a need to add and remove employees from the queue. Until now, this was only possible to do through the web interface of the telephone exchange.

In this article I will tell you how to implement the ability to connect and disconnect from a queue by dialing a service extension number.

Create a new queue with a four-digit extension number. For example, 2001. (see documentation “”)

Setting up the "Paging" function

Paging through phones, i.e. transmitting a voice message through several phones via speakerphone. For example, a manager can quickly call a meeting.

This instruction is suitable for phones:

Linksys
Cisco

Go to the "System file customization" section

Open the file "/var/spool/cron/crontabs/root" for editing

Add the following code to the end of the file:

Proceed to editing the "modules.conf" file

Add the following code to the end of the file:

Go to editing the file "extensions.conf"

Add the following code to the end of the "extensions.conf" file

Go to the "Dialplan Applications" section, create a new dialplan

Assign an internal number, for example 2200110. Set the code type: "Asterisk Dialplan"

Go to the "Programme Code" tab, insert the following code:

Limit the number of authorizations per SIP account

Go to edit the employee account.

In the "Extra oprions" field, add:

Call Monitoring (ChanSpy)

Go to the "Modules" - "Dialplan Applications". Create a new dialplan.

Enter the name "Eavesdropping". Specify the "number to call the application", here we will use the template "911XXX" - XXX means all three-digit numeric numbers. In the "Type of code" field, specify "Dialplan Asterisk"

Conversion of Call History FreePBX -> MikoPBX

Let’s navigate to the FreePBX working directory.
Download the script to convert the MySQL table to SQLite3. If it’s not available, make sure to download it.
Run the conversion script:

SSL Certificate for MikoPBX Web Interface from OPNSense

OPNsense is a FreeBSD-based operating system designed for creating firewalls and routers. It provides powerful network management tools, including VPN, traffic filtering, monitoring, and load balancing.

OPNSense includes a certification authority (CA) and can issue SSL certificates for the MikoPBX web interface.

First, ensure that the OPNSense certification authority is configured and that the root certificate is installed on the user's workstation.

Generate a certificate: Navigate to your OPNSense server and open the certificate manager:

Hiding the Caller’s Number from Employees

In some cases, employees should not see the actual phone number of a client. Here is a possible approach to solving this problem: employees will be provided with an alternative number that they can use to call back.