Kolmisoft Wiki - User contributions [en]

Warning balance

2026-05-26T12:20:00Z

Edvardas: /* From Admin Account */

= Description=

This function allows a number of actions to be taken when a user's balance drops lower than the set value.

You can edit '''Warning Balance''' in [[User Details]].

 
== From Admin Account ==

[[Image:Warning balance user edit.png]]
 

Check '''Active''' to activate this function.

Upon activation, the User, Admin, and Responsible Accountant will receive an email when the User balance drops lower than the balance set in the fields after: '''Send email when balance drops lower than'''.

Select when to send such an email and for whom:

* '''Only once when balance drops lower than''' – email will be sent only one time when balance drops lower than defined value.
* '''Every day at''' – an email will be sent every day at a selected time (in user's time zone) while the balance is lower than defined value.

Additionally, you can play an audio message whenever the user makes a call if the balance drops below the setup Warning Balance.

Check '''Play before every call''' and select the audio file to play.

'''Play when balance drops lower than''' lets to set the balance limit for the above option.

Use this with caution - not many users will like this!

* '''Warning Balance Email''' – This Email is used as a primary email to send the Warning Balance email. If this email is empty '''Email''' in the Registration Address section is used.

* '''Admin Webhook''' – together with the Warning Balance email, a request is sent to the specified URL with data according to the URL config. Webhook URL: '''http://''' or '''https://''' required. Webhook is not tied to email. It can work without email. Just enable "Active", specify values and Webhook URL.
 

== From Reseller Account ==

[[Image:Warning_balance_user_edit_from_reseller.png]]
 

Check '''Active''' to activate this function.

Upon activation, the User and Reseller will receive an email when the User's balance drops lower than the balance set in the fields after: '''Send email when balance drops lower than'''.

Select when to send such an email and for whom:

* '''Only once when balance drops lower than''' – email will be sent only one time when balance drops lower than defined value.
* '''Every day at''' – email will be sent every day at a selected time (in user's time zone), while the balance is lower than defined value.

Additionally, you can play an audio message whenever the user makes a call if the balance drops below the setup Warning Balance.

Check '''Play before every call''' and select the audio file to play.

Use this with caution - not many users will like this!

* '''Warning Balance Email''' – This Email is used as a primary email to send the Warning Balance email. If this email is empty '''Email''' in the Registration Address section is used.

 

=Other notes=

*Emails are sent hourly that means that it might take some time for you to receive an email after the balance drops.

 

= See also =

* [[User Details]]

Configuration from GUI

2026-05-25T15:27:58Z

Edvardas: /* Security */

=Where I can find this settings menu?=

You can find this menu in '''SETTINGS –> Setup –> Settings'''

[[File:Settings_path.png]]
 
== Global ==

'''SETTINGS –> Setup –> Settings –> [[Global_Settings | Global]]'''

* '''Company''' – name of the company.
* '''Company email''' – email address of the company.
* '''Version''' – version number.
* '''Copyright Title''' – copyright title supports html text format.
* '''Browser Title''' – browser title for MOR GUI.
* '''Front Page Text''' – some text to place on front page.
* '''Login Page Text''' – some text to place on login page
* '''Show logo on first page''' - untick to hide logo on the start page
 

== Users ==

* '''Show Calls statistics to User for last''' – number of Calls statistics to show in days. For example, if you enter 5 days, users will only see 5 days old calls, they will not be able to check older calls.
* '''Show user_billsec for Users instead of billsec''' – shows user_billsec instead of billsec in Users invoices and last calls. Notice that Billsec shows real Call duration, user_billsec shows Call duration after minimal time or increment applied. For example, if user tariff has 60 sec minimal time and user made a Call for 20 sec, then billsec will show 20 sec and user_billsec will show 60 sec (minimal time is applied).
* '''Hide device passwords for users''' – do not display device passwords for users.
* ''' Hide Device username for Users''' – do not display device username for users.
* '''Hide payment options for postpaid users''' - will hide the payment option for all postpaid users (including Resellers if they are postpaid).
* '''Hide non-completed payments for user''' – hides non-completed payments (the ones which are started in MOR, but are not completed in a payment gateway website).
* '''Hide Recordings for all users''' – hides recordings for all system users from menu and device settings.
* '''Allow User to assign DID to Device''' – lets User to assign DID to Device.
* '''Allow User to assign DID to Trunk''' – lets User to Assign DID to Trunk.
* '''Do not allow users to change their email addresses'''
* '''Do not allow users to change their Personal Details'''
* '''Change ANSWER to FAILED if HGC not equal to 16 for Users''' – changes the Hangupcause for users in call reports from Answered to Failed if Hangupcause is not 16.
* '''Do not allow PREPAID User balance drop below zero (block them instead)'''
* '''Do not block POSTPAID User when balance goes bellow zero on subscription count'''
* '''Allow identical email addresses to different Users''' – allows creating Users or registering users with identical email addresses. After checking this setting you will be not able to check.

 

== Devices ==

* '''Device PIN length''' – length for automatically generated PIN codes for devices.
* '''Device range MIN''' – from which extension automatic extension assigning starts.
* '''Device range MAX''' – till which extension automatic extension assigning goes.
** For example, from this interval: [Device range MIN, Device range MAX] MOR will select extensions for newly created Devices.
* '''Random Device Extension''' – when creating device, random number from '''Device Range''' will be taken.
* '''Enable "Allowed addresses" option for Devices:''' – allows [[Device_settings#Allowed_Addresses | Allowed Addresses]] functionality in Devices settings.
* '''Do not allow duplicate device user names'''
* '''Inform when Devices are created or updated''' – check to get an email about every newly created or updated Device.
* '''Allow same IP and Port combinations in multiple Devices''' – allows creating Devices with the same IP and Port combination.
* '''Show Hostname/IP in Device list'''
* '''Change dahdi''' – Sometimes this is used to change "Zap" to something else in GUI, e.g. to "PSTN", mainly because not everybody knows what Zap stands for. PSTN is more common.

 

== Registration ==

'''SETTINGS –> Setup –> Settings –> Registration'''

* '''Enabled?''' – do we want to let users [[Online registration | register online]] automatically?
* '''Hide registration link in Login page?''' – tick this option if you do not want users to be able to register online.
* '''Default country'''
* '''Asterisk server IP''' – what IP should user connect his softphone/server to?
* '''Send Email to User after registration''' – just yes or no.
* '''Send Email to Admin after registration''' – just yes or no.
* '''Send Email To User after User was created''' – just yes or no.
* '''Send Email To Admin after User was created''' – just yes or no.
* '''[[ReCAPTCHA]] configuration'''
* '''[[User_Agreement|Terms and conditions]]'''
* '''Allow to create user and device with matching username and password''' – just yes or no. If this setting is not enabled - username and password from MOR GUI will have to be different than device's username and password.
* '''Enable VAT checking for EU companies''' – you can choose whether to check '''TAX Registration Number:''' during the [[Online registration]] or not. Done over [http://ec.europa.eu/taxation_customs/vies/?locale=lt EU page].
* '''Allow blank VAT for EU companies''' – allows to leave blank '''TAX Registration Number:''' field during the [[Online registration]]
 
===See also===

* [[Default user]]
 

== Invoices ==

'''SETTINGS –> Setup –> Settings –> Invoices'''

Invoice configuration is divided into '''Prepaid''' and '''Postpaid'''.
 
=== Settings ===

* '''Number start''' – how the invoice number should start.
* '''Number length''' – the length in digits AFTER Number Start – e.g. Number Start is not counted into this length. This value is active only for first number type.
* '''Number type''' – select more appropriate number format.
* '''Invoice period start''' – when invoices are issued, default is first day of the month.
* '''Show calls in detailed invoice''' – yes or no.
* '''[[Outstanding balance(Debt) | Show balance line]]''' – shows balance line in Invoice PDF files when Invoice is generated from first day of month till last one.
* '''Round finals to 2 decimals''' – round or not total in Invoices to 2 decimals.
* '''Use short file name'''
* '''Group Subscriptions''' - User's subscriptions will be grouped by service (only applies to PDF and XLSX invoice).
* '''Show Quantity''' - Show quantity of each service (only applies to PDF invoice).
* '''Invoice Page Limit:''' – invoice will be generated till this page limit. Additional page is added with an explanation that page limit was reached.
* ''' Rename 'DID owner cost' label in detailed PDF invoice:''' – text which will be used instead of '''DID owner cost''' in detailed PDF invoice.
* ''' Hide 'DID owner cost' line in detailed PDF invoice:''' – checkbox, which control whether or not DID owner cost should be shown in detailed PDF invoice.
* ''' Show Destination with Prefix in Detailed Invoice:''' - checkbox, if enabled, destination will be shown as '''Destination Name (prefix)'''.
* ''' Rename red 'INVOICE' label in Simplified PDF Invoice:'''
* ''' Rename red 'INVOICE' label in Detailed PDF Invoice:'''
* ''' Rename red 'INVOICE' label in PDF Invoice by CallerID:'''
* ''' Use rounded Invoice Details Prices to calculate Totals''' - use rounded sub-totals to calculate Invoice Total price.
 

=== Details ===

* '''Address format''' – changes field positioning in the invoice for the address. You must select it in order to show address in the invoice.
* '''Address line 1-4''' – address info.
* '''Bank details line 1-5''' – bank details info.
* '''Invoice balance line''' – line for balance (e.g. "Your current balance is")
* '''Invoice to pay Line'''
* '''End title''' – a title for the end of your invoice.

* '''Add Average rate in detailed invoice''' – adds average rate in detailed invoice.
* '''Show Time in Minute''' – shows time in mm:ss instead of hh:mm:ss, for example, not 02:13:42 but 133:42.
 

=== Additional ===

* '''Show additional details on separate page''' – enables additional custom page at the end of the invoice.
* '''Additional details''' – the information to be displayed in a custom page at the end of the invoice.
 
=== Functionality ===

* '''Invoice allow recalculate after send''' – allows recalculating invoices after being sent. This setting also allows to delete sent invoices.
* '''Do not generate Invoices for blocked Users''' - if enabled Invoices will not be generated for blocked Users.
* '''Rename "Calls" label''' - changes 'Calls' name for Simplified Invoices and new Invoice XLSX. If you want to apply new 'Calls' name for old XLSX, you should go to Settings > Invoices > XLSX and mark 'New XLSX template apply for old Invoices'
* '''Start value for Invoice numbers''' - defines number from which Invoices numeration should start.
* '''Duration Format:''' - time format in invoice. This setting applies for XLSX type invoices (and PDF invoices generated from XLSX invoice) and Invoice Details page. Available options - 'H:M:S', 'H:M', 'M'. When option 'M' is used, sub option Decimal places appear, where you can select precision.
* '''Invoice Group By: Prefix / Destination'''
* '''Show Rates:No / Yes'''
* '''Show Calls in CID Invoice (CSV)''' - if enabled, then CSV Invoice by CallerID will show a list of calls.
* '''Show Subscriptions total Selfcost in Invoices List CSV''' - enables additional columns at the Invoice List, when using Export to CSV: Agreement Number, Issue date, Subscriptions total Selfcost. Columns are enabled for Admin and Resellers.

 

=== XLSX ===
* '''XLSX Template''' - choose XLSX Template for Invoices.
* '''Send XLSX Invoices converted to PDF''' – If enabled XLSX invoices will be converted to PDF before sending over [[Invoices#Send_invoices_by_email_.28manual.29|Email]] or [[Cron_actions#Generate_Invoices_and_send_by_Email|using cron action]]
* '''Group regular Calls by Destination''' - Groups regular Calls be destination
 

===See also===

* [[Invoices]]
* [[Invoice configuration]]
 

== Emails ==

'''SETTINGS –> Setup –> Settings –> Emails'''

* ''' Sending globally enabled''' – if this is checked, you will be able to use Mass Mailing and the system will send emails upon user registration.
* ''' Add recipient first name and last name''' – if this is checked, it will show the user's first name and last name if they are entered in the User Settings.
* '''SMTP server''' – hostname of the server.
* '''Port''' – port of SMTP server.
* '''Login''' – username to your SMTP server.
* '''Password''' – password to your SMTP server.
* '''Batch size''' – value for Mass Mailing, or how many emails to send at once.
* '''From''' – email address to put into From: field in email. Acceptable formats are: '''example@email.com''' or '''John Smith <example@email.com>'''.
* '''Test email sending''' – save settings and press this to test email sending. Do not forget to save settings first!
* '''TLS''' – '''Auto''', '''Yes''' or '''No'''. Default '''Auto'''.

'''P.S. Remember to set admin's e-mail in admin's personal settings. Without this test email sending will not work!'''

 
===See also===

* [[Emails|Mass Emails]]
* [[Email variables]]
 

== Various ==

'''SETTINGS –> Setup –> Settings –> Various'''

* '''Allow login by email''' - allow users to log in by email instead of a username.
* '''Logout link''' – a user will be redirected to this link after pressing "Logout"
* '''Agreement number length''' – number length in digits.
* '''Google Maps API key''' - the setting is necessary for using the Google Maps functionality. For more on how to configure this key please check [[Get Google Maps key]].
* '''Chanspy is disabled globally'''
*'''Send Recordings space warning Email''' - sends Email to Admin once a day if recordings exceed space limit.
*'''Delete Tariff Jobs older than''' - deletes tariff jobs older than set days.
*'''Delete Automatic Tariff Import Inbox Messages older than''' - deletes automatic tariff import inbox messages older than set days.
* '''Server free space limit''' – indicator when system should inform admin about low [[Multi_Server_support|Server]] space. By default 20%. Notice will appear in [[Integrity Check]] and every hour will send an email "Low Disk Space Alert". Which template can be found and edited on [[Emails]] page. Information about the Server and the remaining free space will be provided.
* '''Days for DID to close''' – how long to keep DID closed before making it free.
* '''DID for Unassigned DID''' - this feature is used for calls coming from providers to system DIDs. Allows redirecting call to specific DID if client dials nonexistent DID. If empty, then this feature is disabled and a call will be terminated with [http://wiki.kolmisoft.com/index.php/207_Not_clear_who_should_receive_call 207 Not clear who should receive call] hangup code.
* '''Play IVR for unauthenticated call'''
* '''Banned CLIs default IVR''' – default IVR to route banned numbers.
* '''Default Music On Hold''' - allows to select Default Music On Hold.
* '''Use Extension in CallerID for Local Calls''' - overwrites original CallerID with Device Extension when making local calls. Outside calls are not affected by this setting.
* '''Call Forwarding CallerID (via call)''' - allows to manage CallerID when [http://wiki.kolmisoft.com/index.php/Call_Flow#Change_Forward_action_by_Call forwarding is set by call].
* '''Force Users to use forwarding CallerID (via GUI)''' – possible options: '''Empty''' (the user will have all options available), '''From Device, Same as comes, Sames as comes - with Diversion'''.
** When forwarding with Diversion, Diversion header can be customized by changing the value in the input field. For example value '''${MOR_SIP_TO};reason=unconditional''' will result in Diversion header with an additional parameter ''';reason=unconditional''' (here '''${MOR_SIP_TO}''' will be expanded to initial SIP To URI <nowiki><sip:xxxxxx></nowiki>). If no value is set, then the default value '''${MOR_SIP_TO}''' (initial SIP To URI) will be used. Other Asterisk/MOR core variables can be used here as well..
* '''Enable "Allowed addresses" option for Providers:''' – allows Allowed Addresses functionality in Providers settings.
*'''Allow forward from Resellers''' - enables advanced device option: Allow forward from Resellers. More information about option in [https://wiki.kolmisoft.com/index.php/Device_settings#Advanced device settings].

== Tax ==

'''SETTINGS –> Setup –> Settings –> Tax'''

Settings are explained here: [[Multi-Tax system]]
 
== Backups ==

'''SETTINGS –> Setup –> Settings –> Backups'''

Configuration is explained here: [[Backup system]]
 
== API ==

'''SETTINGS –> Setup –> Settings –> API'''

* '''Allow API''' – enable/disable API.
* '''Allow GET API''' – enable/disable GET in API - use only for testing!
* '''API Secret Key''' – secret key for API. This will be used as a password for signing queries to MOR API, check [[MOR_API | MOR API documentation]] for more information
* '''XML API Extension''' – .NET does not follow standards (surprise!); enable this setting if you are using it to get XML starting with HTTP tags.
* '''Allow API Login Redirect''' – enable/disable
* '''API allow registration''' – enable/disable registration through API
* '''API allow Payments''' – enable/disable payments through API
* '''API Payment confirmation''' – enable/disable payments confirmation through API
* '''[[Balance_in_phone|Allow devices to check balance over HTTP]]''' – enable/disable device balance checking
* '''[[MOR_API_rate_get|Allow devices to check rate over HTTP]]''' – enable/disable device rate checking
* '''Disable hash checking''' – lets you skip hash parameter using API
* '''Uniquehash''' – shows your uniquehash
* '''Send Email To Admin after API/Manual Payment''' - sends Email to Admin after API/Manual payment. Email Template name: manual_payment_email
* '''Send Email to User after API/Manual Payment''' - sends Email to User after API/Manual payment. Email Template name: manual_payment_email_for_user
* '''Send Email To Admin after API/Balance Update''' - sends Email to Admin after API/Balance Update. Email Template name: balance_update_email
 
===See also===

[[MOR API]]
 

== Functionality ==

'''SETTINGS –> Setup –> Settings –> Functionality'''
 
===FAX===

* '''Fax device enabled''' – enable/disable Fax device in MOR. When admin enables FAX, Functionality tab appears in Reseller's GUI configuration. He can then enable or disabled fax for his own users himself.
* '''Fax2Email From Sender''' – there is a field "From:" in an email form. When MOR sends Fax to Email, "Fax2Email From Sender" value is displayed in "From:" field.
* '''Allow Users to change FAX email''' - allow simple Users to add/remove/edit FAX emails in FAX Devices.
* '''Fax2Email Email Template''' - [[Emails|email template]] to be used for Fax2Email emails. "None" means the default Asterisk template.
 

===CSV===

* '''CSV Column Separator''' – how columns are separated in imported/exported CSV files.
* '''CSV Decimal Separator''' – how decimal parts in numbers are separated in imported/exported CSV files.
* ''' Archive CSV file when size reaches''' – if CSV file reaches a certain size, the system will archive it to save time to download it (0 means to archive always)
 
===Active Calls===

* '''How many maximum [[Active_Calls|Active Calls]] to show in GUI''' – how many [[Active_Calls| Active Calls]] to show in GUI
* '''[[Active_Calls| Active Calls]] refresh interval''' – [[Active_Calls|Active Calls]] refresh interval in seconds
* '''Show [[Active_Calls|Active Calls]] for Users''' – tick if you want to allow users to see [[Active_Calls|Active Calls]]
* '''Show Servers in [[Active_Calls|Active Calls]]'''
* '''Show DIDs in [[Active_Calls|Active Calls]]'''
* '''Show localized Source in [[Active_Calls|Active Calls]]''' - if set, [[Active_Calls|Active Calls]] will show callerid number after localisations (if any) have been applied.
* '''Show Originators' Device IP in [[Active_Calls|Active Calls]]'''
 

===Last Calls===

* '''Limit PDF size in Last Calls to''' - limits how many pages can be exported from Last Calls to PDF. It takes a lot of system resources to generate PDF files therefore this limit should be low enough to prevent high load on system.
* '''Show Device and its CallerID in Last Calls''' – shows additional column in [[Last Calls]] page with Device and its CallerID information. Click to reach that Device settings page.
* '''Show DID User instead of DID Device User in Last Calls''' - if enabled, shows DID User in Last Calls User/Name column instead of DID Device User. This option is relevant when incoming Provider calls DID that belongs to User A and is assigned to User's B Trunk. If option is enabled, User A will be shown. If option is disabled, User B will be shown.
* '''Show Terminated by in Last Calls''' - show Terminated By column in [[Last Calls]], calls CSV/PDF export, and adds the possibility to select this column in [[CDR Export Templates]].
* '''Show Usernames on PDF/CSV Export Files in Last Calls''' – if checked, when a particular User in the Last Calls page search is selected, the Last Calls PDF/CSV file name will be composed also of the Name of selected User. If you are looking for All Users, no User Name will be used. (Name of the User will be shown in Name of the CSV/PDF file).
 

===Tariffs/Rates===

* '''Show rates for users''' – allows users to see rates
* '''Show rates without Tax''' – shows rates without TAX
* '''Show [[Advanced_Rates|Advanced Rates]] for users''' – allows users to see [[Advanced_Rates|Advanced Rates]]
* '''Show zero rates in LCR tariff export:''' – shows zero rates in LCR tariff exported file.
* '''Delete outdated Rates after''' - Delete outdated Rates after some dates.
* '''Show Ghost percent column in Tariffs:''' – if enabled, the Ghost percent column will be shown in the tariff. Default disabled.
NOTE: if [[Custom Rates]] and/or Tariff Rates are set for the user, only the custom rates will be shown in the details of destination rates.
 

===Statement of Account===
* ''' PDF Settings ''' - allows to put Address lines of PDF file for Statement of Account.
*Address line 1: Street Address
*Address line 2: City, Country
*Address line 3: Phone, fax
*Address line 4: Web, email
*Bank details line 1
*Bank details line 2
*Bank details line 3
*Bank details line 4
*Bank details line 5
*Bank details line 6
*Bank details line 7
*Bank details line 8
 

==Privacy==

'''SETTINGS –> Setup –> Settings –> Privacy'''

* '''[[Privacy_to_hide_Destination_ends|Privacy to hide Destination ends]]'''
* '''[[GDPR]] Activated''' – hides User data with notification "Data hidden due GDPR. Press to show data (action will be logged)". Valid for Admin, Accountant, Reseller and Partner.

== Visual ==

'''SETTINGS –> Setup –> Settings –> Visual'''

* '''Items per page (Setting high value can cause performance issues)''' – the number of items to display per one page
* '''[[Global_date_format| Default date format]]''' – System default date format
* '''Default Time Format''' – System default time format
* '''Default Hour Format''' - System default hour format
* '''Default Number Decimal''' – with this option you can set default number decimal for all GUI
* '''Number digits''' – how many digits to display after a comma
* '''Hide Quick Stats in Start page''' – hide Quick stats from start page
* '''Hide "Information about this page" link''' – hide HELP banner in GUI
* '''Hide "I want to" help links'''
* '''[[Remove_Manual_link_from_admin_GUI|Hide "Manual" link]]''' – hides "Manual" link
*'''Hide Provider Payments from User Payment List''' - default off.
* '''Show Full Source (CallerID Name and Number)'''
* '''Use <> brackets in CDR export''' - changes brackets in CDR export
* '''Show only main page''' – this is a very advanced feature for those who want to hide default MOR menu tree on the left so that they could build their own menu using advanced techniques without modifying MOR GUI sources.
* '''Show forgot password''', because this functionality requires a unique email in the system. The setting can be unchecked if all emails are unique in the system.
** '''From Device''' - puts CallerID for the Device that is forwarding the call. If Device CallerID is empty, then the originator's CallerID will be used.
** '''Same as comes - unchanged''' - leaves the CallerID as it comes from the originator.
** '''Same as comes - with Diversion''' - leaves the CallerID as it comes from the original caller and additionally adds SIP header Diversion with CallerID from the Device that is forwarding the call (header will not be added if Device does not have CallerID set).
* '''Show forgot password''' – turns on '''[[MOR_forgot_user_password | Forgot password]]''' functionality.
* '''Show detailed Quick Stats''' - shows modified quick stats of first page.
* '''Show Replication Broken warning only for Admin''' - if enabled, shows Replication Broken warning message only for Admin account.
* '''Change LCR priority by using drag and drop'''
* '''New Menu Active''' - if enabled, changes main menu to the new structure.
* '''Dropdown field in User's subscriptions''' - enables old style Service selection in Subscription form.
* '''Show entered Destination only for Users''' - show the Destination numbers for Users that were entered by them and not Destination numbers after Localization.
* '''Show Company Name column in Users page''' - show "Company Name" column in Users list page.
 

== Server load ==

'''SETTINGS –> Setup –> Settings –> Server load'''
 
Settings for GUI Server and Database Server

* '''HDD utilisation higher than''' – Percentage of CPU time during which I/O requests were issued to the device (bandwidth utilization for the device).
* '''CPU General Load higher than''' – CPU General load higher than – Percentage of the CPU for user processes.
* '''CPU Load Stats 1 higher than''' – average load per one minute on the system
* '''CPU MySQL process higher than''' – Percentage of the CPU for MySQL process
* '''CPU Ruby process higher than''' – Percentage of the CPU for Ruby process
* '''CPU Asterisk process (if present) higher than''' – Percentage of the CPU for Asterisk process
* '''Delete Server Load Stats older than''' – deletes internal servers load statistics older than defined number of days.
 

== Calls ==

'''SETTINGS –> Setup –> Settings –> Calls'''
* '''Retrieve PCAP files from the Proxy Server''' – default off. Works only when CCL module is activated.

* '''SQL Max Execution Time''' - max execution time in seconds for SQL query. The default time is 300 seconds (5 minutes). Used in Statistics pages (Calls List export and similar).
 
[[Archived calls]]
 

== FTP ==
Please fill up FTP server details if you want to store Archived calls or/and Backups to FTP server.

* '''IP''' - Enter FTP server IP.
* '''Port''' - Enter FTP server Port.
* '''Username''' - Enter FTP server Username.
* '''Password''' - Enter FTP server Password.
* '''Path for Archived Calls''' - Enter Path for Archived Calls.
* '''Path for Backups''' - Enter path for Backups.
* '''Path for CDR Export''' - Enter path where to export CDRs.
 

== SFTP ==
Please fill up SFTP server details if you want to use SFTP for [[Automatic CDR Export]].

* '''IP''' - IP of the SFTP server.
* '''Port''' - Port of the SFTP server.
* '''Username''' - Username to connect to SFTP server.
* '''Password''' - Password to connect to SFTP server.
* '''Use SSH key''' - Use SSH key configured as described [[Configure SSH connection between servers|here]].
* '''Path for CDR Export''' - Path in SFTP server where to export CDRs.
* '''Skip CA verification''' - skips SFPT servers CA verification. Try to enable it if the test passes, but if the upload fails. Adds the --insecure option as described here https://curl.se/docs/sslcerts.html
* '''Path to CA Certificate''' - optional. Allows specifying a custom CA store. Adds the --cacert [file] option as described here https://curl.se/docs/sslcerts.html
 

== Security ==
* '''Allow short passwords in devices''' - by default, device passwords are expected to be longer than 7 characters. If enabled, MOR will permit shorter device passwords.
* '''Use strong passwords for users'''
* '''Admin login with approved IP only''' - security measure which allows to approve IP's that try to [[MOR_Login_with_approved_IP%27s|login with Admin Account]].
* '''Enable IP report warning on login failure''' - show [[MOR_Login_Failure_Report|warning]] on unsuccessful login attempts.
* '''Logout after password change''' - terminates all sessions of the User whose password is changed.
* '''Logout after closing browser window''' - terminates all sessions of the User after closing browser window.
* '''Do not logout on session IP change''' - do not logout from MOR GUI if IP is changed.
* '''2FA Enabled''' - Enables two factors authentication. Two factors authentication requires to enter emailed code during login to user account. '''2FA Enabled must be also enable on individual [[User_Details|User settings]] to make it work for that User.'''
** '''Email Template''' - [[Emails|email template]] used to send the code.
** '''Code length (digits)''' - code length.
** '''Code Enter Attempts Allowed''' - number of attempts to enter the code correctly. Code expires after this number of failed attempts.
** '''Code Enter Time Allowed''' - code is valid for this amount of time.
** '''Send Notification Email to Admin on Login''' - allows admin to get email notification on login.
*** '''Email Template''' - [[Emails|email template]] used to notify admin.
*** '''On Admin Login''' - get notification on login to Admin's account.
*** '''On User Login''' - get notification on login to User's accounts.
** '''Send Notification Email on Login''' - allows this mailbox to get email notification on login.
*** '''Email Template''' - [[Emails|email template]] used to notify.
*** '''On Admin Login''' - get notification on login to Admin's account.
*** '''On User Login''' - get notification on login to User's accounts.
 

=See also=

* [[Server is overloaded]]

M4 DIDs Bulk Update from CSV

2026-05-14T11:56:34Z

Edvardas: /* Delete */

= Description =
''M4 DIDs Bulk Update from CSV'' functionality applies to CHANGE, DELETE, and CLOSE SUBSCRIPTION actions.

=CSV file structure=
The CSV file consists of DID numbers separated by a new line. An example file is provided below.
 
[[File:M4_dids_bulk_update_file_structure.png]]
 

= Workflow =
Select the Bulk Action you want to apply. Possible actions: '''CHANGE''', '''DELETE''', and '''CLOSE SUBSCRIPTION'''.

Uploading the CSV file takes place on the DIDs inventory page. Select '''BULK EDIT''', in the opened Bulk Edit menu press the browse button next to the file upload box.
 
[[File:M4_dids_bulk_update_select_file.png]]
 
After selecting the file, press '''Apply Changes'''.
 
In case of success, the analysis page opens.
 
[[File:M4_dids_bulk_update_analysis.png]]
 
The analysis results can be filtered according to the DID, Status, and Reason.
 
[[File:M4_dids_bulk_update_analysis_refine_reults.png]]
 
To make bulk changes, press the '''UPDATE''' button. The process can be canceled using the '''CANCEL''' button. 
Pressing one of the buttons opens a confirmation window.
 
[[File:M4_dids_bulk_update_confirmation_window.png]]
 
After the system has made the changes, the DIDs Inventory page opens.

= Examples =
==Change==
[[File:M4_dids_bulk_examples_change1.png]]
 
[[File:M4_dids_bulk_update_analysis.png]]
 
[[File:M4_dids_bulk_examples_change3.png]]
 

==Delete==
[[File:M4_dids_bulk_examples_delete1.png]]
 
[[File:M4_dids_bulk_update_analysis.png]]
 
[[File:M4_dids_bulk_examples_delete3.png]]

'''Note:''' it is only possible to delete those DIDs where the DID status is '''Free''' or '''Archived'''.
 

==Close Subscription==
[[File:M4_dids_bulk_close1.png]]
 
New parameters are added:
* '''Clear Forward''' - clears forward configuration from the DID settings.
* '''Clear Failover1''' - clears Failover1 configuration from the DID settings.
* '''Clear Failover2''' - clears Failover2 configuration from the DID settings.
* '''Clear Customer''' - clears customer from the DID settings.
 
[[File:M4_dids_bulk_update_analysis.png]]
 
[[File:M4_dids_bulk_close3.png]]

M4 DIDs Bulk Update from CSV

2026-05-14T11:55:59Z

Edvardas: /* Delete */

= Description =
''M4 DIDs Bulk Update from CSV'' functionality applies to CHANGE, DELETE, and CLOSE SUBSCRIPTION actions.

=CSV file structure=
The CSV file consists of DID numbers separated by a new line. An example file is provided below.
 
[[File:M4_dids_bulk_update_file_structure.png]]
 

= Workflow =
Select the Bulk Action you want to apply. Possible actions: '''CHANGE''', '''DELETE''', and '''CLOSE SUBSCRIPTION'''.

Uploading the CSV file takes place on the DIDs inventory page. Select '''BULK EDIT''', in the opened Bulk Edit menu press the browse button next to the file upload box.
 
[[File:M4_dids_bulk_update_select_file.png]]
 
After selecting the file, press '''Apply Changes'''.
 
In case of success, the analysis page opens.
 
[[File:M4_dids_bulk_update_analysis.png]]
 
The analysis results can be filtered according to the DID, Status, and Reason.
 
[[File:M4_dids_bulk_update_analysis_refine_reults.png]]
 
To make bulk changes, press the '''UPDATE''' button. The process can be canceled using the '''CANCEL''' button. 
Pressing one of the buttons opens a confirmation window.
 
[[File:M4_dids_bulk_update_confirmation_window.png]]
 
After the system has made the changes, the DIDs Inventory page opens.

= Examples =
==Change==
[[File:M4_dids_bulk_examples_change1.png]]
 
[[File:M4_dids_bulk_update_analysis.png]]
 
[[File:M4_dids_bulk_examples_change3.png]]
 

==Delete==
[[File:M4_dids_bulk_examples_delete1.png]]
 
[[File:M4_dids_bulk_update_analysis.png]]
 
[[File:M4_dids_bulk_examples_delete3.png]]

'''Note:''' it is only possible to delete those DIDs where the status is '''Free''' or '''Archived'''.
 

==Close Subscription==
[[File:M4_dids_bulk_close1.png]]
 
New parameters are added:
* '''Clear Forward''' - clears forward configuration from the DID settings.
* '''Clear Failover1''' - clears Failover1 configuration from the DID settings.
* '''Clear Failover2''' - clears Failover2 configuration from the DID settings.
* '''Clear Customer''' - clears customer from the DID settings.
 
[[File:M4_dids_bulk_update_analysis.png]]
 
[[File:M4_dids_bulk_close3.png]]

User Details

2026-04-17T11:39:52Z

Edvardas: /* General */

=Where to find user details?=

Go to '''SETTINGS –> Users'''
 
[[File:Users_path.png]]
 
Here you can see list of all users. In brackets by the Accountant or Reseller you are able to see to which Permissions Group([[Reseller Permissions]] or [[Accountant permissions]]) they belong.
 
[[File:Users_path_2.png]] 
 
Select the [[image:icon_edit.png]] icon in a window above beside the user and you will reach personal user settings page. In this window you will see a lot of options grouped into sections like General, Blocking, Warning Balance Email, Invoices, Payments, Details, Taxes, Registration Address, Recordings and Blacklists.


'''NOTE''' that admin is not shown in Users list. To see your own details go to '''PERSONAL MENU –> Details'''.
 
Select the [[image:icon_edit.png]] Bulk management icon in a window above to access bulk management options.
 
[[File:MOR_Users_path_bulk_management.png]]
 

= Details update =
Every User can update his own details in '''PERSONAL MENU –> Details'''. 
To disallow users to change their details Admin/Reseller has to check setting "Do not allow users to change their Personal Details" in '''SETTINGS -> Setup -> Settings -> Various'''. After this User Details can only be updated by user's owner. 
'''NOTE''' that even if User is not allowed to update his own details, he still can see it in '''PERSONAL MENU –> Details''' as form with not editable options. 

= General =

* Username – username for user to login to MOR GUI.
* Password – password for user to login to MOR GUI. Password must contain at least one numeric value, capital and lowercase symbol. '''Note''': To use simple passwords turn off setting in Security section called '''Use strong passwords for users'''.
* Suggest strong password - secure password will be generated and filled in the password field.
* 2FA Enabled - enables two factors authentication for this User. Only visible if 2FA is enabled in [[Configuration_from_GUI|system settings]].
* [[Users#User_types | User type]] – by default it is "user".
* [[LCR]] – LCR indicating which of the user's devices will be used to dial out.
* [[Tariffs | Tariff]] – prices for the user.
* Show Tariff name for User – if enabled, shows Tariff name for User in this Personal details or Quick stats.
* [[Balance and Credit | Balance]] – the user's balance.
* [[Balance and Credit | Credit]] – the user's credit, showing how low the user's balance can go.
* [[Minimum contract billing | Minimal Charge for Calls]] - minimum charge user pays for voice calls.
* [[Minimum contract billing | Minimal Charge for Calls Date]] - date since when the previous option is valid.
* Postpaid/Prepaid – type of user.
* [[Hide Users | Not Hidden/Hidden]] – is this user hidden?
* Primary device – the primary device for this user.
* [[Allow loss calls]] – should loss calls be allowed for this user?
* Max Call rate - set maximum allowed rate (price per min) when making calls (0 - unlimited)
* Default [[Currencies | Currency]] – currency which will be used to show balance, rates and prices in Users' GUI and exported files. Notice that balance (also other values) will be saved in [[Currencies |default system currency]] in DB and converted on the fly using current exchange rate - e.g. balance can change when [[Currencies#Automatic_Currency_Update |exchange rate changes]]. So your user can be surprised when he does not make calls but balance fluctuates.
* [[GUI_time_zone | Time Zone]] – time zone which will be used to show dates and time in Users' GUI and exported files
* Responsible accountant – dropdown to choose accountant responsible for user's profit. (only Admin can set Responsible accountant)
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. 
* Allow to change CallerID – with this option enabled simple user can change his devices custom CallerID.
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] 
* Show Stats from User perspective – hide intermediate Call attempts for User in Last Calls. For example, if LCR contains two Providers and first one is unreachable, then MOR tries to call second Provider. If this setting is checked, User will see only single Call attempt (through second Provider). If settings is unchecked, User will see both attempts in his Last Calls.
* Show only own traffic in Last Calls - show only own traffic for reseller in last calls. If setting on, Reseller will not see calls which made by his user with calling card that belongs to another reseller. (setting available only if User Type - reseller)
* Disable Subscriptions if not enough money - User is not being blocked due low balance, but [[Flat-Rates]] and [[Dynamic Flat-Rates]] subscriptions are deactivated. Works only with subscriptions [[Flat-Rates]] and [[Dynamic Flat-Rates]]. Option depends on global settings '''Do not allow PREPAID User balance drop below zero (block them instead)''' and '''Do not block POSTPAID User when balance goes bellow zero on subscription count'''. For prepaid users, only those subscriptions will be canceled, for which user will not be able to pay. For postpaid users, all subscriptions will be canceled, because user balance is negative.
* Show Price in Last Calls - if unchecked, simple User cannot see Price column in [[Last Calls]]. Price column also not exported.
* Show DID Incoming Price in Last Calls - show this price in the User's Last Calls.
* Show DID Owner Price in Last Calls - show this price in User's Last Calls.
* Hide financial data in Quick Stats - if enabled, financial data in Quick Stats will be hidden.
* Allow to see PCAPs - allows to see PCAP data in [[Call Info]] page. Only for Resellers.
* Show Calls Statistics for last - allows to set a day amount limit on shown calls statistics.
* Show HGC of Failed Calls in Last Calls - Possible options are: Do not show, Show code, Show code with description.
* Allow User to use Random CallerID - if enabled, User could change Random Number from Number Pool option in his device settings.
* Hide SIPCHANINFO - allows to hide SIPCHANINFO in [[Call Info]] page. Only for Resellers.
 

= Limits =
* Separate concurrent Call Limits - Allows to set how many simultaneous inbound and outbound calls the user can make.
Outbound concurrent Call Limit - sets concurrent [[Simultaneous call limitation | Call Limit]] for outbound calls. 
Inbound concurrent Call Limit - sets concurrent [[Simultaneous call limitation | Call Limit]] for inbound calls.
* One concurrent Call Limit (Outbound + Inbound) - Allows to set total simultaneous calls the user can make.
 

= Blocking =

Various options for [[User Blocking]].
 
= Warning Balance Email =

If you want to send an email notification to a user (or take another action) when his balance drops lower than a certain amount, check this setting and enter the desired amount.

More details: [[Warning balance]]
 

= Daily Balance Limit =
More details: [[Daily Balance Limit]]
 

= Invoices =

[[Image:user_invoice_details.png]]
 

* '''Generate Invoice''' – should we include this User when we generate Invoices for multiple Users (for example when we select to generate Invoice for postpaid/prepaid Users or when we automatically generate Invouice for all Users)?
* '''Show zero Calls''' - should we include calls that have 0 price?
* '''Generate empty Invoice''' - should we generate Invoice even if it is empty (no subscriptions, no calls, nothing to pay for)?
* '''Invoice types''' - select which Invoice types are available to end Users. Also only selected types will be sent to User via Email.

= Payments =

* Cyberplat - check this option if you want to allow the user to use this payment gateway.
* Stripe - check this option if you want to allow the user to use this payment gateway.

 

= Statement of Account =

[[Image:user_details_soa.png]]
 
* '''Use custom Opening Balance Settings''' - should we enable custom Balance Settings?
* '''Opening Balance:''' - set custom value for Opening Balance
* '''Beginning from:''' - set custom Beginning from: date
 
= Details =

Self-explanatory.

If Country of Taxation is in the EU, validation of TAX Registration Number will be checked from this website: http://ec.europa.eu/taxation_customs/vies/
 
= Taxes =

Here tax parameters are entered for the user.

The tax system is explained [[Multi-Tax system | here]].
 
= Registration Address =

Self-explanatory.
 

'''Email''' - There can be only one email or emails separated by semicolon, for example: '''test@kolmisoft.com; test2@kolmisoft.com.''' In this case email will be sent for two emails.

= Recordings =

This section is available when the [[Recordings Addon]] is installed in the system.
 
=Blacklists / Whitelists=
 
[[Image:user_blacklists_details.png]]
 

'''Enable static Source''' - enables static Blacklist or Whitelist 
* '''No''' - do not use any Blacklist or Whitelist
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from receiving and sending specific Source numbers. If User receives or sends number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''262 - Source number is in blacklist''
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to receive only specific Source numbers. If User receives number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''263 - Source number is not in whitelist''


'''Enable static Destination''' - enables static Blacklist or Whitelist 
* '''No''' - do not use any Blacklist or Whitelist
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from calling specific Destination numbers. If User calls number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''255 - Destination is in blacklist''
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to call only specific Destination numbers. If User calls number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''256 - Destination is not in whitelist''
 
'''Note:''' when using Number Pools for Blacklist/Whitelist, it is possible to upload prefixes. To do so, just import prefixes with percent sign at the end (example: '''370%''' will act as prefix for 370xxxxxxxx number). 
Also you can manage '''[[Dynamic Blacklist Functionality]]''' settings for Single User. You are able to manage:

'''Enable Dynamic Blacklist''' – enables dynamic Blacklist functionality for this user. 
'''Blacklist LCR''' – [[LCR]] with Blacklist Providers. 
'''Routing Threshold''' – sum of SRC, DST and RTP IP limit. If SRC, DST or RTP IP scores sum received during the call is bigger than Defaullt Threshold, call will be routed through selected Blacklist LCR. 

Choose option '''Global''' if you want to apply [[ Monitorings_Addon#Monitorings_Settings | global settingas]] for this user.
 

=Flash Calls=

Flash Call - a short call that is cancelled once the Ringing (Progress) signal is received. Often used for authentication to bypass SMS authentication fees. Options bellow allow to bill these calls.

[[File:M4_flash_calls_billing.png]]

* '''Flash Calls billing enabled''' - enables Flash Calls detection and billing.
* '''Flash Calls price''' - price for Flash Calls.
* '''Flash Calls ringing duration''' - Flash Calls detection duration in milliseconds. Cancelled calls with ringing/progress duration lower than this setting will be considered as Flash Calls. For example, if the value is set to 200ms and the originator cancelled the call in 100ms after the ringing signal, then the call will be considered as Flash Call and will be billed by the '''Flash Calls price''' setting.
 

=Purge User data=
* Purge User data - the admin can completely delete a user with all his data. After clicking the button, an additional confirmation form appears to confirm the purge. You are asked to enter the username of the user to be deleted (as confirmation) and click the '''Confirm User Purge''' button.
'''IMPORTANT:''' This action will delete the user and all related data. Please back up your data before proceeding.
 

= Comment =

Here you are able to write private comment about user.

File:AccountantPermissions.png

2026-04-17T08:04:26Z

Edvardas: Edvardas uploaded a new version of File:AccountantPermissions.png

Whitelisted IPs

2026-04-15T05:31:32Z

Edvardas:

'''Whitelisted IPs''' can be used from '''Admin''' account and from '''Accountant''' account with Monitoring permissions enabled.

From the Admin account, go to '''SETTINGS -> Security -> Whitelisted IPs''' to manage Whitelisted IPs.

An IP can be whitelisted by entering valid input values and by clicking the '''Whitelist''' icon.

'''The range of IPs''' can be added in a format like '''192.168.0.1-5''', which would result in multiple entries being created (192.168.0.1, 192.168.0.2, 192.168.0.3, 192.168.0.4 and 192.168.0.5).

All the Whitelisted changes will be active in '''one minute after they have been applied.''' Country information (flag) can take up to one hour to appear.
 
[[File:mor_whitelist_ips_list.png]]
 
The Comment can be added to the Reason field. If the Reason is not specified, then it will be set to "MOR-WHITELIST-GUI".

If the country, to which IP belongs, is blocked in [[Blocked Countries]], but IP is added to '''Whitelisted IPs''', it means that the whole country is blocked except that whitelisted IP.

'''Search''' functionality allows to check if the entered IP exists in the list.

Wildcard '''%''' is available to use in the search.

 
= Whitelisted IP format =
It is possible to block IPs in such format:
* Single IP, for example, '''2.2.2.2'''
* Subnet in CIDR notation, for example, '''2.2.2.0/24'''. Please note that CIDR notation will be converted into the canonical format automatically. For example, if you enter 2.2.2.1/24, it will be converted to 2.2.2.0/24. This is because 2.2.2.0/24 denotes the range 2.2.2.1 - 2.2.2.254, so any subnet from 2.2.2.1/24 to 2.2.2.254/24 means exactly the same range, and a canonical way to represent this is range is with 2.2.2.0/24
* IP range in format x.x.x.x-xx, for example '''2.2.2.1-125'''. Please note that all IPs in the range will be whitelisted as separate IPs, so entering 2.2.2.1-125 would create 125 single IP entries. For this reason, we strongly recommend using subnets if possible.
 

=See Also=

* [[Blocked IPs]]
* [[How to block someone's IP]]
* [[How to block country IP]]
* [[How to add Fail2ban exception for my IP]]
* [[Monitorings Addon]]

File:Mor whitelist ips list.png

2026-04-15T05:28:21Z

Edvardas: Edvardas uploaded a new version of File:Mor whitelist ips list.png

MOR API user calls get

2026-04-10T12:09:38Z

Edvardas: /* Returns */

=Description=
Retrieves list of calls in selected time period for specified User/Device. 

'''Admin''' - can get any user calls

'''Reseller''' - can get his and his users calls.

'''User''' - can get his own calls.
 
=Usage=

* From '''MOR X4''' call: '''/api/user_calls_get'''
* For Backwards-compatibility old name 'user_calls' is also usable. Call: '''/api/user_calls'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

Parameters which are '''included''' into hash:

* period_start - Unix timestamp of calls period starting date. (Default: Today at 00:00). 
* period_end - Unix timestamp of calls period end date. (Default: Today at 23:59). 
* s_user - User's ID in MOR database. '''Required, if s_reseller is not used'''. 
* s_call_type - Call type. Possible values [all, answered, no answer, failed, busy]. (Default: all) 
* s_device - Device ID in MOR database. Possible values [all, numeric value of device_id]. (Default: all). 
* s_provider - Provider ID in MOR database. Possible values [all, numeric value of provider_id]. (Default: all).Only for Admin and Reseller PRO. 
* s_hgc - Hangup cause code ID in MOR database. Possible values [all, numeric value of hangup_cause_code_id]. (Default: all). Only for Admin and Reseller if Show HGC for Resellers is ON. 
* s_did - show calls made through specific DID. Possible values [all, calls.did_id]. (Default: all). Only for Admin. 
* s_destination - prefix. 
* order_by - Possible values [time, src, dst, prefix, nice_billsec, hgc, server, p_name, p_rate, p_price, reseller, r_rate, r_price, user, u_rate, u_price, number, d_provider, d_inc, d_owner]. (Default: time). 
* order_desc - Possible values [0,1]. (Default: 0). 
* only_did - show calls that only went through did. Possible values [0,1]. (Default: 0). 
* s_uniqueid - returns specific Call by uniqueid. Date parameters are ignored in this case.
* s_callback_uniqueid - returns Call(s) by callback uniqueid. Date parameters are ignored in this case. Only works when '''use_callback_uniqueid''' setting is enabled in [[Mor.conf|mor.conf]].

'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked).
* u - username for authentication. '''Required'''. 
*  s_reseller - Reseller type User ID in MOR database. (Default: all).
* from - from which record to show results.
* max_results - how many records to show.
  

===Request===

If you want find s_call_type=all calls for s_user = 5, through s_device=7 in period from 2011-11-01 23:59:59 till 2011-11-30 23:59:59, and your API Secret Key = 456789

You send:

HTML POST: http://<SERVER_IP>/billing/api/user_calls_get?u=username&s_user=5&period_start=1320191999&period_end=1322697599&s_device=7&s_call_type=all&hash=df2983700ffecb52e6649f0cb3981b66537083a4

'''* Note that username is not included in hash'''
 
===Returns===

'''Success:''' Everything is ok. You get the list of calls if there is any:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<pagename>Calls</pagename>
<language>en</language>
<error_msg></error_msg>
<userid>0</userid>
<username>admin</username>
<total_calls>1</total_calls>
<currency>USD</currency>
<calls_stat>
<period>
<period_start>2008-03-07 11:48:18</period_start>
<period_end>2012-03-07 11:46:01</period_end>
</period>
<show_user>all</show_user>
<show_device>all</show_device>
<show_status>all</show_status>
<show_provider>4</show_provider>
<show_hgc>all</show_hgc>
<show_did>1</show_did>
<calls>
<call>
<calldate2>2009-01-02 00:00:01</calldate2>
 <timezone>GMT+02:00</timezone>
<clid>37046246362</clid>
<destination>Lithuania MOB Lithuania mobile</destination>
<did>37063042438</did>
<did_inc_price>1.0</did_inc_price>
<did_price>1.0</did_price>
<did_prov_price>1.0</did_prov_price>
<dispod>ANSWERED(16)</dispod>
<dst>37063042438</dst>
<nice_billsec>20.0</nice_billsec>
<nice_reseller> </nice_reseller>
<prefix>3706</prefix>
<profit>4</profit>
<provider_name>Test Provider</provider_name>
<provider_price>1.0</provider_price>
<provider_rate>0.0</provider_rate>
<reseller_price>0.0</reseller_price>
<reseller_rate>0.0</reseller_rate>
<server_id>1</server_id>
<src>37046246362</src>
<user>test_user</user>
 <user_currency>EUR</user_currency>
 <user_exchange_rate>0.744100000000000</user_exchange_rate>
<user_id>5</user_id>
<user_price>2.0</user_price>
<user_rate>0.0</user_rate>
<dst_user_id>7</dst_user_id>
 <userfield></userfield>
 <uniqueid>1232113379.3</uniqueid>
</call>
</calls>
</calls_stat>
</page>

'''NOTE''' that calldate is in system(server) Time Zone.

'''Errors:'''

* <error>API Requests are disabled</error> – '''Allow API globally''' setting is unchecked.
* <error>Access Denied</error> – Such username does not exist in the database or it was not specified.
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>User was not found</error> – User was not found using user_id. Use correct user_id.

Example:

<status>
<error>API Requests are disabled</error>
</status>
 

=See also=

* [[MOR API]]

MOR API users get

2026-03-31T08:25:20Z

Edvardas: /* Parameters */

=Description=

[[MOR API]] for getting list of users

*'''Admin or Accountant with permissions''' can get all users list
*'''Reseller''' can get his own users list
*'''Partner''' can get his resellers and users

 
=Usage=

* From '''MOR X8''' call: /api/users_get
* Methods: POST, GET(if allowed, not recomended)
 

===Parameters===

Parameters that are '''included''' into hash:

* u - username to log in. '''Required'''.
* p - password to log in. '''note''': you can use either '''p''' or '''uniquehash''' to identify the user. One of them is required. 

Parameters that are '''not included''' into hash:

* uniquehash - user's uniquehash. '''note''': you can use either '''p''' or '''uniquehash''' to identify the user. One of them is required. 
*[[MOR API hash construction | hash]] – SHA1 hash constructed using '''API Secret Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* from - from which record to show results.
* max_results - how many records to show.
 
'''note''': if using the browser's URL bar, then you should encode special symbols (these symbols usually appear in the p parameter). Example:
* for % use %25
* for # use %23
* for + use %2B
* for & use %26
* for * use %2A
* for ? use %3F

 

===Request===

If API Secret Key = secret

You send:

HTML POST: http://<SERVER_IP>/billing/api/users_get?u=admin&p=admin1&test=1&hash=c420ef706a02e6449994b7575b25ef5f74cc722b

 

===Returns===

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<users>
<user>
<id> ... </id>
<username> ... </username>
<first_name> ... </first_nam>
<last_name> ... </last_name>
<balance> ... </balance>
<blocked> ... </blocked>
<lcr_id> ... </lcr_id>
<tariff_id> ... </tariff_id>
<owner_id> ... </owner_id>
<usertype> ... </usertype>
<hidden> ... </hidden>
</user>
</users>
</status>
</page>

'''Errors:'''

* <error>API Requests are disabled</error> – '''Allow API globally''' setting is unchecked
* <error>GET Requests are disabled</error> – '''Allow GET API''' setting is unchecked
* <error>Access Denied</error> – User is not allowed to to get users list or username and password are not correct.
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order of parameters while concatenating the hash_string
* <error>You are not authorized to view this page</error> – User is not authorized to get users list.

Example:

<status>
<error>API Requests are disabled</error>
</status>
 

=See also=

* [[MOR API]]

MOR API users get

2026-03-31T08:25:01Z

Edvardas: /* Parameters */

=Description=

[[MOR API]] for getting list of users

*'''Admin or Accountant with permissions''' can get all users list
*'''Reseller''' can get his own users list
*'''Partner''' can get his resellers and users

 
=Usage=

* From '''MOR X8''' call: /api/users_get
* Methods: POST, GET(if allowed, not recomended)
 

===Parameters===

Parameters that are '''included''' into hash:

* u - username to log in. '''Required'''.
* p - password to log in. '''note''': you can use either '''p''' or '''uniquehash''' to identify the user. One of them is required. 

Parameters that are '''not included''' into hash:

* uniquehash - user's uniquehash. '''note''': you can use either '''p''' or '''uniquehash''' to identify the user. One of them is required. 
*[[MOR API hash construction | hash]] – SHA1 hash constructed using '''API Secret Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* from - from which record to show results.
* max_results - how many records to show.
 
'''note''': if using the browser's URL bar, then you should encode special symbols (these symbols usually appear in the p parameter). Example:
* for % use %25.
* for # use %23.
* for + use %2B.
* for & use %26.
* for * use %2A.
* for ? use %3F.

 

===Request===

If API Secret Key = secret

You send:

HTML POST: http://<SERVER_IP>/billing/api/users_get?u=admin&p=admin1&test=1&hash=c420ef706a02e6449994b7575b25ef5f74cc722b

 

===Returns===

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<users>
<user>
<id> ... </id>
<username> ... </username>
<first_name> ... </first_nam>
<last_name> ... </last_name>
<balance> ... </balance>
<blocked> ... </blocked>
<lcr_id> ... </lcr_id>
<tariff_id> ... </tariff_id>
<owner_id> ... </owner_id>
<usertype> ... </usertype>
<hidden> ... </hidden>
</user>
</users>
</status>
</page>

'''Errors:'''

* <error>API Requests are disabled</error> – '''Allow API globally''' setting is unchecked
* <error>GET Requests are disabled</error> – '''Allow GET API''' setting is unchecked
* <error>Access Denied</error> – User is not allowed to to get users list or username and password are not correct.
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order of parameters while concatenating the hash_string
* <error>You are not authorized to view this page</error> – User is not authorized to get users list.

Example:

<status>
<error>API Requests are disabled</error>
</status>
 

=See also=

* [[MOR API]]

Spy real-time calls

2026-03-26T15:34:22Z

Edvardas: /* How this functionality works? */

=About=

This functionality is a part of [[Monitorings Addon]] addon and is used to spy user's real-time calls.

MOR user's which are allowed to use this functionality:

* Admin
* Accountant (with Allow Spy Calls (Monitoring) permission)
* Reseller (active calls must be enabled for resellers)
* User (with Active Calls permission)
 

== Use Cases ==

* '''Technical Troubleshooting''' – Service providers and engineers can monitor test calls in real time to identify issues like echo, packet loss, or one-way audio.
* '''Enterprise Quality Assurance''' – Companies can monitor staff calls for quality assurance or regulatory compliance.
* '''Call Center Supervision''' – Supervisors can listen to agents’ calls in real time to evaluate service quality, check compliance, and ensure scripts are followed.
* '''Training & Onboarding''' – Trainers can silently monitor calls of new employees. In "whisper mode," they can coach the agent without the customer hearing.
* '''Live Support Escalation''' – Managers can "barge in" during critical calls to assist agents with difficult situations, ensuring better customer satisfaction.

 
==How this functionality works?==

1. The manager selects a device where he will receive calls from the system when he wants to spy his user (this has to be done only once).

2. Manager configures his phone to be able to answer it.

3. Manager goes to active calls and presses a Spy icon on a desired call:
 
[[File:Active_calls_spy.png]]
 
4. MOR system sends a call to a device set in step 1.

5. Manager answer's the call from the system and is able to listen.

6. By default, in the Active Calls page Spy device from the user settings is shown. The manager can also select another Spy device in the Active Calls page.

Manager can also switch between different SPY modes by pressing:

digit 4 - spy mode (listen only);

digit 5 - whisper mode (spying channel can talk to the spied-on channel);

digit 6 - barge mode (talk to both channels involved in the call).

 
Please note that it is not possible to spy calls if their Server IDs do not match Spy Device Server ID of the user (admin/reseller) who is viewing the calls. Icons for such calls are fainted:
 
[[File:Activecalls spy.png]]
 

==Enable/disable this functionality==

===Enable===

1. For administrator select Spy device in Personal Menu -> Details.

2. For Resellers login as Reseller and go to PERSONAL MENU -> Personal Details.

Select a desired device where you want the system to send a call being spied:
 
[[File:Select_chan_spy_device.png]]
 
===Disable===

You can also globally disable ChanSpy. Go to '''Setup''' -> '''Settings''' -> '''Variuos'''. You will see this setting:

[[File:Chanspy.jpg]]

Tick "Chanspy is disabled globaly:" and click "Save changes"
 

==What is needed to use this feature?==

* '''Admin''': System must have [[Monitorings Addon]]
* '''Reseller''': System must have [[Monitorings Addon]] and [[Active_Calls|active calls must be enabled]] for resellers.
 

==Other setttings==

When spying you '''can press #''' to increase/decrease sound volume.

Available sound levels:

1 2 3 4 -4 -3 -2 -1 '''0'''(default)

'''Here''':

'''-4''' - is the quietest

'''4''' - is the loudest
 
==Limitations==

If you have 2 Asterisk servers in your system, both devices for the "Spy action" have to registered to the same Asterisk server.

If source of few calls is same Device/Provider it is possible to SPY on one of those calls only.

If you have a system with a proxy, Spy functionality will not work.
 

= See also =

* [[Monitorings_Addon|Monitorings addon]]

2026-03-23T13:02:59Z

Edvardas:

M4 DID Management

2026-03-23T12:49:57Z

Edvardas:

<html>
<div align="center">
<iframe width="640" height="360" src="https://www.youtube.com/embed/8W_Ck2nqQHE" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
</html>

 
= Supported Functionality =

* DID inventory search/filtering
* Bulk upload tool
* DID Status and Assignment visibility
* Buying/Selling charges support
* Flexible Inbound routing
* Route to client PBXs by IP addresses – Trunking
* Follow me ( Call Forwarding ) style services where the inbound calls can be routed back out to the alternate destination

 
= Inventory =

[[File:M4_dids_inventory.png]] 

On this page you can:
*Add new DID(s).
*Import DID(s).
*Export DID(s).
*Bulk edit DID(s).
*Search DID(s) using various parameters.
*Edit DID(s) subscription.

 

= Buying Pricing Groups =

Buying Pricing Groups unifies DIDs bought as a group for the same price from one DID Provider. It allows quickly setting buying prices for the DID or group of DIDs.

In Buying Pricing Groups '''all charges would be paid by Admin to Provider'''

DID Buying Pricing Groups can be accessed at '''Routing -> DIDs - Buying Pricing Groups'''

To Add a new DID Buying Pricing Group, press '''NEW''' and fill in needed data: 
*'''Name'''
*'''Currency'''
*'''Activation Fee''' - One-time fee that will be charged when activating DID.
*'''Periodic Fee''' - Fee that will be charged every period set in '''Charge Plan'''.
*'''Tariff''' - Tariff which will be used for the call. The call will be charged by CallerID prefix by a tariff rate. 
[[File:Buying Group create.png]] 

When data is filled, press '''CREATE'''

[[File:Buying Group created.png]] 

It is possible to edit or delete a group by pressing the '''EDIT''' or '''DELETE''' button. 

 

= Selling Pricing Groups =

Selling Pricing Groups unifies DIDs sold as a group for the same price. It allows quickly setting selling prices for the DID or group of DIDs.

In Selling Pricing Groups '''all charges would be paid by User to Admin'''

DID Selling Pricing Groups can be accessed at '''Routing -> DIDs - Selling Pricing Groups'''

To Add a new DID Selling Pricing Group, press '''NEW''' and fill in needed data: 
*'''Name'''
*'''Currency'''
*'''Overwrite Activation Fee''' - NO / YES . If Yes is chosen, options '''Additional activation fee''' and '''Activation fee markup''' would be changed to '''Activation fee'''.
*'''Additional Activation Fee''' - Additional one-time fee that will be charged when activating DID. The value is added to '''Buying Activation fee'''.
*'''Activation Fee Markup''' - Activation Fee Markup is calculated as % from '''Buying Activation fee'''.
*'''Overwrite Periodic Fee''' - NO / YES . If Yes is chosen, options '''Additional Periodic fee''' and '''Periodic fee markup''' would be changed to '''Periodic fee'''.
*'''Additional Periodic Fee''' - Additional fee that will be charged every period set in '''Charge Plan'''. The value is added to '''Buying Periodic fee.'''
*'''Periodic Fee Markup''' - Periodic Fee Markup is calculated as % from '''Buying Periodic fee'''.
*'''Tariff''' - Tariff which will be used for the call. The call will be charged by CallerID prefix by a tariff rate.
 

[[File:Selling group create.png]] 

When data is filled, press '''CREATE'''

[[File:Selling group created.png]] 

It is possible to edit or delete a group by pressing the '''EDIT''' or '''DELETE''' button. 

 

= Charge Plans =
Charge Plan is a template for the Subscription - defines what type of Subscription can be used for a service.

More information can be found [[M4 Charge Plans|here]]. 

 

= Tags =
Tags are labels attached to DIDs for the purpose of identification or to give other useful information. Tags help manage groups of DIDs.

DID Tags can be accessed at '''Routing -> DIDs - Tags''' 

To Add a new DID Tag, press '''NEW''' and fill in its Name and Comment if needed. 
Color gamma can be accessed when pressing on the Color field.

[[File:DID Tags Create.png]] 

When data is filled, press '''CREATE'''

[[File:DID Tag Created.png]] 

It is possible to edit or delete Tag by pressing the '''EDIT''' or '''DELETE''' button. 

 

= Add new DID(s) =

[[File:M4_add_new_did.png]] 

*'''DID''' - enter DID number.
*'''Tags''' - select tag.
*'''Vendor''' - select a supplier.
*'''Buying''' Pricing Group - select Buying Pricing Group or create a Custom one.
*'''Comment''' - for notices.
*'''Customer''' - select a user.
*'''Selling''' Pricing Group - select Selling Pricing Group or create a Custom one.
*''' Header Transformation Group ''' - which [[M4 Header Transformation Rules Groups|Header Transformation Rules Group]] to use. 
'''NOTE.''' By pressing '''CREATE AND ACTIVATE FOR USER''' the DID should start working immediately and receive calls. 
The Subscription will be created according to the option set in MAINTENANCE -> Settings -> SIP Trunking -> Default Billing Settings for DID Subscription. 
Two options are available: '''"DID Selling Pricing Group"''' or '''"Selected Charge Plan"'''.

'''NOTE.''' It is possible to fill Default DIDs settings for new DIDs at Maintenance - Settings - DIDs.
 

= Add new DID(s) as Manager =

[[M4 Managers | Managers]] needs DIDs [[M4_Managers#Manager_Groups | permission]] to manage DIDs.

To simplify the manager's work, the admin can fill DIDs section in [[ M4 Settings#DIDs | settings]].

[[File:M4_settings_DIDs_fill.png]]

When the manager creates a new DID, all settings will already be filled in.

[[File:M4_add_new_did_manager.png]]

The manager will only need to enter the DID number and select the user. The system will select the first user's device (number 3 in the screenshot). The Manager can change the device if needed. 
If the settings are correct, then the Manager needs to press '''CREATE AND ACTIVATE FOR USER''' to create and activate the DID.
 

= DID(s) edit =
[[File:M4_dids_edit.png]]

'''Add Diversion Header''' - if enabled, a Diversion header is added calling this DID. The URI will be this DID.

'''Add History-Info Header''' - if enabled, a History-Info header is added calling this DID. The URI will be this DID.

Let's say the DID number is 37011111, and the external number is 37022222

x.x.x.x - IP of the connection point where is DID is forwarded to

y.y.y.y - IP of the TP that will terminate the forwarded external number

z.z.z.z - IP of the M4

If DID 37011111 is forwarded to the connection point, the headers will look like this:

INVITE sip:37011111@x.x.x.x SIP/2.0
...
To: <sip:37011111@x.x.x.x>
...
Diversion: <sip:37011111@z.z.z.z>;reason=unconditional;screen="yes"
History-Info: <sip:37011111@z.z.z.z>;index=1
...

If DID 37011111 is forwarded to external number 37022222, the headers will look like this:
INVITE sip:37022222@y.y.y.y SIP/2.0
...
To: <sip:37022222@y.y.y.y>
...
Diversion: <sip:37011111@z.z.z.z>;reason=unconditional;screen="yes"
History-Info: <sip:37011111@z.z.z.z>;index=1
History-Info: <sip:37022222@z.z.z.z>;index=1.1

 

= Import =

M4 DIDs can be imported from the CSV file. Import procedure [[M4 DIDs Import from CSV | described here]].

 
= Export =

DIDs are exported to CSV. The system exports only visible DIDs in the Inventory that are filtered by search parameters. 

 
= DID Search (Refine) =

Filter DIDs by various options:

[[File:Did refine.png]]

When a filter is active, then Inventory stats will show green values for the filtered DIDs ([[M4_DID_Bulk_with_Refine_Example|example]]):

[[File:Did_refine_colors.png]]

 

= DID bulk management =

In the main DIDs window, click on '''BULK EDIT''' and you will be able to perform various actions.

Bulk management works together with REFINE (Search). First, you find the DIDs you need, then you apply Bulk Action on them.

Find necessary DIDS with REFINE section. Then mark (by pressing the rectangle at the left of the DID) all DIDs or just some of them to apply Bulk Action to them.

Example how to do that [[M4_DID_Bulk_with_Refine_Example | here]]

[[File:M4_dids_bulk1.png]] 

'''Bulk Action''' - Change, Delete or Close Subscription. 
'''Tag Action''' - Add or Delete. 
'''Status''' - Do not Change, Free, Reserved, Archived. 
'''Vendor''' - Change Vendor. 
'''Destination''' - Change Destination. 
'''Buying Pricing Group''' - select and change Buying Pricing Group from the list. 
'''Tags''' - Change Tags. 

Select DIDs to modify and apply the actions. '''Example before changes:''' 
[[File:M4_dids_bulk2.png]] 

'''Example after changes:''' 
[[File:M4_dids_bulk3.png]] 

= DIDs Bulk Update from CSV =
DIDs can be updated from the CSV file. Update procedure [[M4 DIDs Bulk Update from CSV | described here]].
 

= Making DID Active =

'''Important.''' In order to make DID active and call it, it must have an assigned subscription.
 

= DIDs page for users =

 
= See also =
* [[M4 Subscriptions|Subscriptions]]
** [[M4 Charge Plans|Charge Plans]]
* [[M4 Services|Services]]
** [[M4 DID Management|DIDs]]
*** [[M4 DIDs Import from CSV|DID Import from CSV]]
** [[M4 Flat-Rates|Flat-Rates]]
** [[M4 Custom Services|Custom Services]]

File:M2 calls list.png

2026-03-23T12:40:13Z

Edvardas: Edvardas uploaded a new version of File:M2 calls list.png

M4 Settings

2026-03-23T12:31:31Z

Edvardas: /* Calls List */

To change M4 Settings, go to '''MAINTENANCE - Settings'''

Just click on each point to expand.
 

=Invoices=
[[File:Invoices.png]]
 
*'''Number start''' - how the invoice number should start.
*'''Number length''' - the length in digits AFTER Number Start – e.g. Number Start is not counted into this length. This value is active only for the first number type.
*'''Number type''' - select more appropriate number format. INV000001 means auto incremental number after "Number start" value. INV070601 means "Number start" + date + invoice max id.
*'''Duration format''' - time format in invoice. Available Options - 'H:M:S', 'H:M', 'M'. When option 'M' is used, the sub-option Decimal places appear, where you can select precision.
*'''Group Calls By''' - when "Destination" is selected, an additional option appears, that allows selecting grouping by "Destination Name" or "Destination Group". "Destination Name" combines all destinations with the same name into one Invoice entry.
*'''Group DID Calls into single line''' - when "Yes" is selected, all DID calls will be grouped into a single Invoice Line. An additional option appears, that allows to set a name for the Invoice Line.
*'''Group Subscriptions by Charge Plan''' - when "Yes" is selected, all Subscriptions will be grouped by the Charge Plan assigned to those Subscriptions. The Invoice Line name will be taken from Charge Plan setting 'Name visible to end user'. If 'Name visible to end user' is not set on the Charge Plan, then a placeholder 'Subscriptions' will be used as Invoice Line.
*'''Show Rates''' - when "Yes" is selected, the Invoice will show Rate for each Destination. If the same Destination has multiple Rates then multiple Invoice Lines will be show for the same Destination but with different Rates.
*'''Manual Payment Line''' - changes the name of line: Prepaid VoIP Services in the invoice. Available in Manual Payment invoices.

'''Consider the following before changing settings:'''
*if the Number type is changed from INV070601 to INV000001 AND the Number start is kept the same, the numbering continues from the last INV070601 format number.
*if the Number type is changed from INV070601 to INV000001 AND Number start is kept the same AND the Number length is set to some lower value than it is sufficient to fit the previous INV070601 numbering, then the Number length value will be disregarded and the lowest sufficient value to continue from last Invoice number will be used.
*if the Number type is changed from INV070601 to INV000001 AND Number start is kept the same AND the Number length is set to some higher value than it is sufficient to fit previous INV070601 numbering, then numbering will continue from the last INV070601 format number and new Number length will be applied, by placing additional zeros between Number start and last number (INV070601 > INV0000070602).
 
'''XLSX'''
 
XLSX file to export an Invoice is made from your own XLSX format template and information from the Invoices main window.
An example of the template can be downloaded [https://packets.kolmisoft.com/packets/x6_invoice_template.xlsx here].

When you already have a template for example with all data of your company, with drawn tables and so on, you need to define where should be shown the dynamic information of the invoice. To do that you just need to define the cell address in the correct format.

Client Address Cell is different than other ones - once you will define this, all other Address Related Cells will be filled automatically and will not be editable. Also, no empty space will be left if any Address sub-cell is not defined. For example, if Client State is not defined in User's Settings, then this Cell will not be empty in Invoice - all Address Cells below will go up by one Cell. This allows nice Address formatting without leaving spaces if some Address data is not defined in the User's settings.

*'''Comment''' - refers to the Comment available on the Invoice Details page. The Invoice needs to be recalculated after adding a comment, so that comment would be applied.

 

=Emails=
[[File:M2 Invoices.jpg]]
 
*'''Sending globally enable'''d – if this is checked, you will be able to use Mass Mailing and the system will send emails upon user registration.
*'''SMTP server''' – hostname of the server.
*'''Port''' – port of SMTP server.
*'''Login''' – username to your SMTP server.
*'''Password''' – password to your SMTP server.
*'''Batch size''' – value for Mass Mailing, or how many emails to send at once.
*'''From''' – email address to put into From: field in an email. Acceptable formats are example@email.com or John Smith <example@email.com>.
*'''Test email sending''' – save settings and press this to test email sending. Do not forget to save settings first!

P.S. Remember to set the admin's e-mail in the admin's personal settings. Without this test email sending will not work!
 

 
=Tax=
[[File:M2 Tax.jpg]]
 
*Settings are explained here: [[Multi-Tax system]]
 

=Security=
[[File:M2_settings_security.png]]
 
* '''Use strong passwords for users''' - password must contain at least one numeric value, capital and lowercase symbol, and must at be at least 8 characters long.
* '''Admin login with approved IP only''' - security measure which allows approving IP's that try to [[M4_Login_with_approved_IP%27s|login with Admin Account]].
* '''Enable IP report warning on login failure''' - show [[M4_Login_Failure_Report|warning]] on unsuccessful login attempts.
* '''Logout after password change''' - terminates all sessions of the User whose password is changed.
* '''Do not logout on session IP change''' - do not logout from M4 GUI if IP is changed.
* '''2FA Enabled''' - Enables two factors authentication. Two factors authentication requires entering emailed code during login to the user account. '''2FA Enabled must be also enabled on individual User settings to make it work for that User.'''
** '''Email Template''' - [[M4_Emails|email template]] used to send the code.
** '''Code length (digits)''' - code length.
** '''Code Enter Attempts Allowed''' - number of attempts to enter the code correctly. The code expires after this number of failed attempts.
** '''Code Enter Time Allowed''' - code is valid for this amount of time.
** '''Send Notification Email to Admin on Login''' - allows admin to get email notification on login.
*** '''Email Template''' - [[M4_Emails|email template]] used to notify admin.
*** '''On Admin Login''' - get notification on login to Admin's account.
*** '''On User Login''' - get notification on login to User's accounts.
** '''Send Notification Email on Login''' - allows this mailbox to get email notification on login.
*** '''Email Template''' - [[M4_Emails|email template]] used to notify.
*** '''On Admin Login''' - get notification on login to Admin's account.
*** '''On User Login''' - get notification on login to User's accounts.
 

=Active Calls=
[[File:M2_settings_active_calls.png]]
 

* '''How many maximum [[ M4 Active Calls|Active Calls]] to show in GUI''' – how many to show in GUI
* '''[[ M4 Active Calls|Active Calls]] refresh interval''' – [[ M4 Active Calls|Active Calls]] refresh interval in seconds
* '''Show [[ M4 Active Calls|Active Calls]] for Users''' – tick if you want to allow users to see [[ M4 Active Calls|Active Calls]]
* '''Show Servers in [[ M4 Active Calls|Active Calls]]'''

* '''Show Rates in [[ M4 Active Calls|Active Calls]]''' .
 

=Calls List=
[[File:M2_settings_last_calls.png]]
 
* '''Show Connection Point and its CallerID''' – shows an additional column in [[Last Calls]] page with Connection Point and its CallerID information. Click to reach that Connection Point settings page.
* '''Show CallerID sent to TP'''
* '''Show Answer Time'''
* '''Show End Time'''
* '''Show PDD'''
* '''Show Terminated by'''
* '''Show Duration''' - shows additional Duration column.
* '''Show Release Cause''' - when enabled, the Call List in M4 shows an additional sortable Release Cause column with the SIP release code per call. A Release Cause (SIP) filter is also available on the list.
* '''Show Usernames on PDF/CSV Export Files''' – if checked, when a particular User in the Last Calls page search is selected, the Last Calls PDF/CSV file name will be composed also of the Name of the selected User. If you are looking for All Users, no User Name will be used. (Name of the User will be shown in Name of the CSV/PDF file).
 

=Calls Dashboard=
[[File:M2 Call Dashboard.jpg]]
 
In the System Settings, several adjustments can be made in order to customize the Calls Dashboard.
*'''Calls Dashboard refresh interval''': how often the statistics are updated (a positive integer representing minutes). 
*'''ASR''': as in the example, when lower than 30%, the cells will be colored red, and greater than 50% value will result in a green color. Everything between will be set to yellow (only integers are allowed). 
*'''ACD''': as in the example, when lower than 60 seconds, the cells will be colored red, and greater than 119 seconds value will result in a green color. Everything between will be set to yellow (only integers are allowed). 
*'''Margin''': as in the example, no coloring will be applied on Margin cells. 
 
'''Note:''' partial coloring is also possible. For example, when the ASR is set to Red < 30 and Green > is left blank, only red coloring will be present for the ASR cells.
More information about [[M4 Calls Dashboard]]
 
 

=CDR Management=
This functionality is [[M4 CDR Management#Configuration|described here]].
 

 
=Visual=
[[File:M2 settings visual.png]]
* '''Items per page''' – the number of items to display per one page
* '''[[Global_date_format| Default date format]]''' – System default date format
* '''Default Time Format''' – System default time format
* '''Default Hour Format''' – System default hour format
* '''Number digits''' – how many digits to display after a comma
* '''Currency Amount Number Digits (Decimal Places)''' - how many digits to display after a comma in monetary terms.
* '''Show Full Source (CallerID Name and Number)'''
* '''Default Number Decimal''' – with this option you can set the default number decimal for all GUI.
* '''Show Detailed Quick Stats''' - shows detailed Quick Stats on main page.
* '''Cache ES Sync Status for last''' - caches ES Sync status for last X minutes. If value 0 is entered, then ES Sync Status will be changed with every refresh.
 

=User Settings=
[[File:M4_settings_user_settings.png]]
 

* '''Hide Connection Point passwords for users''' – do not display Connection Point passwords for users.
* '''Show user_billsec for Users instead of billsec''' – shows user_billsec instead of billsec in Users invoices and last calls. Notice that Billsec shows real Call duration, and user_billsec shows Call duration after minimal time or increment applied. For example, if the user tariff has a 60-second minimal time and the user made a Call for 20 sec, then billsec will show 20 sec and user_billsec will show 60 sec (minimal time is applied).
* '''Show Calls statistics to User for last''' – number of Calls statistics to show in days. For example, if you enter 5 days, users will only see 5 days old calls, they will not be able to check older calls.
*'''Change ANSWER to FAILED if HGC not equal to 16 for Users''' – changes the Hangupcause for users in call reports from Answered to Failed if Hangupcause is not 16.
*'''Show User Tariffs without taxes''' – exclude taxes when the User checks his tariffs.

 

=Various=
[[File:M2 settings various.png]]
 

*'''Agreement number length''' – number length in digits.
* '''Server free space limit''' - if server free space is lower than this limit, the warning will be displayed globally and an email sent to the admin every hour. The default value is 20%.
* '''Call Tracing Server''' - which server to use for call tracing. Useful if the GUI server is on a different server than the Radius server.
* '''Delete outdated Rates older than''' - delete rates for which the effective date is older than x days and for which exists the same prefix with the newer effective date. The default is 0, which means never deleting.
* '''Use Tariff currency in CSV export''' - uses tariff currency in CSV export.
* '''Delete Automatic Tariff Import Inbox Messages older than''' - deletes automatic tariff import inbox messages older than set days.

 

=API=
[[File:M2 settings api.png]]
 
* '''Allow API globally''' – should we enable API globally? When it is disabled, all settings below are also disabled and not editable.
* '''Allow GET API''' – should we allow the GET method to be used for API? Good for testing - but do not use in production! It is unsafe.
* '''API Secret Key''' – key to [[MOR API hash construction | generate Hash]]
* '''XML API Extension''' – send XML output with HTML tag - this is used for broken .Net support, keep it unchecked if everything works for you.
* '''Allow API Login Redirect''' – if login is successful the customer will be redirected to MOR billing the Main site.
* '''API Allow Payments''' - Allows to create payments via API
* '''Allow Connection Point to check balance over API''' - Allows Connection Point to check balance over API
* '''Disable hash checking''' – When it is on API functions can be used without sending hash. Default value: off.
* '''Uniquehash''' – admin's unique hash.
'''NOTE''' that M4 does not allow you to enable '''Allow API''' if '''API Secret Key''' is not entered. In such case, you will get a message '''Invalid API secret key'''. '''Enter API Secret Key''' in order to fix this.
 

=Backups=
[[File:M2 settings backups.png]]
 
If Run Backup according below schedule is checked, the following settings become active:

*'''Exclude Archived Calls table''' – archived calls will not be present in the backup (calls_old table will be ignored).
*'''Store Backups on FTP server''' - stores Backups on FTP server. Please fill in FTP server details at [http://wiki.kolmisoft.com/index.php/M4_settings#FTP FTP] tab.
*'''Month''' – in which month backup should be made.
*'''Day of every month''' – which day of every month backup should be made.
*'''Day of week''' – which day of the week backup should be made.
*'''Hour''' – which hour backup should be made?
*'''Keep on local server''' – how many backups to keep on the server. The system deletes the oldest one if the limit is reached.
*'''Don't start backup if disk space less than''' – checks disk space before making an auto backup.
 

=CSV Settings=
[[File:M2 settings csvsettings.png]]
 

* '''CSV Column Separator''' – how columns are separated in imported/exported CSV files.
* '''CSV Decimal Separator''' – how decimal parts in numbers are separated in imported/exported CSV files.
* ''' Archive CSV file when size reaches''' – if the CSV file reaches a certain size, the system will archive it to save time to download it (0 means to archive never)
 

=Server Load=
[[File:M2 settings serverload.png]]
 
Settings for GUI Server and Database Server

* '''HDD utilization higher than''' – Percentage of CPU time during which I/O requests were issued to the device (bandwidth utilization for the device), as reported by '''iostat''' %util column.
* '''CPU General Load higher than''' – Percentage of the CPU for user processes as reported by '''top''' %us column.
* '''CPU Load Stats 1 higher than''' – average load for '''one minute''' on the system as reported by '''top''' command
* '''CPU MySQL process higher than''' – Percentage of the CPU for MySQL process as reported by '''top''' command

 
* '''Delete Server Load Stats older than''' – deletes internal servers load statistics older than a defined number of days.
 

 

=Privacy=
[[File:M2 settings gdpr.png]]
 
* '''GDPR Activated''' – hides User data with notification "Data hidden due GDPR. Press to show data (action will be logged)".
 

=Payments=
[[File:M2_paypal_settings.png]]
 
* '''Activate Paypal Payments''' - yes or no. This will add the PayPal payment menu in the Users accounts Start page.
* '''Paypal Client ID''' - Paypal client ID (provided by Paypal).
* '''Secret Paypal Key''' - key to verify transactions (provided by Paypal).
* '''Default Currency''' - set default PayPal currency.
'''NOTE: Current tab is visible if PayPal addon is activated.'''
 

More details: [[M4 PayPal Addon|PayPal Addon]]

 

[[File:M4_stripe.png]]

More details: [[M4_Stripe|Stripe]]

 

=FTP=
[[File:M2_FTP.png]]
 
Please fill up the FTP server details if you want to store Archived calls and or/and Backups to the FTP server.

* '''IP''' - Enter FTP server IP.
* '''Port''' - Enter FTP server Port.
* '''Username''' - Enter FTP server Username.
* '''Password''' - Enter FTP server Password.
* '''Path for Archived Calls''' - Enter Path for Archived Calls.
* '''Path for Backups''' - Enter path for Backups.
* '''Path for CDR Export''' - Enter path where to export CDRs.
 

=SFTP=
[[File:m4_sftp.png]]
 
Please fill up SFTP server details if you want to use SFTP for [[M4 Automatic CDR Export]].

* '''IP''' - IP of the SFTP server.
* '''Port''' - Port of the SFTP server.
* '''Username''' - Username to connect to SFTP server.
* '''Password''' - Password to connect to SFTP server.
* '''Use SSH key''' - Use SSH key configured as described [[Configure SSH connection between servers|here]].
* '''Path for CDR Export''' - Path in SFTP server where to export CDRs.
 

=Mobile Number Portability=

* More details: [[M4 Mobile Number Portability]]

[[File:mnp_settings.png]]
* '''Use Number Portability''' - Enable number portability.
* '''Server IP''' - The IP address of the MNP server that M4 will connect to.
* '''Port''' - The port number of the MNP server's DB that M4 will connect to.
* '''Username''' - The user name of the account used to connect to the MNP server's DB.
* '''Password''' - The password of the account used to connect to the MNP server's DB.
* '''DB Name''' - The name of MNP DB where MNP data is stored.
* '''Table Name''' - The table name from MNP '''DB Name''' DB where data is stored.
* '''Search Field''' - The name of the column in '''Table Name''' where number will be searched.
* '''Result Field''' - The name of the column in '''Table Name''' from where information about the number's portability will be retrieved.
* '''Supported Prefixes''' - Either '''All Prefixes''' (default) or '''Only these prefixes'''. If the '''Only these prefixes''' option is enabled, only selected prefixes will be active for MNP check.

'''Add to List''' button allows to add prefixes for '''Only these prefixes''' option.

'''Test DB Connection''' button allows us to test the DB connection and check if DB details are correct or not.

 
=Local Number Portability=

* [[M4 Local Number Portability]]

[[File:lnp_settings.png]]
* '''Use Local Number Portability''' - Enable local number portability (in most cases for USA jurisdictional routing)
* '''Server IP''' - The IP address of the LNP server's DB that M4 will connect to.
* '''Port''' - The port number of the LNP server's DB that M4 will connect to.
* '''Username''' - The user name of the account used to connect to the LNP server's DB.
* '''Password''' - The password of the account used to connect to the LNP server's DB.
* '''DB Name''' - The name of LNP DB where LNP data is stored.
* '''Table Name''' - The table name from LNP '''DB Name''' DB where data is stored.
* '''Search Field''' - The name of the column in '''Table Name''' where destination number will be searched.
* '''Result Field''' - The name of the column in '''Table Name''' from where information about the number's local portability (routing number) will be retrieved.
* '''Supported Prefixes''' - Either '''All Prefixes''' (default) or '''Only these prefixes'''. If '''Only these prefixes''' option is enabled, only selected prefixes will be active for LNP check.

'''Add to List''' button allows to add prefixes for '''Only these prefixes''' option.

'''Test DB Connection''' button allows us to test the DB connection and check if DB details are correct or not.

 
=Redis=
* '''Use Redis''' - set to Yes if Redis is available. It is needed for features like Real-time Concurrent Calls / CPS statistics to work.
* '''IP''' - IP of Redis server. Usually, the same as the Radius server.
* '''Port''' - TCP 6379 is the Default port for the Redis server.
 

 
=White Label=
[[File:white_lable_settings.png]]
 
* '''Logo''' - replaces the logo shown in the top left corner. Max size: 125x40, supported types: PNG, JPG.
* '''Favicon''' - replaces icon shown in browsers tab. Max size: 64x64, supported type: ICO.
* '''Footer''' - text is shown at the bottom of the page.
 

=SIP Trunking=
 
[[File:M4_settings_sip_trunking.png]]
 

=DIDs=
 
[[File:M4 Settings DIDs.png]]

File:M2 settings last calls.png

2026-03-23T12:29:04Z

Edvardas: Edvardas uploaded a new version of File:M2 settings last calls.png

File:RateNotificationTemplate3.png

2026-03-23T09:36:25Z

Edvardas: Edvardas uploaded a new version of File:RateNotificationTemplate3.png

M4 two factor authentication

2026-03-17T08:58:00Z

Edvardas:

=Description=
'''Two-factor (2FA) authentication''' improves security by assigning an additional method (factor) for authentication.
M4 supports two methods of Two-factor authentication:
* Sending verification code over email
* Authenticator App, using time-based one-time password (TOTP)

Examples of apps that support TOTP protocol:
* Google Authenticator
* Microsoft Authenticator
* LastPass Authenticator

=Configuration=
==Globally enabling 2FA==
In order to configure 2FA, firstly it must be globally enabled in [[M4_Settings#Security|MAINTENANCE->Settings Security section]].

 [[File:2FAM4globalsettings.png]] 

To enable this setting, email must be [[M4_Settings#Emails|globally enabled]] too.

==Enabling for Users==
Once 2FA is globally enabled, Admin can Enable/Disable 2FA for specific Users in the [[M4_Users#General|User's Details Page]].

 [[File:2FAuserfromadmin.png]] 

==Configuration from User's Account==
If 2FA is enabled by Admin for User, this User can configure 2FA from the '''Personal details''' page:

 [[File:2FAM4userpersonaldetails.png]] 

 [[File:2FAM4userpersonaldetailspage.png]] 

When 2FA is enabled for the User, by default 2FA is set to Email. In this case, no additional configuration is needed.

To Enable 2FA by '''Authenticator app''', the User has to do these steps:
* Set Authentication method to: '''Authenticator app'''
* Press '''UPDATE''' button
* New window will appear where Users can scan QR code or enter the key manually.
 [[File:2FAM4appauthentication.png]] 
* Open Authentication App (Google Authenticator, Microsoft Authenticator, etc) and scan the QR code. If you are unable to scan the QR code, enter the key manually in the App.
* Account will be added to your Authenticator App and App will generate the code that must be entered into the Code section.
* Click '''Submit''' button to verify the operation.

If the operation is successful, Authenticator App 2FA authentication will be enabled and the User will need to enter the code from the App (this code changes every few seconds) on every login.

If the verification operation fails for some reason (the user is unable to add the key to the app, close the browser window, etc), on the next login User will be authenticated using Email 2FA.

==Configuration for System Admin==
Configuration is [[M4_two_factor_authentication#Configuration_from_User's_Account|the same]] as for simple Users and is available from Personal Menu under the Admin account.

[[File:2FAM4adminconfig.png]] 

The only difference is that Admin can disable/enable 2FA for his own account, while a simple User can only change the 2FA type if it is enabled by Admin for the User account.

==Configuration from Mangers==

[[File:2FAM4managerconfig.png]]

File:2FAM4managerconfig.png

2026-03-17T08:57:58Z

Edvardas:

File:2FAM4globalsettings.png

2026-03-17T08:07:08Z

Edvardas: Edvardas uploaded a new version of File:2FAM4globalsettings.png

DID Management

2026-03-16T09:09:54Z

Edvardas: /* Forward */

= Description =

DID is an external number to have incoming calls to your VoIP network reach a particular device.

'''VERY IMPORTANT RULE: DIDs in MOR MUST be in E.164 format.'''

You can reach window, with list of all DIDs, in '''SETTINGS –> Billing –> DIDs''':
 
[[File:Dids updated.png]]
 
User/Dial Plan and Device show who will answer when dialing this DID.

Clicking on User or Device brings you to their settings. If you click on the [[Image:callflow.png]] icon, you will go to the device's [[Call Flow]] window.

In this page you can
*[[DID_Management#Add_new_DID(s) | Add new DID(s)]]
*Reach [[DID_Management#DID_bulk_management | Bulk management]]
*Export DIDs to CSV
*Reach page to change DID [[DID Billing | Rates]]
*Update DID [[DID_Management#Settings | settings]]
*Search only by DID Owner, when using search field called ''Owner'', or search by either DID Owner or DID Reseller at once, when using search field called ''User''.

*Hide Terminated DIDs. When option "Hide Terminated DIDs" is checked, terminated dids will be hidden until option is unchecked. Clear search button or relogin will not clear the checked option.
* Search by User type.
* Search by inclusive Balance range (only for Owners).
* Search by User status (only for Owners).

 

= Special cases =

Single DIDs can be added with a-z or A-Z values.

DID must consist only of 0-9, a-z, A-Z, and begin with a number.

Example DID: 0B69847249887528

'''NOTE:''' when number contains letters and you do not want to cut destination, enable '''clean_destination = 0''' in '''/etc/asterisk/mor.conf'''. 
More information [[Mor.conf]]

 

= Status =
[[Image:dids2.png|right]]
Status is very important. For every just-created DID, the status is Free.

A DID can have several statuses:

* '''Free''' – this status means that the DID is free to be reserved for any user/device. You can also Terminate it.
* '''Reserved''' – the DID is reserved but NOT actually used for a user. "Reserved" is useful at the negotiation stage before signing a contract. When a user decides to sign up, we Activate the DID. We can also make the DID Free.
* '''Active''' – the DID is assigned to a Device and is functional. We can Close it.
* '''Closed''' – the DID is no longer functional, so that all calls going to this DID will get Hangup. One important feature of this state: when a DID is Closed, it will be closed for a set time (the default is 90 days) in case the user changes his mind and decides to use this DID again. This is useful when a user is not paying for services, as we can suspend the DID by using Closed. MOR will make it Free after the Closed period runs out. You can manually make it Free or Terminate this DID.
* '''Terminated''' – the DID is no longer used in MOR. It remains only for historical purposes. You can make it Free if you want.

 

= Add new DID(s) =

In the main DIDs window, if you want to add new DID(s), click on [[Image:add.png]] '''New DID''':

[[Image:dids5.png]]

In this window you can:

# Select DID(s) [[DID_Management#Details | details]]
# Add one DID or series of DIDs
# [[ DID_Import_from_CSV | Import DID(s) from CSV file]]
 
'''NOTE:''' You should select the Provider which sold you this DID. DID Provider is ONLY for informational purposes. If you do not know which Provider to assign - create dummy Provider to represent company from which you buy DID. If this is fake DID - assign any Provider you want. If your DID Provider has several IP addresses (as DIDWW) and you configured several Providers in MOR - assign ANY configured Provider.

 
== VIDEO: How to create a DID ==

<html>
<iframe width="640" height="360" src="https://www.youtube.com/embed/SVJS_stEgBQ" frameborder="0"></iframe>
</html>

 

==Details==

*'''Provider''' – DID Provider is ONLY for informational purposes. If you do not know which Provider to assign - create dummy Provider to represent company from which you buy DID. If this is fake DID - assign any Provider you want. If your DID Provider has several IP addresses (as DIDWW) and you configured several Providers in MOR - assign ANY configured Provider.

*'''Language''' – option to set language for voice prompts in the Asterisk Dial Plan

*'''Call limit''' – describes how many simultaneous calls DID can '''receive'''. 0 (zero) means that calls are unlimited.

*'''Max Call Duration (Timeout)''' – a number of seconds before a Call via DID is terminated ('''NOTE:''' due to a global safeguard Calls are terminated ~3 sec. earlier than this setting).

*'''Comment''' – option to save some notes about DID.

*'''[[Sound files | Sound file]]''' – here you can add [[IVR Greeting for DID]]. There are two options:
# Answer and play.
# Early media.
*'''PIN''' – a numeric PIN code to secure a DID.

*'''PIN retries''' – a number of allowed attempts to enter a PIN code.

*'''[[Sound files | Sound file]] to reenter PIN''' – a Sound File that is played before the next attempt to enter a PIN Code.

*'''MOH instead of Ringing''' – if [[Music on Hold|MOH]] is selected, Music on Hold will be played instead of ringing when DID number is dialled.

*'''[[IVR_system | IVR]] if PIN fails''' – an IVR the Call is transferred to when all attempts to enter a PIN Code fail. '''NOTE:''' when all PIN attempts fail and '''IVR if PIN fails''' is None, a Call is terminated with a [[Hangupcause_Codes|Hangupcause Code]] '''275'''.


*'''Grace Time''' – if call duration is less than Grace Time, it will not be accounted, for example: '''Grace Time''' = 3s, call duration <= 3s, then price for the call = 0


*'''Timeout Digit''' – the maximum amount of time permitted between digits when the user is typing in a number. When this timeout expires after the user has started to type in a number, the number will be considered complete, and will be interpreted (sent to the system). Works both with entering destination and ANI/PIN.


*'''Timeout Response''' – the maximum amount of time permitted for user to START entering a number. If the user does not begin typing a number in this amount of time, system will notify that nothing was entered. Once the user begins to type a number, system will wait for Digit Timeout to be reached, and Response Timeout has no effect no more.


*'''CallerID Name Prefix''' – option to add a CallerID Name prefix to the incoming CallerID.


*'''Tone zone''' – option to set tone zones. Tone zone is a different ring tone depending on destination (country).


*'''Tariff for Calling Card''' – option to set a tariff for DID which will be applied for a calling card. It will not be important what tariff is assigned for that card's group.


*'''Active from''' – DID will become active from this date. If DID is not active yet, call is routed like there is no matching DID number.

*'''Active till''' – DID will be active till this date. Expiration does not change DID status, call is routed like there is no matching DID number.

* '''Blacklist Source Number Pool''' - this will set [[Number Pool]] for Blacklist Source. When calling this DID, if Source Number match number in this pool, call will be rejected with '''HGC 283 - Source number is in DID blacklist'''.

* '''Send call anonymously''' - default no. Ability to show Anonymous on incoming call.

* '''Send CallerID in UUI header''' - default no. The ability to show the caller ID on all calls in Sip UUI messaging.
Header example:
User-to-User: hexCallerid;pd=XX;encoding=hex;purpose=isdn-uui;content=isdn-uui

 
= DID Wildcard =

It is possible to use Wildcard '''*''' to match several DID numbers. 
For example, DID '''37088888*''' would match 37088888'''81''' 37088888'''72''' 37088888'''93''' 37088888'''5555555''', etc. 
'''IMPORTANT''' DID numbers without a Wildcard have higher priority. 
[[File:Did wildcard.png]]

 

= Settings =

If you want to edit a DID's settings, click on the [[Image:edit.png]] icon.
 
[[Image:dids4.png]]
 
The above window is for Free DID. You can:

# Change [[DID_Management#Details | details]]
# [[DID_Management#Reserve_DID_for_User | Reserve DID for User]].
# [[DID_Management#Assign_to_Dial_Plan | Assign to Dial Plan]].
# Terminate a DID.

 

==Reserve DID for User==

When a DID is assigned to a Device (Reserve for User first), you have a few different choices:

[[File:DidAssign5.png]]

Here you can:

# Change [[DID_Management#Details | details]].
# Assign DID to device. Here you can select different Devices for the same user. For select Trunk Device is next section.
# Assign DID to Trunk. Here you can select different Trunk Devices for the same user.
# Stop a DID subscription and reserve the DID for 90 days (by default) to this user in case he changes his mind and wants to get the DID back.

 

==Assign to Dial Plan==

When DID is assigned to [[Dial_Plans | Dial Plan]], in DID settings you can:
# Change [[DID_Management#Details | details]].
# Make DID free.

When you have [[Quickforwards_rules | Quickforward Rule]] for this DID, in DID edit you will see additional notice:

[[Image:DID_edit_collisions_with_qf_rule.png‎]]

 
= Delete DID =

At first, mark it as "not used" (Free). Then terminate it. When you do, you will see [[Image:delete.png]] next to the DID in the main DID window. By clicking on it, you can delete the DID.

'''Note:''' you cannot delete DIDs that are associated with calls. You can only Terminate these DIDs.

 

= DID bulk management =
In the main DIDs window, click [[Image:edit.png]] Bulk Management and you will be able to perform various actions either on:
*'''DIDs interval''' - this will apply action on selected DID interval,
*'''DIDs pattern''' - this will apply action on selected pattern. Supported wildcard symbols in pattern:
** '''%''' matches any symbols, for example '''370%''' will match any number starting with '''370'''
** '''_''' matches one symbol, for example '''370_1334455''' will match numbers in format '''370x1334455''', where '''x''' is any number.
 
[[Image:dids6.png]]
 
Here you can choose which DIDs to update and what to do:
*'''Update''' - option to change some of DID details, Reserve DID for User (only free DIDs can be reserved) or Make DID free.
*'''Delete''' - option to delete DIDs by Provider or make DIDs Free/Terminated/Closed.
*'''Manage rates''' - option to change Rates for [[DID Billing]].
*'''[[Assign DID to Trunk]]'''.

*'''Reserve for User''' - option to reserve DID for User (only free DIDs can be reserved).
*'''Assign Dial Plan''' - option for Assign DID to [[Dial_Plans | Dial Plan]]
 

= Allowing Users to route their DIDs =
Since '''MOR X5''' users are able to route their DID to a Device or an External Server .
This functionality can be enabled in '''SETTINGS -> Setup -> Visual''' by checking the 'Allow User to assign DID to Device:' setting.

Once the functionality is enabled, the user will be able to see an Edit icon, in his DIDs list.
 
[[File:Dids_list_with_did_routing.png‎]]
 

By pressing the icon, the user will be redirected to a page where he will be able to route his DID either to one of his MOR Devices, or to a Device on an external server (eg. SIP/370xxxxxx@123.123.123.123).
 
[[File:Did_routing_panel.png‎]]
 

'''NOTE:''' Reseller's DID list permissions are independent from Resellers' User, this means that Resellers' User can view DID list (if permissions are enabled for them) even when Resellers cannot.
 

= DIDs Call Flow =

DID Call Flows allow you to add a call flow on a specific DID.

Available from '''MOR X18''' with the PBX Addon enabled.

An Accountant needs to have permissions: manage DID and manage PBX functions.

Reseller needs to have a DID assigned to him or his user.

A simple user needs to have DIDs permission enabled and a DID assigned to him.

DID call flow only works with DIDs that are linked to a device.

If call flow is set on both DID and DID Device, then DID call flow will have higher priority - DID Device call flows will be ignored. It does not provide two levels of Call Flow, either only DID Call Flow works (if there is Action on '''any''' State), or only Device Call Flow works (if there is nothing set on DID).

[[File:DIDs_call_flow.png‎]]

A call has several States as:

* '''Before Call''' – call has not reached device.
* '''Call''' – call to device is in progress.
* '''Answered''' – call was answered.
* '''No Answer''' – call was not answered and ended after timeout.
* '''Busy''' – callee was busy.
* '''Failed''' – call to device failed.
 
The possible actions are:

* '''Empty'''
* '''Forward'''
* '''Voicemail'''
 
== Actions ==

=== Empty ===

Empty – means no action should be taken.
 
=== Forward ===

'''Forward to'''

Call can be forwarded to Local device or External number:
 
[[Image:DIDs_call_flow_forward.png]]
 

Using the "forward" action, it is easy to implement:

* '''Unconditional forward''' – when forward is used in the Before Call state.
* '''Forward on no answer/busy/failed''' – when forward is used in No Answer, Busy, or Failed states.
 
'''CallerID options'''

The following options are available to manage CallerID for a forwarded call:

* '''From device''' - puts CallerID from the Device that is forwarding the call (Device assigned to the DID).
* '''Same as comes - unchanged''' - leaves the CallerID as it comes from the original caller.
* '''Same as comes - with Diversion''' - leaves the CallerID as it comes from the original caller and additionally adds SIP header Diversion from the initial SIP To URI. Diversion header can be customized by changing the value in the input field. For example value '''${MOR_SIP_TO};reason=unconditional''' will result in Diversion header with an additional parameter ''';reason=unconditional''' (here '''${MOR_SIP_TO}''' will be expanded to initial SIP To URI <nowiki><sip:xxxxxx></nowiki>). If no value is set, then the default value '''${MOR_SIP_TO}''' (initial SIP To URI) will be used. Other Asterisk/MOR core variables can be used here as well.
* '''Custom''' - enters any CallerID.
 

=== Voicemail ===
 
[[Image:DIDs_call_flow_voicemail.png]]
 
The ''Voicemail Action'' sends the Call directly to the [[Voicemail]]. The Action can be set on ''Before Call'', ''No Answer'', ''Busy'' and/or ''Failed'' states of Callflow.

 

=See Also=

*[[DID Billing]]
*[[DIDs Usage]]
*[[MOR_API_did_create | Create DID through API]]
*[[MOR_API_did_device_assign | Assign Device to DID through API]]
*[[MOR_API_did_device_unassign | Unassign Device from DID through API]]
*[[Providers#Provider_Grace_Time|Provider Grace Time]]
*[[Grace_time|Device Grace Time]]
*[[Example - Configuring DID to ring some Device]]
*[[DID is not working]]
*[[ DID_Import_from_CSV | Import DID(s) from CSV file]]
*[[Number Pool]]

File:DIDs call flow forward.png

2026-03-16T09:07:32Z

Edvardas: Edvardas uploaded a new version of File:DIDs call flow forward.png

File:Warning balance user edit from reseller.png

2026-02-20T08:28:59Z

Edvardas: Edvardas uploaded a new version of File:Warning balance user edit from reseller.png

Warning balance

2026-02-20T08:22:21Z

Edvardas: /* From Reseller Account */

= Description=

This function allows a number of actions to be taken when a user's balance drops lower than the set value.

You can edit '''Warning Balance''' in [[User Details]].

 
== From Admin Account ==

[[Image:Warning balance user edit.png]]
 

Check '''Active''' to activate this function.

Upon activation, the User, Admin, and Responsible Accountant will receive an email when the User balance drops lower than the balance set in the fields after: '''Send email when balance drops lower than'''.

Select when to send such an email and for whom:

* '''Only once when balance drops lower than''' – email will be sent only one time when balance drops lower than defined value.
* '''Every day at''' – an email will be sent every day at a selected time (in user's time zone) while the balance is lower than defined value.

Additionally, you can play an audio message whenever the user makes a call if the balance drops below the setup Warning Balance.

Check '''Play before every call''' and select the audio file to play.

'''Play when balance drops lower than''' lets to set the balance limit for the above option.

Use this with caution - not many users will like this!

* '''Warning Balance Email''' – This Email is used as a primary email to send the Warning Balance email. If this email is empty '''Email''' in the Registration Address section is used.

* '''Admin Webhook''' – together with the Warning Balance email, a request is sent to the specified URL with data according to the URL config. Webhook URL: '''http://''' or '''https://''' required.
 

== From Reseller Account ==

[[Image:Warning_balance_user_edit_from_reseller.png]]
 

Check '''Active''' to activate this function.

Upon activation, the User and Reseller will receive an email when the User's balance drops lower than the balance set in the fields after: '''Send email when balance drops lower than'''.

Select when to send such an email and for whom:

* '''Only once when balance drops lower than''' – email will be sent only one time when balance drops lower than defined value.
* '''Every day at''' – email will be sent every day at a selected time (in user's time zone), while the balance is lower than defined value.

Additionally, you can play an audio message whenever the user makes a call if the balance drops below the setup Warning Balance.

Check '''Play before every call''' and select the audio file to play.

Use this with caution - not many users will like this!

* '''Warning Balance Email''' – This Email is used as a primary email to send the Warning Balance email. If this email is empty '''Email''' in the Registration Address section is used.

 

=Other notes=

*Emails are sent hourly that means that it might take some time for you to receive an email after the balance drops.

 

= See also =

* [[User Details]]

Warning balance

2026-02-20T07:48:40Z

Edvardas: /* From Reseller Account */

= Description=

This function allows a number of actions to be taken when a user's balance drops lower than the set value.

You can edit '''Warning Balance''' in [[User Details]].

 
== From Admin Account ==

[[Image:Warning balance user edit.png]]
 

Check '''Active''' to activate this function.

Upon activation, the User, Admin, and Responsible Accountant will receive an email when the User balance drops lower than the balance set in the fields after: '''Send email when balance drops lower than'''.

Select when to send such an email and for whom:

* '''Only once when balance drops lower than''' – email will be sent only one time when balance drops lower than defined value.
* '''Every day at''' – an email will be sent every day at a selected time (in user's time zone) while the balance is lower than defined value.

Additionally, you can play an audio message whenever the user makes a call if the balance drops below the setup Warning Balance.

Check '''Play before every call''' and select the audio file to play.

'''Play when balance drops lower than''' lets to set the balance limit for the above option.

Use this with caution - not many users will like this!

* '''Warning Balance Email''' – This Email is used as a primary email to send the Warning Balance email. If this email is empty '''Email''' in the Registration Address section is used.

* '''Admin Webhook''' – together with the Warning Balance email, a request is sent to the specified URL with data according to the URL config. Webhook URL: '''http://''' or '''https://''' required.
 

== From Reseller Account ==

[[Image:Warning_balance_user_edit_from_reseller.png]]
 

Check '''Active''' to activate this function.

Upon activation, the User and Reseller will receive an email when the User's balance drops lower than the balance set in the fields after: '''Send email when balance drops lower than'''.

Select when to send such an email and for whom:

* '''Only once when balance drops lower than''' – email will be sent only one time when balance drops lower than defined value.
* '''Every day at''' – email will be sent every day at a selected time (in user's time zone), while the balance is lower than defined value.

Additionally, you can play an audio message whenever the user makes a call if the balance drops below the setup Warning Balance.

Check '''Play before every call''' and select the audio file to play.

Use this with caution - not many users will like this!

* '''Warning Balance Email''' – This Email is used as a primary email to send the Warning Balance email. If this email is empty '''Email''' in the Registration Address section is used.

* '''Admin Webhook''' – together with the Warning Balance email, a request is sent to the specified URL with data according to the URL config. Webhook URL: '''http://''' or '''https://''' required.

 

=Other notes=

*Emails are sent hourly that means that it might take some time for you to receive an email after the balance drops.

 

= See also =

* [[User Details]]

Warning balance

2026-02-20T07:48:27Z

Edvardas: /* From Admin Account */

= Description=

This function allows a number of actions to be taken when a user's balance drops lower than the set value.

You can edit '''Warning Balance''' in [[User Details]].

 
== From Admin Account ==

[[Image:Warning balance user edit.png]]
 

Check '''Active''' to activate this function.

Upon activation, the User, Admin, and Responsible Accountant will receive an email when the User balance drops lower than the balance set in the fields after: '''Send email when balance drops lower than'''.

Select when to send such an email and for whom:

* '''Only once when balance drops lower than''' – email will be sent only one time when balance drops lower than defined value.
* '''Every day at''' – an email will be sent every day at a selected time (in user's time zone) while the balance is lower than defined value.

Additionally, you can play an audio message whenever the user makes a call if the balance drops below the setup Warning Balance.

Check '''Play before every call''' and select the audio file to play.

'''Play when balance drops lower than''' lets to set the balance limit for the above option.

Use this with caution - not many users will like this!

* '''Warning Balance Email''' – This Email is used as a primary email to send the Warning Balance email. If this email is empty '''Email''' in the Registration Address section is used.

* '''Admin Webhook''' – together with the Warning Balance email, a request is sent to the specified URL with data according to the URL config. Webhook URL: '''http://''' or '''https://''' required.
 

== From Reseller Account ==

[[Image:Warning_balance_user_edit_from_reseller.png]]
 

Check '''Active''' to activate this function.

Upon activation, the User and Reseller will receive an email when the User's balance drops lower than the balance set in the fields after: '''Send email when balance drops lower than'''.

Select when to send such an email and for whom:

* '''Only once when balance drops lower than''' – email will be sent only one time when balance drops lower than defined value.
* '''Every day at''' – email will be sent every day at a selected time (in user's time zone), while the balance is lower than defined value.

Additionally, you can play an audio message whenever the user makes a call if the balance drops below the setup Warning Balance.

Check '''Play before every call''' and select the audio file to play.

Use this with caution - not many users will like this!

* '''Warning Balance Email''' – This Email is used as a primary email to send the Warning Balance email. If this email is empty '''Email''' in the Registration Address section is used.

 

=Other notes=

*Emails are sent hourly that means that it might take some time for you to receive an email after the balance drops.

 

= See also =

* [[User Details]]

File:Warning balance user edit from reseller.png

2026-02-20T07:28:06Z

Edvardas: Edvardas uploaded a new version of File:Warning balance user edit from reseller.png

File:Warning balance user edit.png

2026-02-20T07:11:16Z

Edvardas: Edvardas uploaded a new version of File:Warning balance user edit.png

File:Select chan spy device.png

2026-01-19T09:18:18Z

Edvardas: Edvardas uploaded a new version of File:Select chan spy device.png

Spy real-time calls

2026-01-19T09:14:23Z

Edvardas: /* About */

=About=

This functionality is a part of [[Monitorings Addon]] addon and is used to spy user's real-time calls.

MOR user's which are allowed to use this functionality:

* Admin
* Accountant (with Allow Spy Calls (Monitoring) permission)
* Reseller (active calls must be enabled for resellers)
* User (with Active Calls permission)
 

== Use Cases ==

* '''Technical Troubleshooting''' – Service providers and engineers can monitor test calls in real time to identify issues like echo, packet loss, or one-way audio.
* '''Enterprise Quality Assurance''' – Companies can monitor staff calls for quality assurance or regulatory compliance.
* '''Call Center Supervision''' – Supervisors can listen to agents’ calls in real time to evaluate service quality, check compliance, and ensure scripts are followed.
* '''Training & Onboarding''' – Trainers can silently monitor calls of new employees. In "whisper mode," they can coach the agent without the customer hearing.
* '''Live Support Escalation''' – Managers can "barge in" during critical calls to assist agents with difficult situations, ensuring better customer satisfaction.

 
==How this functionality works?==

1. The manager selects a device where he will receive calls from the system when he wants to spy his user (this has to be done only once).

2. Manager configures his phone to be able to answer it.

3. Manager goes to active calls and presses a Spy icon on a desired call:
 
[[File:Active_calls_spy.png]]
 
4. MOR system sends a call to a device set in step 1.

5. Manager answer's the call from the system and is able listen.

Manager can also switch between different SPY modes by pressing:

digit 4 - spy mode (listen only);

digit 5 - whisper mode (spying channel can talk to the spied-on channel);

digit 6 - barge mode (talk to both channels involved in the call).

 
Please note that it is not possible to spy calls if their Server IDs do not match Spy Device Server ID of the user (admin/reseller) who is viewing the calls. Icons for such calls are fainted:
 
[[File:Activecalls spy.png]]
 

==Enable/disable this functionality==

===Enable===

1. For administrator select Spy device in Personal Menu -> Details.

2. For Resellers login as Reseller and go to PERSONAL MENU -> Personal Details.

Select a desired device where you want the system to send a call being spied:
 
[[File:Select_chan_spy_device.png]]
 
===Disable===

You can also globally disable ChanSpy. Go to '''Setup''' -> '''Settings''' -> '''Variuos'''. You will see this setting:

[[File:Chanspy.jpg]]

Tick "Chanspy is disabled globaly:" and click "Save changes"
 

==What is needed to use this feature?==

* '''Admin''': System must have [[Monitorings Addon]]
* '''Reseller''': System must have [[Monitorings Addon]] and [[Active_Calls|active calls must be enabled]] for resellers.
 

==Other setttings==

When spying you '''can press #''' to increase/decrease sound volume.

Available sound levels:

1 2 3 4 -4 -3 -2 -1 '''0'''(default)

'''Here''':

'''-4''' - is the quietest

'''4''' - is the loudest
 
==Limitations==

If you have 2 Asterisk servers in your system, both devices for the "Spy action" have to registered to the same Asterisk server.

If source of few calls is same Device/Provider it is possible to SPY on one of those calls only.

If you have a system with a proxy, Spy functionality will not work.
 

= See also =

* [[Monitorings_Addon|Monitorings addon]]

2026-01-16T11:21:28Z

Edvardas: