Kolmisoft Wiki - User contributions [en]

M4 Quick Stats

2016-03-01T20:00:17Z

Aisteb:

Quick Stats lets you follow your incomes statistics of current month, current day and real time (Active Calls).

These are stats for all Calls made in the system in mentioned periods:
 
[[Image:m2_admin_quick_stats.png]]
 
Also uptime stats are shown for active servers.



Click on the Active Calls value to go to the '''Active Calls''' page for more details. 
Click on the Calls value to go to the '''Last Calls''' page for more details. 
Hold mouse pointer over chosen server line for more details.
 
=See Also=

* [[Active Calls]]
* [[Last Calls]]

File:M2 admin quick stats.png

2016-03-01T19:58:49Z

Aisteb: uploaded a new version of "File:M2 admin quick stats.png"

File:Admin quick stats.png

2016-03-01T19:57:54Z

Aisteb: uploaded a new version of "File:Admin quick stats.png"

File:M2 old calls in file.png

2016-02-26T13:49:12Z

Aisteb:

Archived Calls in Files

2016-02-26T13:31:30Z

Aisteb: /* Files */

=Description=

[[Archived calls]] functionality helps to increase system stability, reliability and speed. Calls archivation into file allows to avoid growing database and lets to use archived calls data mor flexible.
 
=Usage=

==Settings==

Archiving options can be set in '''SETTINGS -> Setup -> Settings -> Calls''' tab:
 
[[File:archived_calls_settings.png]]
 
If ''Archive to File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).
 
==Files==

Files with calls can be found at '''STATISTICS –> Calls –> Archived Calls -> Files'''
 
[[File:old_calls_in_file.png]]
 
'''NOTE''' Files can be reached and managed by '''admin''' only.
 
===Bulk management===

Files can be deleted one by one with click on [[Image:icon_delete.png]] icon in files list or few at a time by selecting period in [[image:icon_edit.png]]'''Bulk management'''
 
[[File:old_calls_in_file_bulk_management.png]]
 

= See Also =

* [[Archived calls]]

File:Old calls in file bulk management.png

2016-02-26T13:30:57Z

Aisteb:

Archived Calls in Files

2016-02-26T13:30:08Z

Aisteb:

=Description=

[[Archived calls]] functionality helps to increase system stability, reliability and speed. Calls archivation into file allows to avoid growing database and lets to use archived calls data mor flexible.
 
=Usage=

==Settings==

Archiving options can be set in '''SETTINGS -> Setup -> Settings -> Calls''' tab:
 
[[File:archived_calls_settings.png]]
 
If ''Archive to File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).
 
==Files==

Files with calls can be found '''STATISTICS –> Calls –> Archived Calls -> Files'''
 
[[File:old_calls_in_file.png]]
 
'''NOTE''' Files can be reached and managed by '''admin''' only.
 
===Bulk management===

Files can be deleted one by one with click on [[Image:icon_delete.png]] icon in files list or few at a time by selecting period in [[image:icon_edit.png]]'''Bulk management'''
 
[[File:old_calls_in_file_bulk_management.png]]
 
= See Also =

* [[Archived calls]]

File:Old calls in file.png

2016-02-26T13:18:16Z

Aisteb:

Archived Calls in Files

2016-02-26T13:16:01Z

Aisteb: Created page with '=Description= Archived calls functionality helps to increase system stability, reliability and speed. Calls archivation into file allows to avoid growing database and lets t…'

=Description=

[[Archived calls]] functionality helps to increase system stability, reliability and speed. Calls archivation into file allows to avoid growing database and lets to use archived calls data mor flexible.
 
=Usage=

==Settings==

Archiving options can be set in '''SETTINGS -> Setup -> Settings -> Calls''' tab:
 
[[File:archived_calls_settings.png]]
 
If ''Archive to File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).
 
==Files==

Files with calls can be found '''STATISTICS –> Calls –> Archived Calls -> Files'''
 
[[File:old_calls_in_file.png]]
 
'''NOTE''' Files can be reached and managed by '''admin''' only.
 
= See Also =

* [[Archived calls]]

Archived calls

2016-02-26T12:56:34Z

Aisteb:

=Description=

When there are many old calls that are no longer useful, they can be archived and moved to other place.

Such house-keeping increases system stability, reliability and speed.
 
=Usage=

==Settings==

Archiving options can be set in '''SETTINGS -> Setup -> Settings -> Calls''' tab:
 
[[File:archived_calls_settings.png]]
 
* '''Archive to''' - choose where to store Archived Calls. By default Archived Calls are stored in another MySQL table ''mor.calls_old''. You can also choose to store [[Archived Calls in Files |Archived Calls in compressed CSV files]] by selecting ''File (TGZ)'' option. If ''File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration). 
* '''Archive Calls older than''' – this is the number of days. When Call is older than the number you set, it will be archived and moved to Archived Calls. 
* '''Archive only ANSWERED calls''' – check to archive only answered Calls. Failed, Busy and No Answer Calls will be deleted. 
* '''Archive Calls every day at''' – when archiving process should be started? Call archiving requires a lot of system resources therefore it is advisable to start archiving when call traffic is low. 
* '''Stop Archiving Calls at''' – when archiving process should be stopped? If is advisable to stop archiving before call traffic is increased. If time is not specified, Call archiving will be stopped when all Calls are archived. 
* '''Delete Calls instead of Archiving''' - if you don't need Calls older than X days, you can delete them instead of archive. 
* '''Delete Archived Calls older than''' - this is the number of days. When '''archived''' Call is older than the number you set, it will be deleted. 

'''NOTE''': you can check the completion of calls archiving process and other information in [[Background_Tasks| Background Tasks]].
 
==Archived Calls==

If calls are stored in another MySQL table ''mor.calls_old'' it can be found at '''STATISTICS –> Calls –> Archived Calls'''
 
[[File:old-calls.png]]
 
Here you can see similar table to Last Calls, so you can check calls information at anytime you want. You can find more information about each field in [[Last Calls]] 

'''NOTE''' Simple Users cannot see Archived Calls page.
 
= See also =


* [[Background_Tasks| Background Task]]
* [[Archived Calls in Files]]

Call list

2016-02-18T08:10:29Z

Aisteb:

Go to '''SETTINGS –> Users'''
 
[[File:Users path.png]]
 
In window below click on the [[Image:icon_calls.png]] to see [[Last Calls]] of selected User.
 
[[File:Users_path_2.png]]
 
=See also=

* [[Last Calls]]

M4 Quick Stats

2016-02-17T07:48:40Z

Aisteb:

Quick Stats lets you follow your incomes statistics of current month, current day and real time (Active Calls).

These are stats for all Calls made in the system in mentioned periods:
 
[[Image:m2_admin_quick_stats.png]]
 


Click on the Active Calls value to go to the '''Active Calls''' page for more details. 
Click on the Calls value to go to the '''Last Calls''' page for more details.
 
=See Also=

* [[Active Calls]]
* [[Last Calls]]

M4 Quick Stats

2016-02-17T07:46:50Z

Aisteb: Created page with 'Quick Stats lets you follow your incomes statistics of current month, current day and real time (Active Calls). These are stats for all Calls made in the system in mentioned per…'

Quick Stats lets you follow your incomes statistics of current month, current day and real time (Active Calls).

These are stats for all Calls made in the system in mentioned periods:
 
[[Image:m2_admin_quick_stats.png]]
 


Click on the Active Calls value to go to the '''Active Calls''' page for more details. 
Click on the Calls value to go to the '''Last Calls''' page for more details.

File:M2 admin quick stats.png

2016-02-17T07:46:34Z

Aisteb:

M4 API quickstats get

2016-02-11T17:26:21Z

Aisteb: /* Description */

=Description=

Retrieves today's [[Quick Stats]] and [[Active Calls]] count 

Data can be retrieved by '''Admin''' only

 

=Usage=

* '''M2''' call: '''/api/quickstats_get'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

* [[MOR API hash construction | hash]] - SHA1 hash constructed using 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'''.
 
===Request===

If API Secret Key = secret

You send:

HTML POST: http://<SERVER_IP>/billing/api/quickstats_get?u=admin&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4

'''* Note that username (u) 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>
<quickstats>
<today>
<calls> Calls count </calls>
<duration> billsec in seconds </duration>
<revenue> revenue today</revenue>
<self_cost> expenditure today</self_cost>
<profit> difference of revenue and expences</profit>
</today>
<active_calls>
<total> Active Calls count </total>
<answered_calls> Answered Calls count </answered_calls>
</active_calls>
</quickstats>
</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 with such username cannot use this method
* <error>Bad login</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>Cannot connect to Elasticsearch</error> – data is not reachable

Example:

<status>
<error>API Requests are disabled</error>
</status>
 
=See also=

* [[M2 API]]

M4 API quickstats get

2016-02-11T17:25:11Z

Aisteb: Created page with '=Description= Retrieves today's Quick Stats and Active Calls count Data can be retrieved just by '''Admin''' =Usage= * '''M2''' call: '''/api/quickstats_…'

=Description=

Retrieves today's [[Quick Stats]] and [[Active Calls]] count 

Data can be retrieved just by '''Admin'''

 
=Usage=

* '''M2''' call: '''/api/quickstats_get'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

* [[MOR API hash construction | hash]] - SHA1 hash constructed using 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'''.
 
===Request===

If API Secret Key = secret

You send:

HTML POST: http://<SERVER_IP>/billing/api/quickstats_get?u=admin&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4

'''* Note that username (u) 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>
<quickstats>
<today>
<calls> Calls count </calls>
<duration> billsec in seconds </duration>
<revenue> revenue today</revenue>
<self_cost> expenditure today</self_cost>
<profit> difference of revenue and expences</profit>
</today>
<active_calls>
<total> Active Calls count </total>
<answered_calls> Answered Calls count </answered_calls>
</active_calls>
</quickstats>
</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 with such username cannot use this method
* <error>Bad login</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>Cannot connect to Elasticsearch</error> – data is not reachable

Example:

<status>
<error>API Requests are disabled</error>
</status>
 
=See also=

* [[M2 API]]

M4 API

2016-02-11T17:06:23Z

Aisteb:

[[File:api.png|right|alt="api"|link=]]
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta>

 
=About=
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.

MOR accepts requests by HTML POST and returns results in XML.

 
=MOR users that are allowed to use MOR API=
* Admin
* Manager - only by using Admin Hash and Secret key
* Simple User

 

=Functions=

== API Related ==
* [[M2 API Configuration]] – configuration options for API.
* [[M2 API hash construction|Hash construction]] – how to construct hash to authenticate data over API.

 
==Balance==
* [[M2 API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
Various methods to retrieve User balance
* [[M2 API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.
* [[M2 Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance

 
==Calls==
* [[M2 user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.

 
==Device==
* [[M2 API devices get | devices_get]] (device_list) – users device list

 
==Login==
* [[M2 API user_login|user_login]] (login) – logs user in to MOR.
* [[M2 API user_logout|user_logout]] (logout) – logs user out from MOR.

 
==Rates==
* [[M2 API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[M2 API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff

 
==Statistics==
* [[M2 API quickstats_get | quickstats_get]] – gets today's [[Quick Stats]] and [[Active Calls]] count

 
==User==
* [[M2 API user_details_get | user_details_get]] (user_details) – gets user details.

 
= Examples =
* [[MOR API PHP Examples]]

 
=HTML POST=
All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username

* username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
 
=Useful to know=

* All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.

 
=See also =
* [[M2 API Configuration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]

User Details

2016-02-04T15:46:27Z

Aisteb: /* 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 window above 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'''.
 

= 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.
* [[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.
* [[Balance and Credit | Balance]] – the user's balance.
* Daily credit limit – Total credit available for user per day. If User reaches this limit all User's calls will be dropped with hangupcause '211 Low balance for user'. This limit is reset each day at midnight (00:00:00).
* [[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?
* [[Simultaneous call limitation | Call Limit]] – how many simultaneous calls the user can make?
* 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.
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. 
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] 
 

= 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]]
 
= Invoices =
 
[[Image:user_invoice_details.png]]
 
* Generate Invoice – should we generate an invoice for this user when we choose to generate invoices for a period?
* Invoice, Detailed, By CallerID, By Destinations and PDF/CSV show various types of invoices which should be showed in Users ''PERSONAL MENU –> Details –> Invoices'' and/or sent to the User as an email attachment.
* Show zero Calls – if the call price = 0, should such calls appear in the invoice or not?
 
= Payments =

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

 
= 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.
 
= 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''
 
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.
 

= Comment =

Here you are able to write private comment about user.

File:Provider-stats.png

2016-02-03T16:25:37Z

Aisteb: uploaded a new version of "File:Provider-stats.png"

File:Provider-stats.png

2016-02-03T16:21:00Z

Aisteb: uploaded a new version of "File:Provider-stats.png"

Invoices

2016-02-01T15:29:51Z

Aisteb:

= Description =

An invoice, bill or tab is a commercial document issued by a seller to a buyer, relating to a sale transaction and indicating the products, quantities, and agreed prices for products or services the seller had provided the buyer.
 
= Configuration =

You can manage Invoices settings, details, Address information and functionality in the Invoices section of the [[Configuration_from_GUI#Invoices | SETTINGS -> Setup -> Settings]] window. 
If you want show user_billsec instead of billsec in Users invoices and last calls, go to [[Configuration_from_GUI#Visual | Settings –> Various]] and check ''Show user_billsec for Users instead of billsec''
 

Go to User's edit page to enable or disable types of invoices he can see in his invoices details. And also these selected types will be the ones that are sent to user via email.

[[File:Invoices_types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number is included in the output data) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:invoices_list_x6.png]]
 
The icons [[Image:icon_check.png]] and [[Image:icon_cross.png]] show whether this invoice is Paid or Unpaid, Sent or Not Sent.
 
'''NOTE''' Each Invoice generated in particular Time Zone and on particular Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for Invoice A exchange rate will be from that day when Invoice was generated (0.5). 

Same calculations with other currencies: 
If you want to see Total price in USD. For Invoice A, B and C the exchange rates will be set from the day when invoice was generated (EUR - 0.5, DZD - 0.25 and ALL - 0.75). 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for Invoice B exchange rate will be from the day when Invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for Invoice C exchange rate will be from the day when Invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 

=Invoice details=

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
Invoice details are shown in Currency which was used to generate Invoice.
 
==General Details==

'''Payment date''' - An option which will set the period of payment on current month. By default ''Years'' and ''Month'' is current, it is only possible to change ''Day of Month'' which is indicating the last date of ''Invoice'' issue. 
'''Currecy of Invoice''' -  Invoices are exported in Invoice currency.

'''Language of Invoice'''
 
Default language in MOR is English. However, you can send invoices in different languages (click on the flag icon on the top of the page).
 

==User Details==

User Details which will be used in xlsx file of invoice. These Details are taken form [[User Details]] and it can be changed manually, but after recalculate it will be reset to same information as it is in [[User Details]].
 
==Files to send or download==

Here you can view the details of all invoices and click on the [[Image:icon_pdf.png]] or [[Image:icon_csv.png]] icons to generate invoice files in PDF or CSV formats accordingly. First icon [[Image:icon_csv.png]] will download a xlsx file.

*'''Invoice XLSX''' xlsx file shows information which are set by you. Check [[Invoices#XLSX_Invoices | XLSX Invoice]]
*'''Invoice''' PDF shows separate services Prices and Total Invoice Prices, CSV shows just Total Invoice Prices.
*'''Invoice detailed''' shows same information like simple Invoice and includes Calls list grouped by Destination.
*'''Invoice by CallerID''' shows Calls list grouped by CallerID.
*'''Invoice Destinations''' shows Calls list grouped by Destination.

You can manage what kind of Invoice should be showed for User and/or sent to User as email attachment in [[User_Details#Invoices |User Details]]. Here you can check ''Show zero Calls'' option if you need to calculate 0 price Calls into Invoices.
 
=== XLSX Invoices ===

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.
Example of template can be downloaded for [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx here].
 
'''Default XLSX template'''

Create a xlsx file. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, describe information taken from Invoice main window and so on. Template '''have to be uploaded in SETTINGS -> Setup -> Settings''', Invoices - XLSX tab setting '''XSLX Template'''
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.
* Check '''Group regular Calls by Destinations''' if you want XLSX file us as detailed Invoice.
 
'''Balance Line settings'''

''Outstanding balance (Debt)'', ''Outstanding balance (Debt) with TAX'', ''Total amount due'' options are present when ''Show balance line'' ('''SETTINGS -> Setup -> Settings''', Invoices - Postpaid - Settings) setting is enabled.
 
'''Configuration for Dynamic information'''

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 invoice. How and what information is displayed can be set same '''SETTINGS -> Setup -> Settings''', Invoices - XLSX tab. Just need to define cell address in correct format.

For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.

=== PDF invoices ===

The layout of PDF invoices is not customizable.

Logos are not supported in PDF invoices.

You can print your invoices on paper with a pre-printed logo if you want to send paper invoices.
 
=== CSV invoices ===

Detailed CSV invoice does not include list of all calls. Please use [[How_to_export_CDRs|CDR export]] if you need list of calls in CSV format.
 

==Comment==
 

Sometimes it is useful to add a comment to the invoice. It can be used in xlsx file also.
 
==Invoice Details==
Click on the Invoice Details icon in the Invoice details page
 
[[Image:Service_details.png]]
 
to get Services Details of the Invoice:
 
[[Image:invoice_services_x6.png]]
 
'''Services:'''
 
* '''SMS''' – quantity and price of SMS sent in selected period. Invoice for Reseller counts all SMS that was sent by his users using price for Reseller. Note, that SMS are included to Invoice only when [[SMS Addon]] is used
* '''DID Owner Cost''' – price for having and using own DID(s)
* '''Subscriptions''' – price of subscription applied to selected period. Period considered as month is from first till last day of month and from concrete day of month till next month one day before selected last month. Eg. from 2013-02-26 till 2013-03-25
* '''Calls''' – quantity and price of outgoing calls
* '''Calls from Users''' – quantity and price of resellers users calls
* '''Calls to DIDs''' – price for calling to DID(s)
 

= Invoice generation =

In the main Invoices window, click [[Image:icon_generate_invoices.png]] '''Generate Invoices''' to generate additional invoices:
 
[[Image:generate_invoices_x6.png]]
 
Select for which users to generate invoices. Prepaid and Postpaid users can have separate details. Also, you can check to generate an invoice for only one particular user. Invoice will be generated if selected User existed at least one day of all Invoice period. When Invoice Generation Task is created, admin can check the progress in [[Background Tasks]].

'''NOTE:''' For Prepaid User after every executed Manual Payment will be generated Invoice automatically. 

'''NOTE:''' If Currency of User is different than default System Currency. All his Invoices will be generated with [[Currencies| Currency]] Exchange Rate of current day. 
'''NOTE:''' When generating invoice, current user details will be used. 
 

= Invoice recalculation =

An invoice cannot be modified after being sent. But if you want to allow recalculations after sending invoices, go to: '''Settings -> Setup -> Settings'''. Then click on the tabs: '''Invoices -> Functionality'''. Select ''Invoice allow recalculate after send'':
 
[[Image:ivoicesnewnew.png]]
 
===Recalculate a group of Invoices===

To recalculate invoices in the main Invoices window click [[Image:icon_generate_invoices.png]] '''Recalculate invoices''':
 
[[Image:recalc.png]]
 
Select which type of Invoices or whose Invoices to recalculate.
 
=== Recalculate a single Invoice ===

If an invoice is not marked as paid - it can be recalculated for the same user, same period. To achieve this - press the marked icon:
 
[[File:Recalculate_single_invoice_x6.png]]
 
= Pay unpaid Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Pay unpaid Invoices''' will appear.
 
[[File:pay_unpaid_invoices.png]]
 
Click '''Pay unpaid Invoices''' and '''All''' unpaid Invoices will be marked as paid. For each marked Invoice Payment will be created.
 

= Send invoices by email (manual) =

Click [[Image:icon_email_send.png]] to open more options to enter the period in which you want to send invoices. Click '''Send''' to send invoices to their Users in this period:
 
[[Image:invoices_send_x6.png]]
 
You can use these settings to choose which users should get an email with the invoice. Using these settings you can send emails in parts.
 
* '''Email sending''' option must be enabled in Email Settings to use this feature
* Tip: you can '''send invoices in parts''' by using text fields to send invoices for users which '''Username, First name, Last name''' or '''Number''' begins with some letters. For example: you have users with usernames john, albert and alex. You want to send invoices only for users whose usernames begins with '''"a"''' so you just have to enter '''"a"''' in a '''Username text field''' to send invoices only to albert and alex.

 
= Generate and send invoices by email (automatically) =

Use [http://wiki.kolmisoft.com/index.php/Cron_actions#Generate_Invoices_and_send_by_Email Cron Actions] to Generate and send Emails automatically.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]
* [[Duplicate value in Cell Address field]]

Emails

2016-02-01T15:29:20Z

Aisteb: /* Where I can find Emails? */

=What are Emails?=

This function is used to send emails to your clients. It can be used to send commercials, notes about service unavailability or anything else – maybe Christmas greetings!
 

=Where I can find Emails?=

This function can be found in '''SETTINGS –> Setup –> Emails''':
 
[[File:emails_path.png]]
 
Here you see emails which are templates for emails about various system messages. The 'test' email is created for demo purposes for mass-mailing.
 
* '''registration_confirmation_for_user''' - User will get after he registers new account via [[Online registration]].
* '''registration_confirmation_for_admin''' - Admin will get after new User is registered.
* '''cyberplat_announce''' - will be sent after [[CyberPlat Payment Gateway | CuberPlat payment]] will be made.
* '''invoices''' - customer will get his [[Invoices|Invoice]] files when they are will be sent [[Invoices#Send_invoices_by_email_.28manual.29|manually]].
* '''calling_cards_data_to_paypal''' - will be sent after [[MOR API card from group sell | card_from_group_sell API method]] usege if email address will be given.
* '''warning_balance_email''' - User will get when balance becomes lower than [[Warning balance]].
* '''recording_new''' - will be sent after new recording is created.
* '''recording_delete''' - will be sent after recording is deleted.
* '''block_when_no_balance''' - will be sent after account is blocked due insufficient balance.
* '''payment_notification_integrations''' - will be sent after MOR has received a payment notification from [[PayPal| PayPal Standard]] which requires a confirmation in order to complete the transaction.
* '''payment_notification_regular''' - will be sent after MOR has received a payment notification from [[Payment_Gateway_Addon |Payment Gateway]] which requires a confirmation in order to complete the transaction.
* '''password_reminder''' - will be sent after MOR has received a [[MOR forgot user password|User password reminder]] request.
* '''warning_balance_email_local''' - Admin or/and Accountant gets warning when Users' balance becomes lower than [[Warning balance]].
* '''server_low_free_space''' - will be sent when free space is to low in some of Servers.
* '''device_changes_announcement''' - will be sent after each modification of Device if "Inform when Devices are created or updated" is checked in [[Configuration_from_GUI#Various|Various]] settings tab.
 
Next is how to [[Image:icon_edit.png]] edit email. Creating email and editing it are very similar processes. Here is how to edit:
 
[[Image:email2.png]]
 
The '''Name''' and '''Subject''' fields are simple. The most important field is '''Message text'''. Here you enter message for the user. Also, you can use the following [[Email_variables|variables]] here:

<%= server_ip %> - Server IP where your users should register their SIP/IAX2 devices.
<%= device_type %> - Used on user registration - shows the device type the user has selected.
<%= device_username %> - Used on user registration - shows the device's username.
<%= device_password %> - Used on user registration - shows device's password.
<%= login_url %> - GUI login url.
<%= login_username %> - User's username to login to GUI.
<%= login_password %> - User's password to login to GUI.
<%= username %> - same as login_username.
<%= first_name %> - First name of the user.
<%= last_name %> - Last name of the user.
<%= full_name %> - First name and last name of the user.

Click on '''Change''' to save any of these variables.

'''Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]'''

In the main window ('''SETTINGS –> Setup –> Emails'''), you can press on [[Image:icon_email.png]] icon to select to which recipients to send this email:

[[Image:email3.png]]

=Additional Notes=
* [[Configuration_from_GUI#Emails|Emails sending]] must be enabled to use this functionality
* Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]

Emails

2016-02-01T15:29:08Z

Aisteb: /* Where I can find Emails? */

=What are Emails?=

This function is used to send emails to your clients. It can be used to send commercials, notes about service unavailability or anything else – maybe Christmas greetings!
 

=Where I can find Emails?=

This function can be found in '''SETTINGS –> Setup –> Emails''':
 
[[File:emails_path.png]]
 
Here you see emails which are templates for emails about various system messages. The 'test' email is created for demo purposes for mass-mailing.
 
* '''registration_confirmation_for_user''' - User will get after he registers new account via [[Online registration]].
* '''registration_confirmation_for_admin''' - Admin will get after new User is registered.
* '''cyberplat_announce''' - will be sent after [[CyberPlat Payment Gateway | CuberPlat payment]] will be made.
* '''invoices''' - customer will get his [[Invoices|Invoice]] files when they are will be sent .[[Invoices#Send_invoices_by_email_.28manual.29|manually]].
* '''calling_cards_data_to_paypal''' - will be sent after [[MOR API card from group sell | card_from_group_sell API method]] usege if email address will be given.
* '''warning_balance_email''' - User will get when balance becomes lower than [[Warning balance]].
* '''recording_new''' - will be sent after new recording is created.
* '''recording_delete''' - will be sent after recording is deleted.
* '''block_when_no_balance''' - will be sent after account is blocked due insufficient balance.
* '''payment_notification_integrations''' - will be sent after MOR has received a payment notification from [[PayPal| PayPal Standard]] which requires a confirmation in order to complete the transaction.
* '''payment_notification_regular''' - will be sent after MOR has received a payment notification from [[Payment_Gateway_Addon |Payment Gateway]] which requires a confirmation in order to complete the transaction.
* '''password_reminder''' - will be sent after MOR has received a [[MOR forgot user password|User password reminder]] request.
* '''warning_balance_email_local''' - Admin or/and Accountant gets warning when Users' balance becomes lower than [[Warning balance]].
* '''server_low_free_space''' - will be sent when free space is to low in some of Servers.
* '''device_changes_announcement''' - will be sent after each modification of Device if "Inform when Devices are created or updated" is checked in [[Configuration_from_GUI#Various|Various]] settings tab.
 
Next is how to [[Image:icon_edit.png]] edit email. Creating email and editing it are very similar processes. Here is how to edit:
 
[[Image:email2.png]]
 
The '''Name''' and '''Subject''' fields are simple. The most important field is '''Message text'''. Here you enter message for the user. Also, you can use the following [[Email_variables|variables]] here:

<%= server_ip %> - Server IP where your users should register their SIP/IAX2 devices.
<%= device_type %> - Used on user registration - shows the device type the user has selected.
<%= device_username %> - Used on user registration - shows the device's username.
<%= device_password %> - Used on user registration - shows device's password.
<%= login_url %> - GUI login url.
<%= login_username %> - User's username to login to GUI.
<%= login_password %> - User's password to login to GUI.
<%= username %> - same as login_username.
<%= first_name %> - First name of the user.
<%= last_name %> - Last name of the user.
<%= full_name %> - First name and last name of the user.

Click on '''Change''' to save any of these variables.

'''Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]'''

In the main window ('''SETTINGS –> Setup –> Emails'''), you can press on [[Image:icon_email.png]] icon to select to which recipients to send this email:

[[Image:email3.png]]

=Additional Notes=
* [[Configuration_from_GUI#Emails|Emails sending]] must be enabled to use this functionality
* Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]

Configuration from GUI

2016-02-01T15:28:29Z

Aisteb: /* See also */

=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
 

== 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.
* '''[[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'''
* '''Invoice Page Limit:''' – invoice will be generated till this page limit. Additional page is added with an explanation that page limit was reached.
 

=== 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.
 
===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.
* '''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. It is required to fill in(correctly) this field if email sending is enabled.
* '''Test email sending''' – save settings and press this to test email sending. Do not forget to save settings first!

'''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'''

* '''Days for DID to close''' – how long to keep DID closed before making it free.
* '''Agreement number length''' – number length in digits.
* '''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.
* '''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.
* '''Enable "Allowed addresses" option for Devices:''' – allows [[Device_settings#Allowed_Addresses | Allowed Addresses]] functionality in Devices settings.
* '''Enable "Allowed addresses" option for Providers:''' – allows Allowed Addresses functionality in Providers settings.
* '''User wholesale tariff enabled''' – enables user wholesale tariffs.
* '''Play IVR for unauthenticated call'''
* '''Banned CLIs default IVR''' – default IVR to route banned numbers.
* '''Do not allow duplicate device user names'''
* '''Do not allow users to change their email addresses'''
* '''Allow short passwords in devices'''
* '''Logout link''' – a user will be redirected to this link after pressing "Logout"
* '''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.
* '''Inform when Devices are created or updated''' – check to get email about every newly created or updated Device.
* '''Show Usernames on PDF/CSV Export Files in Last Calls''' – if checked, when particular User in Last Calls page search is selected, Last Calls PDF/CSV file name will be composed also from Name of selected User. If you are looking for All Users, no User Name will be used. (Name of User will be shown in Name of CSV/PDF file).
* '''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 to create Users or Register users with identical email addresses. After checking this setting you will be not able to check '''Show forgot password''', because this functionality require unique email in all system. Setting can be unchecked if all emails are unique in system.
* '''Allow same IP and Port combinations in multiple Devices''' – allows to create Devices with the same IP and Port combination.
* '''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 be send an email "Server low free space" template which can be found and edited in [[Emails]] page. Default email template for low disk space: "Some of your Servers exceeded free space limit, please investigate."
 

== 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
 
===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.
 

===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]]'''
 

===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.
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.
 

==Privacy==

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

Settings are explained here: [[Privacy_to_hide_Destination_ends|Privacy to hide Destination ends]]
 
== Visual ==

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

* '''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
* '''Number digits''' – how many digits to display after a comma
* '''Hide Quick Stats in Start page''' – hide Quick stats from start page
* '''Hide device passwords for users''' – do not display device passwords for users
* '''Hide HELP banner''' – hide HELP banner in GUI
* '''Hide "I want to" help links'''
* '''[[Remove_Manual_link_from_admin_GUI|Hide "Manual" link]]''' – hides "Manual" link
* '''Show logo on first page''' - untick to hide logo on the start page
* '''Show Full Source (CallerID Name and Number)'''
* '''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)
* '''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''' – turns on '''[[MOR_forgot_user_password | Forgot password]]''' functionality.
* '''Hide Recordings for all users''' – hides recordings for all system users from menu and device settings.
* '''Show recordings with zero billsec''' – shows recordings with zero billsec
* '''[[Last_Calls#Faster_Page_Loading|Count Last Calls total values only after click]]''' – select to load Total Values lines separately in order to dramatically improve Last calls and Old calls loading time.
* '''Default Number Decimal''' – with this option you can set default number decimal for all GUI
* '''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).

* '''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 Device and it's CallerID in Last Calls''' – shows additional column in [[Last Calls]] page with Device and its CallerID information. Click to reach that Device settings 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'''
 
[[Archived calls]]
 

=See also=

* [[Server is overloaded]]

Emails

2016-02-01T15:28:12Z

Aisteb:

=What are Emails?=

This function is used to send emails to your clients. It can be used to send commercials, notes about service unavailability or anything else – maybe Christmas greetings!
 

=Where I can find Emails?=

This function can be found in '''SETTINGS –> Setup –> Emails''':
 
[[File:emails_path.png]]
 
Here you see emails which are templates for emails about various system messages. The 'test' email is created for demo purposes for mass-mailing.
 
* '''registration_confirmation_for_user''' - User will get after he registers new account via [[Online registration]].
* '''registration_confirmation_for_admin''' - Admin will get after new User is registered.
* '''cyberplat_announce''' - will be sent after [[CyberPlat Payment Gateway | CuberPlat payment]] will be made.
* '''invoices''' - customer will get his [[Invoices|Invoice]] files when they are will be sent .[[Invoices_(MOR_X6)#Send_invoices_by_email_.28manual.29|manually]].
* '''calling_cards_data_to_paypal''' - will be sent after [[MOR API card from group sell | card_from_group_sell API method]] usege if email address will be given.
* '''warning_balance_email''' - User will get when balance becomes lower than [[Warning balance]].
* '''recording_new''' - will be sent after new recording is created.
* '''recording_delete''' - will be sent after recording is deleted.
* '''block_when_no_balance''' - will be sent after account is blocked due insufficient balance.
* '''payment_notification_integrations''' - will be sent after MOR has received a payment notification from [[PayPal| PayPal Standard]] which requires a confirmation in order to complete the transaction.
* '''payment_notification_regular''' - will be sent after MOR has received a payment notification from [[Payment_Gateway_Addon |Payment Gateway]] which requires a confirmation in order to complete the transaction.
* '''password_reminder''' - will be sent after MOR has received a [[MOR forgot user password|User password reminder]] request.
* '''warning_balance_email_local''' - Admin or/and Accountant gets warning when Users' balance becomes lower than [[Warning balance]].
* '''server_low_free_space''' - will be sent when free space is to low in some of Servers.
* '''device_changes_announcement''' - will be sent after each modification of Device if "Inform when Devices are created or updated" is checked in [[Configuration_from_GUI#Various|Various]] settings tab.
 
Next is how to [[Image:icon_edit.png]] edit email. Creating email and editing it are very similar processes. Here is how to edit:
 
[[Image:email2.png]]
 
The '''Name''' and '''Subject''' fields are simple. The most important field is '''Message text'''. Here you enter message for the user. Also, you can use the following [[Email_variables|variables]] here:

<%= server_ip %> - Server IP where your users should register their SIP/IAX2 devices.
<%= device_type %> - Used on user registration - shows the device type the user has selected.
<%= device_username %> - Used on user registration - shows the device's username.
<%= device_password %> - Used on user registration - shows device's password.
<%= login_url %> - GUI login url.
<%= login_username %> - User's username to login to GUI.
<%= login_password %> - User's password to login to GUI.
<%= username %> - same as login_username.
<%= first_name %> - First name of the user.
<%= last_name %> - Last name of the user.
<%= full_name %> - First name and last name of the user.

Click on '''Change''' to save any of these variables.

'''Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]'''

In the main window ('''SETTINGS –> Setup –> Emails'''), you can press on [[Image:icon_email.png]] icon to select to which recipients to send this email:

[[Image:email3.png]]

=Additional Notes=
* [[Configuration_from_GUI#Emails|Emails sending]] must be enabled to use this functionality
* Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]

Cron actions

2016-02-01T15:27:32Z

Aisteb: /* Generate Invoices and send by Email */

=Descriptions=
Cron actions is MOR functionality which allows you to do some tasks at a specified time. Currently supported actions are these:

* Change tariff (for Users and/or LCRs)

* Change LCR (for Users)

* Change provider tariff (for Providers)

*  Generate Invoice (for Users)
 
'''NOTE''' that currently only System Admin is allowed yo use this functionality.
 

=Important notes on billing=

MOR takes the call price before the call and uses it to calculate the final price after the call is finished.

Example: User starts a call at 9:58 PM and is talking for 5 minutes, you have an action which changes tariff at 10:00 PM. When call will be finished MOR will bill user using older tariff. If user starts a call after tariff change - he will be charged using the new tariff assigned for him.
 
=Usage=

Go to '''SETTINGS –> Setup –> Settings –> Cron actions''':
 
[[File:Cron_actions_path.png]]
 
Here you will find list of all Cron Actions
 
[[File:Cron_settings_list.png]]
 
Click [[Image:icon_add.png]]'''Add new Cron Action''' to create new Cron Action.
 
==Change tariff==

''Here is an example with an action '''Change tariff''' (applied for Users)''
 
[[File:Cron_actions_settings.png]]
 
'''Name''' – enter here something that will help you to remember what this settings is about

'''Action''' – what to do. To change Tariff for User, choose '''Change tariff'''

'''For User''' – for which User/Users action has to be applied

'''Where current Tariff is''' – for All Users and Location Rules where selected Tariff/Tariffs assigned.

'''Change to Tariff''' – which tariff to set

'''Periodic type''' – how often to perform the task

'''Repeat forever''' – makes action never stop

'''From''' – when to start doing the action

'''Till''' – when to stop doing the action

'''Description''' – you can use this field for your notes
 

==Generate Invoices and send by Email ==


''Here is an example with an action '''Generate Invoice''' (applied for Users)''
 
[[File:Cron_actions_settings2.png]]
 

'''General'''

* '''Name''' – enter here something that will help you to remember what this settings is about

* '''Action''' – what to do. To generate Invoice for User, choose '''Generate Invoice'''

'''Details''' – Invoice Details

* '''User''' – for which User/Users action has to be applied

* '''Currency''' – currency which will be used for Invoice generation

* '''From''' – day of the month which should be used as '''start of Invoice period'''

* '''Till''' – day of the month which should be '''end of Invoice period'''

* '''Send after Invoice is generated?''' – if email sending is enabled, you can choose to send Invoices after it is generated.

'''Repeat''' – Cron Action repetition

* '''Periodic type''' – how often to perform the task

* '''Repeat forever''' – makes action never stop

* '''From''' – when to start doing the action

* '''Till''' – when to stop doing the action

'''Description''' – you can use this field for your notes
 
[[Background Tasks|Background task]] for [[Invoices#Invoice_generation|Invoice generation]] will be created 2 days after each end of selected Invoice period. Repetition period determines when tasks have to be created.

For example, we want to generate Invoices every month for full month from 2015 October 1 until 2016 January 1.

* In '''Details''' section we select '''From''' - 1 and '''Till''' - 31
* In '''Reapeat''' section we select '''Periodic type''' - monthly, '''From''' 2015 October 1 00 '''Till''' 2016 January 1 00
* When '''Create''' button is pressed at 2015 October 2 we will find Invoices of September

'''NOTE''' If Repetition start date and time is over 48 hours after nearest end of selected Invoice period, first group of Incvoices will be generated more than after one month.

 

=See also=

* [[Users]]
* [[LCR]]
* [[Providers]]
* [[Tariffs]]
* [[Invoices]]

Invoices

2016-02-01T15:25:49Z

Aisteb: moved Invoices (MOR X6) to Invoices

= Description =

An invoice, bill or tab is a commercial document issued by a seller to a buyer, relating to a sale transaction and indicating the products, quantities, and agreed prices for products or services the seller had provided the buyer.
 
= Configuration =

You can manage Invoices settings, details, Address information and functionality in the Invoices section of the [[Configuration_from_GUI#Invoices | SETTINGS -> Setup -> Settings]] window. 
If you want show user_billsec instead of billsec in Users invoices and last calls, go to [[Configuration_from_GUI#Visual | Settings –> Various]] and check ''Show user_billsec for Users instead of billsec''
 

Go to User's edit page to enable or disable types of invoices he can see in his invoices details. And also these selected types will be the ones that are sent to user via email.

[[File:Invoices_types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number is included in the output data) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:invoices_list_x6.png]]
 
The icons [[Image:icon_check.png]] and [[Image:icon_cross.png]] show whether this invoice is Paid or Unpaid, Sent or Not Sent.
 
'''NOTE''' Each Invoice generated in particular Time Zone and on particular Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for Invoice A exchange rate will be from that day when Invoice was generated (0.5). 

Same calculations with other currencies: 
If you want to see Total price in USD. For Invoice A, B and C the exchange rates will be set from the day when invoice was generated (EUR - 0.5, DZD - 0.25 and ALL - 0.75). 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for Invoice B exchange rate will be from the day when Invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for Invoice C exchange rate will be from the day when Invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 

=Invoice details=

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
Invoice details are shown in Currency which was used to generate Invoice.
 
==General Details==

'''Payment date''' - An option which will set the period of payment on current month. By default ''Years'' and ''Month'' is current, it is only possible to change ''Day of Month'' which is indicating the last date of ''Invoice'' issue. 
'''Currecy of Invoice''' -  Invoices are exported in Invoice currency.

'''Language of Invoice'''
 
Default language in MOR is English. However, you can send invoices in different languages (click on the flag icon on the top of the page).
 

==User Details==

User Details which will be used in xlsx file of invoice. These Details are taken form [[User Details]] and it can be changed manually, but after recalculate it will be reset to same information as it is in [[User Details]].
 
==Files to send or download==

Here you can view the details of all invoices and click on the [[Image:icon_pdf.png]] or [[Image:icon_csv.png]] icons to generate invoice files in PDF or CSV formats accordingly. First icon [[Image:icon_csv.png]] will download a xlsx file.

*'''Invoice XLSX''' xlsx file shows information which are set by you. Check [[Invoices_(MOR_X6)#XLSX_Invoices | XLSX Invoice]]
*'''Invoice''' PDF shows separate services Prices and Total Invoice Prices, CSV shows just Total Invoice Prices.
*'''Invoice detailed''' shows same information like simple Invoice and includes Calls list grouped by Destination.
*'''Invoice by CallerID''' shows Calls list grouped by CallerID.
*'''Invoice Destinations''' shows Calls list grouped by Destination.

You can manage what kind of Invoice should be showed for User and/or sent to User as email attachment in [[User_Details#Invoices |User Details]]. Here you can check ''Show zero Calls'' option if you need to calculate 0 price Calls into Invoices.
 
=== XLSX Invoices ===

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.
Example of template can be downloaded for [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx here].
 
'''Default XLSX template'''

Create a xlsx file. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, describe information taken from Invoice main window and so on. Template '''have to be uploaded in SETTINGS -> Setup -> Settings''', Invoices - XLSX tab setting '''XSLX Template'''
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.
* Check '''Group regular Calls by Destinations''' if you want XLSX file us as detailed Invoice.
 
'''Balance Line settings'''

''Outstanding balance (Debt)'', ''Outstanding balance (Debt) with TAX'', ''Total amount due'' options are present when ''Show balance line'' ('''SETTINGS -> Setup -> Settings''', Invoices - Postpaid - Settings) setting is enabled.
 
'''Configuration for Dynamic information'''

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 invoice. How and what information is displayed can be set same '''SETTINGS -> Setup -> Settings''', Invoices - XLSX tab. Just need to define cell address in correct format.

For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.

=== PDF invoices ===

The layout of PDF invoices is not customizable.

Logos are not supported in PDF invoices.

You can print your invoices on paper with a pre-printed logo if you want to send paper invoices.
 
=== CSV invoices ===

Detailed CSV invoice does not include list of all calls. Please use [[How_to_export_CDRs|CDR export]] if you need list of calls in CSV format.
 

==Comment==
 

Sometimes it is useful to add a comment to the invoice. It can be used in xlsx file also.
 
==Invoice Details==
Click on the Invoice Details icon in the Invoice details page
 
[[Image:Service_details.png]]
 
to get Services Details of the Invoice:
 
[[Image:invoice_services_x6.png]]
 
'''Services:'''
 
* '''SMS''' – quantity and price of SMS sent in selected period. Invoice for Reseller counts all SMS that was sent by his users using price for Reseller. Note, that SMS are included to Invoice only when [[SMS Addon]] is used
* '''DID Owner Cost''' – price for having and using own DID(s)
* '''Subscriptions''' – price of subscription applied to selected period. Period considered as month is from first till last day of month and from concrete day of month till next month one day before selected last month. Eg. from 2013-02-26 till 2013-03-25
* '''Calls''' – quantity and price of outgoing calls
* '''Calls from Users''' – quantity and price of resellers users calls
* '''Calls to DIDs''' – price for calling to DID(s)
 

= Invoice generation =

In the main Invoices window, click [[Image:icon_generate_invoices.png]] '''Generate Invoices''' to generate additional invoices:
 
[[Image:generate_invoices_x6.png]]
 
Select for which users to generate invoices. Prepaid and Postpaid users can have separate details. Also, you can check to generate an invoice for only one particular user. Invoice will be generated if selected User existed at least one day of all Invoice period. When Invoice Generation Task is created, admin can check the progress in [[Background Tasks]].

'''NOTE:''' For Prepaid User after every executed Manual Payment will be generated Invoice automatically. 

'''NOTE:''' If Currency of User is different than default System Currency. All his Invoices will be generated with [[Currencies| Currency]] Exchange Rate of current day. 
'''NOTE:''' When generating invoice, current user details will be used. 
 

= Invoice recalculation =

An invoice cannot be modified after being sent. But if you want to allow recalculations after sending invoices, go to: '''Settings -> Setup -> Settings'''. Then click on the tabs: '''Invoices -> Functionality'''. Select ''Invoice allow recalculate after send'':
 
[[Image:ivoicesnewnew.png]]
 
===Recalculate a group of Invoices===

To recalculate invoices in the main Invoices window click [[Image:icon_generate_invoices.png]] '''Recalculate invoices''':
 
[[Image:recalc.png]]
 
Select which type of Invoices or whose Invoices to recalculate.
 
=== Recalculate a single Invoice ===

If an invoice is not marked as paid - it can be recalculated for the same user, same period. To achieve this - press the marked icon:
 
[[File:Recalculate_single_invoice_x6.png]]
 
= Pay unpaid Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Pay unpaid Invoices''' will appear.
 
[[File:pay_unpaid_invoices.png]]
 
Click '''Pay unpaid Invoices''' and '''All''' unpaid Invoices will be marked as paid. For each marked Invoice Payment will be created.
 

= Send invoices by email (manual) =

Click [[Image:icon_email_send.png]] to open more options to enter the period in which you want to send invoices. Click '''Send''' to send invoices to their Users in this period:
 
[[Image:invoices_send_x6.png]]
 
You can use these settings to choose which users should get an email with the invoice. Using these settings you can send emails in parts.
 
* '''Email sending''' option must be enabled in Email Settings to use this feature
* Tip: you can '''send invoices in parts''' by using text fields to send invoices for users which '''Username, First name, Last name''' or '''Number''' begins with some letters. For example: you have users with usernames john, albert and alex. You want to send invoices only for users whose usernames begins with '''"a"''' so you just have to enter '''"a"''' in a '''Username text field''' to send invoices only to albert and alex.

 
= Generate and send invoices by email (automatically) =

Use [http://wiki.kolmisoft.com/index.php/Cron_actions#Generate_Invoices_and_send_by_Email Cron Actions] to Generate and send Emails automatically.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]
* [[Duplicate value in Cell Address field]]

Duplicate value in Cell Address field

2016-02-01T15:25:14Z

Aisteb: /* See also */

If you see error '''Duplicate value in Cell Address field''' when editing any settings at ''SETTINGS -> Setup -> Settings'', it means that you have duplicate values at ''SETTINGS -> Setup -> Settings -> Invoices -> XLSX''.
 
To solve the issue, please go to ''SETTINGS -> Setup -> Settings -> Invoices -> XLSX'' and check for duplicate values, as shown in the picture below.
[[File:Duplicate lines.png]]
 
Please change the fields, so no duplicated would be present.

=See also=

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

MOR API user register

2016-01-25T11:00:14Z

Aisteb: /* Returns */

=Description=


[[MOR API]] Create new user from params.
 
=Usage=

* Call: /api/user_register
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

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

* '''email''' - New user email. '''Required'''.
* '''id''' - User UNIQUEHASH in MOR database. '''Required'''. If uniquehash is not used, user will end up at admin account.
Uniquehash can be found in SETTINGS –> Setup –> Settings –> API tab (last setting) or after log out of MOR in the address field of the browser, for example:
http://SERVERIP/billing/callc/login/kljsdfg54kl where kljsdfg54kl is the uniquehash.
* '''device_type''' - Device type [SIP, IAX2]. '''Required'''.
* '''username''' - New user username. '''Required'''.
* '''first_name''' - New user first name. '''Required'''.
* '''last_name''' - New user last name. '''Required'''.
* '''caller_id''' - CallerID for Device (It can include letters, numbers and signs. If empty value is passed CallerID will be used the same as in Default User settings. If empty in Default User settings and in request - it will not be used).
* '''state'''
* '''device_location_id'''
* '''lcr_id'''
'''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''' which are listed above. 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''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''password''' - New user password. '''Required'''.
* '''password2''' - New user password confirmation. '''Required'''.
* '''country_id''' - New user country (please check table below). '''Required'''.
* '''mob_phone''' - Mobile phone number.
* '''phone - Phone number.
* '''fax''' - Fax.
* '''client_id''' - Company/Personal ID.
* '''vat_number''' - TAX Registration Number.
* '''county'''
* '''city'''
* '''postcode''' - Postcode/ZIP.
* '''address'''
* '''usertype'''
* '''permission_group''' - Reseller or Accountant Permission Group (depending what usertype is sended)
* '''accounting_number''' - Accounting Number
* '''call_limit''' - Call limit (how many simultaneous Calls the new User can make by default?)
* '''credit_limit''' - Credit limit
* '''tariff''' - Tariff ID from database.
* '''currency_id''' - Currency ID from database.
 

===Request===

HTML POST: http://<SERVER_IP>/billing/api/user_register?id=kljsdfg54kl&username=username&password=pass&password2=pass&first_name=first
&last_name=last&country_id=10&email=email@email.com&device_type=SIP&hash=sd5g16sd1g6s
 

===Returns===

'''Success'''

<page>
<status>
<success>Registration successful</success>
</status>
<user_device_settings>
<email>Registration email</email> - If email sending enabled.
<user_id> user id</user_id> 
<device_type> device type [SIP|IAX2]</device_type>
<device_id> device id </device_id> 
<username> device username </username>
<password> device password </password>
<pin> device pin </pin>
<server_ip> Asterisk Server IP </server_ip>
<registration_notice> Registration notice which is set in Settings </registration_notice>
</user_device_settings>
</page>
 
----
'''Errors'''

* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Registration over API is disabled</error> - Setting: Settings->API->API allow Registration, is off. Turn on API allow Registration.
* <error>Access Denied</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.
* <error>Please enter username</error> - Params username is not send. Enter correct username.
* <error>Enter device type</error> - device_type is not send. Enter correct device_type.
* <error>Such username is already taken</error> - Duplicate of username. Change username.
* <error>Passwords do not match</error> - Enter correct passwords.
* <error>Password must be longer than (...) characters</error> - Enter correct password.
* <error>Please enter first name</error> - Enter first_name.
* <error>Please enter last name</error> - Enter last_name.
* <error>Please select country</error> - Enter country_id.
* <error>Please enter email</error> - Email address is not valid or not send. Enter correct email.
* <error>This email address is already in use</error> - Change email address.
* <error>User with mobile phone already exists</error> - Change mobile phone.
* <error>User with phone already exists</error> - Change phone.
* <error>User with fax already exists</error> - Change fax.
* <error>Default user is not present</error> - [[Default_user | Default User's]] settings are not saved in database.
* <error>LCR was not found</error> - LCR id incorrect or does not exist
* <error>Location was not found</error> - Location id incorrect or does not exist
* <error>Password must be longer than 7 characters or short passwords in Devices should be allowed</error> - Use longer password or allow short passwords in devices
* <error>Password must contain at least one numeric value, capital and lowercase symbol - Use more secure password with at least one numeric value, capital and lowercase symbol
 

=== List of Country IDs ===

1 - Afghanistan

2 - Albania

3 - Algeria

4 - American Samoa

5 - Andorra

6 - Angola

7 - Anguilla

8 - Antarctica

9 - Antigua And Barbuda

10 - Argentina

11 - Armenia

12 - Aruba

13 - Australia

14 - Austria

15 - Azerbaijan

16 - Bahamas

17 - Bahrain

18 - Bangladesh

19 - Barbados

20 - Belarus

21 - Belgium

22 - Belize

23 - Benin

24 - Bermuda

25 - Bhutan

26 - Bolivia

27 - Bosnia And Herzegovina

28 - Botswana

30 - Brazil

32 - Brunei Darussalam

33 - Bulgaria

34 - Burkina Faso

35 - Burundi

36 - Cambodia

37 - Cameroon

38 - Canada

39 - Cape Verde

40 - Cayman Islands

41 - Central African Republic

42 - Chad

43 - Chile

44 - China

45 - Christmas Island

46 - Cocos (Keeling) Islands

47 - Colombia

48 - Comoros

49 - Congo

50 - Congo, The Democratic Republic Of The

51 - Cook Islands

52 - Costa Rica

53 - Ivory Cost

54 - Croatia

55 - Cuba

56 - Cyprus

57 - Czech Republic

58 - Denmark

59 - Djibouti

60 - Dominica

61 - Dominican Republic

62 - Ecuador

63 - Egypt

64 - El Salvador

65 - Equatorial Guinea

66 - Eritrea

67 - Estonia

68 - Ethiopia

69 - Falkland Islands (Malvinas)

70 - Faroe Islands

71 - Fiji

72 - Finland

73 - France

74 - French Guiana

75 - French Polynesia

77 - Gabon

78 - Gambia

79 - Georgia

80 - Germany

81 - Ghana

82 - Gibraltar

83 - Greece

84 - Greenland

85 - Grenada

86 - Guadeloupe

87 - Guam

88 - Guatemala

89 - Guinea

90 - Guinea-Bissau

91 - Guyana

92 - Haiti

94 - Vatican City

95 - Honduras

96 - Hong Kong

97 - Hungary

98 - Iceland

99 - India

100 - Indonesia

101 - Iran

102 - Iraq

103 - Ireland

104 - Israel

105 - Italy

106 - Jamaica

107 - Japan

108 - Jordan

109 - Kazakhstan

110 - Kenya

111 - Kiribati

112 - Korea, Democratic People's Republic Of

113 - Korea, Republic of

114 - Kuwait

115 - Kyrgyzstan

116 - Laos

117 - Latvia

118 - Lebanon

119 - Lesotho

120 - Liberia

121 - Libyan Arab Jamahiriya

122 - Liechtenstein

123 - Lithuania

124 - Luxembourg

125 - Macao

126 - Macedonia

127 - Madagascar

128 - Malawi

129 - Malaysia

130 - Maldives

131 - Mali

132 - Malta

133 - Marshall islands

134 - Martinique

135 - Mauritania

136 - Mauritius

137 - Mayotte

138 - Mexico

139 - Micronesia

140 - Moldova

141 - Monaco

142 - Mongolia

143 - Montserrat

144 - Morocco

145 - Mozambique

146 - Myanmar

147 - Namibia

148 - Nauru

149 - Nepal

150 - Netherlands

151 - Netherlands Antilles

152 - New Caledonia

153 - New Zealand

154 - Nicaragua

155 - Niger

156 - Nigeria

157 - Niue

158 - Norfolk Island

159 - Northern Mariana Islands

160 - Norway

161 - Oman

162 - Pakistan

163 - Palau

164 - Palestine

165 - Panama

166 - Papua New Guinea

167 - Paraguay

168 - Peru

169 - Philippines

171 - Poland

172 - Portugal

173 - Puerto Rico

174 - Qatar

175 - Reunion

176 - Romania

177 - Russian Federation

178 - Rwanda

179 - Saint Helena

180 - Saint Kitts And Nevis

181 - Saint Lucia

182 - Saint Pierre And Miquelon

183 - Saint Vincent And The Grenadines

184 - Samoa

185 - San Marino

186 - Sao Tome And Principe

187 - Saudi Arabia

188 - Senegal

189 - Seychelles

190 - Sierra Leone

191 - Singapore

192 - Slovakia

193 - Slovenia

194 - Solomon Islands

195 - Somalia

196 - South Africa

198 - Spain

199 - Sri Lanka

200 - Sudan

201 - Suriname

203 - Swaziland

204 - Sweden

205 - Switzerland

206 - Syrian Arab Republic

207 - Taiwan

208 - Tajikistan

209 - Tanzania

210 - Thailand

212 - Togo

213 - Tokelau

214 - Tonga

215 - Trinidad And Tobago

216 - Tunisia

217 - Turkey

218 - Turkmenistan

219 - Turks And Caicos Islands

220 - Tuvalu

221 - Uganda

222 - Ukraine

223 - United Arab Emirates

224 - United Kingdom

225 - United States

227 - Uruguay

228 - Uzbekistan

229 - Vanuatu

230 - Venezuela

231 - Vietnam

232 - Virgin Islands, British

233 - Virgin Islands, U.S.

234 - Wallis And Futuna

236 - Yemen

238 - Zambia

239 - Zimbabwe

240 - Ascension Island

241 - Diego Garcia

242 - Inmarsat

243 - East Timor

246 - Iridium

247 - Serbia and Montenegro

250 - Emsat

251 - Ellipso-3

252 - Globalstar

253 - Montenegro

254 - Kosovo

255 - South Sudan

256 - Thuraya

If you added new Direction you can find its ID in SETTINGS -> Billing -> Directions page '''Directions edit''' or '''Destinations list''' URL end:
 
[[File:directions_id.png]]
 
=See also=

* [[MOR API]]

MOR API user details get

2016-01-19T08:59:54Z

Aisteb: /* Returns */

=Description=

[[MOR API]] user details

'''Admin''' – can get any user details 
'''Reseller''' – can get his and his users details. 
'''User''' – can get his own details. 
 
=Usage=

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

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

* '''user_id''' - Users ID in MOR database. '''Required if username is not used'''. Type: INTEGER
* '''username''' - Users Username in MOR database. '''Required if user_id is not used'''.

You are able to use these parameter one by one or both at a time. If you use them both at a time '''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''' which are listed above. You are able to use these parameter one by one or both at a time. If you use them both at a time 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''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.

===Request===

We have user_id = 123, API Secret Key = 456789

We send:

HTML POST: http://<server_ip>/billing/api/user_details_get?u=username&user_id=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

We have username = username, API Secret Key = 456789

We send:

HTML POST: http://<server_ip>/billing/api/user_details_get?u=username&username=username&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

We have user_id = 123, username = username, API Secret Key = 456789

We send:

HTML POST: http://<server_ip>/billing/api/user_details_get?u=username&user_id=123&username=username&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

'''* Note that username and password are not included in hash'''
 

===Returns===

'''Success'''

<page>
<pagename>Personal_details</pagename>
<language>en</language>
<userid> user id </userid>
<details>
<main_detail>
<account>Postpaid/Prepaid</account>
<balance> balance and currency </balance>
<balance_number> balance </balance_number>
<balance_currency> currency </balance_currency>
<credit> credit </credit>
<pbx_pool_id> id </pbx_pool_id>
<hide_non_answered_calls> 0 - off/1 - on </hide_non_answered_calls>
</main_detail>
<other_details>
<username> username </username>
<first_name> first name </first_name>
<surname> last name </surname>
<personalid></personalid>
<agreement_number> </agreement_number>
<agreement_date> </agreement_date>
<taxation_country> </taxation_country>
<vat_reg_number> </vat_reg_number>
<vat_percent> </vat_percent>
<call_limit> </call_limit>
</other_details>
<registration>
<reg_address></reg_address>
<reg_postcode></reg_postcode>
<reg_city></reg_city>
<reg_country></reg_country>
<reg_state></reg_state>
<reg_direction></reg_direction>
<reg_phone></reg_phone>
<reg_mobile></reg_mobile>
<reg_fax></reg_fax>
<reg_email></reg_email>
</registration>
</details>
</page>
 
----

'''Errors'''

* <error>User was not found</error> - User was not found using user_id and/or username. Use correct user_id and/or username.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
 

=See also=

* [[MOR API]]

User Details

2016-01-14T17:29:05Z

Aisteb: /* 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_list.png]] 
 
Select the [[image:icon_edit.png]] icon in window above 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'''.
 

= 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.
* [[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.
* [[Balance and Credit | Balance]] – the user's balance.
* Daily credit limit – Total credit available for user per day. If User reaches this limit all User's calls will be dropped with hangupcause '211 Low balance for user'. This limit is reset each day at midnight (00:00:00).
* [[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?
* [[Simultaneous call limitation | Call Limit]] - how many simultaneous calls the user can make?
* Responsible accountant – dropdown to choose accountant responsible for user's profit.
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. 
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] 
 

= 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]]
 
= Invoices =
 
[[Image:user_invoice_details.png]]
 
* Generate Invoice – should we generate an invoice for this user when we choose to generate invoices for a period?
* Invoice, Detailed, By CallerID, By Destinations and PDF/CSV show various types of invoices which should be showed in Users ''PERSONAL MENU –> Details –> Invoices'' and/or sent to the User as an email attachment.
* Show zero Calls – if the call price = 0, should such calls appear in the invoice or not?
 
= Payments =

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

 
= 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.
 
= 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''
 
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.
 

= Comment =

Here you are able to write private comment about user.

MOR API did details update

2016-01-14T17:06:50Z

Aisteb:

=Description=

[[MOR API]] DID details update

Please note that only admin, accountant(with device management) with permission and reseller can use this API.
 
=Usage=

* Call: /api/did_details_update
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameter which is '''included''' into hash:

* '''did_id''' – this is id of DID which have to be updated. '''Required'''.

'''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 '''did_id''' and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* '''u''' – username to login. '''Required'''.
* '''call_limit''' – call limit of did which will be updated. '''Optional'''
* '''did_user_id''' – User ID from database whom DID should be assigned. '''Just free DID can be assigned to User.''' DID can be assigned to Reseller or simple User. Set -1 to make DID free. '''Optional'''
 
===Request===

We have API Secret Key = secret, did_id = 6511 
We send:

HTML POST: http://<server_ip>/billing/api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46

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

===Returns===

'''Success'''

<page>
<status>
<success>DID details successfully updated</success>
</status>
</page>

'''After successfully updating DID action log record is added.'''
 
----
'''Errors'''
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Call limit is incorrect format</error> – Specified call limit has to be 0 or positive number.
* <error>DID is already assigned</error> – DID is already assign to other User, Reseller or Dial Plan.
* <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).
 

=See also=

* [[MOR API]]

Configuration from GUI

2016-01-13T14:49:50Z

Aisteb: /* Visual */

=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
 

== 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.
* '''[[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'''
* '''Invoice Page Limit:''' – invoice will be generated till this page limit. Additional page is added with an explanation that page limit was reached.
 

=== 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.
 
===See also===

* [[Invoices]]
* [[Invoice configuration]]
* [[Invoices (MOR X6)]]
 

== 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.
* '''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. It is required to fill in(correctly) this field if email sending is enabled.
* '''Test email sending''' – save settings and press this to test email sending. Do not forget to save settings first!

'''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'''

* '''Days for DID to close''' – how long to keep DID closed before making it free.
* '''Agreement number length''' – number length in digits.
* '''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.
* '''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.
* '''Enable "Allowed addresses" option for Devices:''' – allows [[Device_settings#Allowed_Addresses | Allowed Addresses]] functionality in Devices settings.
* '''Enable "Allowed addresses" option for Providers:''' – allows Allowed Addresses functionality in Providers settings.
* '''User wholesale tariff enabled''' – enables user wholesale tariffs.
* '''Play IVR for unauthenticated call'''
* '''Banned CLIs default IVR''' – default IVR to route banned numbers.
* '''Do not allow duplicate device user names'''
* '''Do not allow users to change their email addresses'''
* '''Allow short passwords in devices'''
* '''Logout link''' – a user will be redirected to this link after pressing "Logout"
* '''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.
* '''Inform when Devices are created or updated''' – check to get email about every newly created or updated Device.
* '''Show Usernames on PDF/CSV Export Files in Last Calls''' – if checked, when particular User in Last Calls page search is selected, Last Calls PDF/CSV file name will be composed also from Name of selected User. If you are looking for All Users, no User Name will be used. (Name of User will be shown in Name of CSV/PDF file).
* '''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 to create Users or Register users with identical email addresses. After checking this setting you will be not able to check '''Show forgot password''', because this functionality require unique email in all system. Setting can be unchecked if all emails are unique in system.
* '''Allow same IP and Port combinations in multiple Devices''' – allows to create Devices with the same IP and Port combination.
* '''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 be send an email "Server low free space" template which can be found and edited in [[Emails]] page. Default email template for low disk space: "Some of your Servers exceeded free space limit, please investigate."
 

== 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
 
===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.
 

===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]]'''
 

===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.
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.
 

==Privacy==

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

Settings are explained here: [[Privacy_to_hide_Destination_ends|Privacy to hide Destination ends]]
 
== Visual ==

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

* '''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
* '''Number digits''' – how many digits to display after a comma
* '''Hide Quick Stats in Start page''' – hide Quick stats from start page
* '''Hide device passwords for users''' – do not display device passwords for users
* '''Hide HELP banner''' – hide HELP banner in GUI
* '''Hide "I want to" help links'''
* '''[[Remove_Manual_link_from_admin_GUI|Hide "Manual" link]]''' – hides "Manual" link
* '''Show logo on first page''' - untick to hide logo on the start page
* '''Show Full Source (CallerID Name and Number)'''
* '''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)
* '''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''' – turns on '''[[MOR_forgot_user_password | Forgot password]]''' functionality.
* '''Hide Recordings for all users''' – hides recordings for all system users from menu and device settings.
* '''Show recordings with zero billsec''' – shows recordings with zero billsec
* '''[[Last_Calls#Faster_Page_Loading|Count Last Calls total values only after click]]''' – select to load Total Values lines separately in order to dramatically improve Last calls and Old calls loading time.
* '''Default Number Decimal''' – with this option you can set default number decimal for all GUI
* '''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).

* '''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 Device and it's CallerID in Last Calls''' – shows additional column in [[Last Calls]] page with Device and its CallerID information. Click to reach that Device settings 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'''
 
[[Archived calls]]
 

=See also=

* [[Server is overloaded]]

LCR

2016-01-07T10:54:48Z

Aisteb: /* Additional Configuration */

=Description=

LCR (Least Cost Routing) is a set of Providers that should be used to send a call when trying to dial any destination - for example, by the cheapest rate.

The correct name for such a function is a Routing Table, because the function supports other ways of routing, not just finding the cheapest route.

By default LCR supports fail-over. That is, if one provider fails, the next one is dialed. This is completely invisible for the caller and lets you increase the chances of the user reaching his destination. If one Provider is not capable of delivering a call, the system will try to use the remaining [[How_to_add_Provider_to_LCR | Providers]].
 
==Fail-over explanation==

With such configuration:
 
[[image:lcr_fo_case1.png]]
 
System will do following:

* system tries to use "Kolmisoft PREMIUM";

* if above fails, system tries to use "Kolmisoft STANDARD";

* end.
 
With such configuration:
 
[[image:lcr_fo_case2.png]]
 
System will do following:
* system tries to use "Kolmisoft PREMIUM";

* end.
 
With such configuration:
 
[[image:lcr_fo_case3.png]]
 
System will do following:
* system tries to use "Kolmisoft PREMIUM";

* if above fails, system tries to use "Kolmisoft STANDARD";

* if above fails, system tries to use provider "112" even if its rate is higher than User rate;

* end.
 
=Usage=

Go to '''SETTINGS –> Billing –> LCR'''
 
[[File:lcr_path.png]]
 
Here you can see the list off all LCRs
 
[[File:lcr_main.png]]
 
* Name – name of LCR.
* Order – type of routing mode.
* Providers – quantity of providers in LCR. Click on it to [[How_to_add_Provider_to_LCR | Add Providers to LCR]]
* [[Call_routing_per_destination_basis | By destination]]
* Usage Details – the list of Users and Card Groups where this LCR is used.
* [[LCR make tariff | Make Tariff from LCR Providers to CSV]] – feature that gets you a CSV with the MIN/MAX prices selected from the list of Providers in LCR. Click on the [[Image:excel.png]] icon and the download should start automatically. (De-activated provider will be taken into CSV. "by Destination" will not be taken into CSV)
* LCR copy – press on icon to make LCR copy.
 
==Supported routing modes==

* [[Call Routing by price|By Price]] - cheapest first (Least Cost Routing).
* [[Call Routing by priority (Manual LCR) | By priority]].
* [[Routing by Percent| By percent]] or Weight-based routing.

The user has one base LCR, so that all his calls are routed by some preset rule.

It is possible to route different destinations for a User using [[Call routing per destination basis]].
 
==Creation==
Press [[Image:icon_add.png]]'''New LCR''' to create LCR.
 
=== VIDEO: How to create LCR ===

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

 
==Additional Configuration==

Go to LCRs list and press [[image:icon_edit.png]] icon.
 
[[File:lcr_time_periods.png]]
 
'''First Providers percent limit''' - visable when order by Price is selected. If following Providers will have higher price by this percent compared to first Provider, these Providers will be skipped. 0 value disables use of this setting. 
'''Minimal Rate Margin Percent''' - use only those Providers which generate profit (per minute) equal or higher than defined percentage value in this field. For example, if you pay to your Provider 1 EUR/min and your Minimal Rate Margin Percent is set to 50%, then only calls with user rate equal or higher than 1.5 EUR/min are allowed to call. After 1 min of call, you will pay 1 EUR to you provider and user will pay you 1.5 EUR. Your profit will be 0.5 EUR which is 50% more of what you paid to your Provider. If you Minimal Rate Margin is -30%, then you allow some losses in your calls. If you pay 1 EUR to your Provider after 1 minute of call, then user should pay you 0.7 EUR or more. You will pay 1 EUR and you will get 0.7 EUR which is 30% less of what you paid.
 
===LCR Time Periods===

Sometimes there is such demand to change LCR for some time period. This functionality gives you an ability to do that. In LCR edit page time periods can be set.

Time period defines the exact time period LCR will be active. There is a limit of five periods in one LCR. Rest of the time will be used main LCR.
 
'''Examples'''

# Select '''Date''' from 1 of January to 28 of February and choose '''Hour : Minute''' from 09:00 to 18:59. Selected LCR will be used from 1 of January till 28 of February at time from 09:00 till 18:59.
# Select just '''Hour : Minute''' from 19:00 to 08:59 and selected LCR will be used every day at time from 19:00 till 08:59.
# Select '''Weekday''' from Monday to Friday and choose '''Hour : Minute''' from 13:00 to 15:59. Selected LCR will be used every week from Monday till Friday at time from 13:00 till 15:59.
 

==Copying LCRs between resellers==

Sometimes you need to make a LCR which takes quite a long time to make. If you have made a similar one before you can just copy it and change appropriate details.

Go to '''SETTINGS''' -> '''Billing''' -> '''LCR''' -> '''Copy LCR'''
 
[[File:lcr_copy_path.png]]
 
You will see this window:
 
[[File:lcr_copy.png]]
 
Choose ''Original LCR reseller'' and ''Cloned LCR reseller'' and click ''Clone'' button.

Please note that LCR will not be allowed to copy if reseller B is not allowed to use Providers which are used by Reseller A.
 
=See also=

* [[LCR Logic]]
* [[How to add Provider to LCR]]
* [[Call Routing by price]]
* [[Call Routing by priority (Manual LCR) | Call Routing by priority ]]
* [[Routing by Percent | Call Routing by percent]] or Weight-based routing
* [[Call routing per destination basis]]
* [[LCR/Tariff change based on call prefix]]
* [[Why call was not routed through other provider/trunk?|Why was a call not routed through another provider/trunk?]]
* [[LCR_make_tariff|Make Tariff from LCR Providers to CSV]]

LCR

2016-01-07T10:54:31Z

Aisteb: /* Additional Configuration */

=Description=

LCR (Least Cost Routing) is a set of Providers that should be used to send a call when trying to dial any destination - for example, by the cheapest rate.

The correct name for such a function is a Routing Table, because the function supports other ways of routing, not just finding the cheapest route.

By default LCR supports fail-over. That is, if one provider fails, the next one is dialed. This is completely invisible for the caller and lets you increase the chances of the user reaching his destination. If one Provider is not capable of delivering a call, the system will try to use the remaining [[How_to_add_Provider_to_LCR | Providers]].
 
==Fail-over explanation==

With such configuration:
 
[[image:lcr_fo_case1.png]]
 
System will do following:

* system tries to use "Kolmisoft PREMIUM";

* if above fails, system tries to use "Kolmisoft STANDARD";

* end.
 
With such configuration:
 
[[image:lcr_fo_case2.png]]
 
System will do following:
* system tries to use "Kolmisoft PREMIUM";

* end.
 
With such configuration:
 
[[image:lcr_fo_case3.png]]
 
System will do following:
* system tries to use "Kolmisoft PREMIUM";

* if above fails, system tries to use "Kolmisoft STANDARD";

* if above fails, system tries to use provider "112" even if its rate is higher than User rate;

* end.
 
=Usage=

Go to '''SETTINGS –> Billing –> LCR'''
 
[[File:lcr_path.png]]
 
Here you can see the list off all LCRs
 
[[File:lcr_main.png]]
 
* Name – name of LCR.
* Order – type of routing mode.
* Providers – quantity of providers in LCR. Click on it to [[How_to_add_Provider_to_LCR | Add Providers to LCR]]
* [[Call_routing_per_destination_basis | By destination]]
* Usage Details – the list of Users and Card Groups where this LCR is used.
* [[LCR make tariff | Make Tariff from LCR Providers to CSV]] – feature that gets you a CSV with the MIN/MAX prices selected from the list of Providers in LCR. Click on the [[Image:excel.png]] icon and the download should start automatically. (De-activated provider will be taken into CSV. "by Destination" will not be taken into CSV)
* LCR copy – press on icon to make LCR copy.
 
==Supported routing modes==

* [[Call Routing by price|By Price]] - cheapest first (Least Cost Routing).
* [[Call Routing by priority (Manual LCR) | By priority]].
* [[Routing by Percent| By percent]] or Weight-based routing.

The user has one base LCR, so that all his calls are routed by some preset rule.

It is possible to route different destinations for a User using [[Call routing per destination basis]].
 
==Creation==
Press [[Image:icon_add.png]]'''New LCR''' to create LCR.
 
=== VIDEO: How to create LCR ===

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

 
==Additional Configuration==

Go to LCRs list and press [[image:icon_edit.png]] icon.
 
[[File:lcr_time_periods.png]]
 
'''First Providers percent limit''' - visable when order by Price is selected. If following Providers will have higher price by this percent compared to first Provider, these Providers will be skipped. 0 value disables use of this setting. ', WIDTH, -600, TITLE, 'First Providers percent limit. 
'''Minimal Rate Margin Percent''' - use only those Providers which generate profit (per minute) equal or higher than defined percentage value in this field. For example, if you pay to your Provider 1 EUR/min and your Minimal Rate Margin Percent is set to 50%, then only calls with user rate equal or higher than 1.5 EUR/min are allowed to call. After 1 min of call, you will pay 1 EUR to you provider and user will pay you 1.5 EUR. Your profit will be 0.5 EUR which is 50% more of what you paid to your Provider. If you Minimal Rate Margin is -30%, then you allow some losses in your calls. If you pay 1 EUR to your Provider after 1 minute of call, then user should pay you 0.7 EUR or more. You will pay 1 EUR and you will get 0.7 EUR which is 30% less of what you paid.
 
===LCR Time Periods===

Sometimes there is such demand to change LCR for some time period. This functionality gives you an ability to do that. In LCR edit page time periods can be set.

Time period defines the exact time period LCR will be active. There is a limit of five periods in one LCR. Rest of the time will be used main LCR.
 
'''Examples'''

# Select '''Date''' from 1 of January to 28 of February and choose '''Hour : Minute''' from 09:00 to 18:59. Selected LCR will be used from 1 of January till 28 of February at time from 09:00 till 18:59.
# Select just '''Hour : Minute''' from 19:00 to 08:59 and selected LCR will be used every day at time from 19:00 till 08:59.
# Select '''Weekday''' from Monday to Friday and choose '''Hour : Minute''' from 13:00 to 15:59. Selected LCR will be used every week from Monday till Friday at time from 13:00 till 15:59.
 

==Copying LCRs between resellers==

Sometimes you need to make a LCR which takes quite a long time to make. If you have made a similar one before you can just copy it and change appropriate details.

Go to '''SETTINGS''' -> '''Billing''' -> '''LCR''' -> '''Copy LCR'''
 
[[File:lcr_copy_path.png]]
 
You will see this window:
 
[[File:lcr_copy.png]]
 
Choose ''Original LCR reseller'' and ''Cloned LCR reseller'' and click ''Clone'' button.

Please note that LCR will not be allowed to copy if reseller B is not allowed to use Providers which are used by Reseller A.
 
=See also=

* [[LCR Logic]]
* [[How to add Provider to LCR]]
* [[Call Routing by price]]
* [[Call Routing by priority (Manual LCR) | Call Routing by priority ]]
* [[Routing by Percent | Call Routing by percent]] or Weight-based routing
* [[Call routing per destination basis]]
* [[LCR/Tariff change based on call prefix]]
* [[Why call was not routed through other provider/trunk?|Why was a call not routed through another provider/trunk?]]
* [[LCR_make_tariff|Make Tariff from LCR Providers to CSV]]

LCR

2016-01-07T10:54:18Z

Aisteb:

=Description=

LCR (Least Cost Routing) is a set of Providers that should be used to send a call when trying to dial any destination - for example, by the cheapest rate.

The correct name for such a function is a Routing Table, because the function supports other ways of routing, not just finding the cheapest route.

By default LCR supports fail-over. That is, if one provider fails, the next one is dialed. This is completely invisible for the caller and lets you increase the chances of the user reaching his destination. If one Provider is not capable of delivering a call, the system will try to use the remaining [[How_to_add_Provider_to_LCR | Providers]].
 
==Fail-over explanation==

With such configuration:
 
[[image:lcr_fo_case1.png]]
 
System will do following:

* system tries to use "Kolmisoft PREMIUM";

* if above fails, system tries to use "Kolmisoft STANDARD";

* end.
 
With such configuration:
 
[[image:lcr_fo_case2.png]]
 
System will do following:
* system tries to use "Kolmisoft PREMIUM";

* end.
 
With such configuration:
 
[[image:lcr_fo_case3.png]]
 
System will do following:
* system tries to use "Kolmisoft PREMIUM";

* if above fails, system tries to use "Kolmisoft STANDARD";

* if above fails, system tries to use provider "112" even if its rate is higher than User rate;

* end.
 
=Usage=

Go to '''SETTINGS –> Billing –> LCR'''
 
[[File:lcr_path.png]]
 
Here you can see the list off all LCRs
 
[[File:lcr_main.png]]
 
* Name – name of LCR.
* Order – type of routing mode.
* Providers – quantity of providers in LCR. Click on it to [[How_to_add_Provider_to_LCR | Add Providers to LCR]]
* [[Call_routing_per_destination_basis | By destination]]
* Usage Details – the list of Users and Card Groups where this LCR is used.
* [[LCR make tariff | Make Tariff from LCR Providers to CSV]] – feature that gets you a CSV with the MIN/MAX prices selected from the list of Providers in LCR. Click on the [[Image:excel.png]] icon and the download should start automatically. (De-activated provider will be taken into CSV. "by Destination" will not be taken into CSV)
* LCR copy – press on icon to make LCR copy.
 
==Supported routing modes==

* [[Call Routing by price|By Price]] - cheapest first (Least Cost Routing).
* [[Call Routing by priority (Manual LCR) | By priority]].
* [[Routing by Percent| By percent]] or Weight-based routing.

The user has one base LCR, so that all his calls are routed by some preset rule.

It is possible to route different destinations for a User using [[Call routing per destination basis]].
 
==Creation==
Press [[Image:icon_add.png]]'''New LCR''' to create LCR.
 
=== VIDEO: How to create LCR ===

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

 
==Additional Configuration==

Go to LCRs list and press [[image:icon_edit.png]] icon.
 
[[File:lcr_time_periods.png]]
 
'''First Providers percent limit''' - visable when order by Price is selected. If following Providers will have higher price by this percent compared to first Provider, these Providers will be skipped. 0 value disables use of this setting. ', WIDTH, -600, TITLE, 'First Providers percent limit.
'''Minimal Rate Margin Percent''' - use only those Providers which generate profit (per minute) equal or higher than defined percentage value in this field. For example, if you pay to your Provider 1 EUR/min and your Minimal Rate Margin Percent is set to 50%, then only calls with user rate equal or higher than 1.5 EUR/min are allowed to call. After 1 min of call, you will pay 1 EUR to you provider and user will pay you 1.5 EUR. Your profit will be 0.5 EUR which is 50% more of what you paid to your Provider. If you Minimal Rate Margin is -30%, then you allow some losses in your calls. If you pay 1 EUR to your Provider after 1 minute of call, then user should pay you 0.7 EUR or more. You will pay 1 EUR and you will get 0.7 EUR which is 30% less of what you paid.
 
===LCR Time Periods===

Sometimes there is such demand to change LCR for some time period. This functionality gives you an ability to do that. In LCR edit page time periods can be set.

Time period defines the exact time period LCR will be active. There is a limit of five periods in one LCR. Rest of the time will be used main LCR.
 
'''Examples'''

# Select '''Date''' from 1 of January to 28 of February and choose '''Hour : Minute''' from 09:00 to 18:59. Selected LCR will be used from 1 of January till 28 of February at time from 09:00 till 18:59.
# Select just '''Hour : Minute''' from 19:00 to 08:59 and selected LCR will be used every day at time from 19:00 till 08:59.
# Select '''Weekday''' from Monday to Friday and choose '''Hour : Minute''' from 13:00 to 15:59. Selected LCR will be used every week from Monday till Friday at time from 13:00 till 15:59.
 
==Copying LCRs between resellers==

Sometimes you need to make a LCR which takes quite a long time to make. If you have made a similar one before you can just copy it and change appropriate details.

Go to '''SETTINGS''' -> '''Billing''' -> '''LCR''' -> '''Copy LCR'''
 
[[File:lcr_copy_path.png]]
 
You will see this window:
 
[[File:lcr_copy.png]]
 
Choose ''Original LCR reseller'' and ''Cloned LCR reseller'' and click ''Clone'' button.

Please note that LCR will not be allowed to copy if reseller B is not allowed to use Providers which are used by Reseller A.
 
=See also=

* [[LCR Logic]]
* [[How to add Provider to LCR]]
* [[Call Routing by price]]
* [[Call Routing by priority (Manual LCR) | Call Routing by priority ]]
* [[Routing by Percent | Call Routing by percent]] or Weight-based routing
* [[Call routing per destination basis]]
* [[LCR/Tariff change based on call prefix]]
* [[Why call was not routed through other provider/trunk?|Why was a call not routed through another provider/trunk?]]
* [[LCR_make_tariff|Make Tariff from LCR Providers to CSV]]

File:Lcr fo case3.png

2016-01-07T10:42:29Z

Aisteb: uploaded a new version of "File:Lcr fo case3.png"

File:Lcr fo case2.png

2016-01-07T10:42:15Z

Aisteb: uploaded a new version of "File:Lcr fo case2.png"

File:Lcr fo case1.png

2016-01-07T10:41:54Z

Aisteb: uploaded a new version of "File:Lcr fo case1.png"

File:Lcr time periods.png

2016-01-07T10:31:29Z

Aisteb: uploaded a new version of "File:Lcr time periods.png"

MOR API

2015-12-01T15:58:51Z

Aisteb: /* Device */

[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>
[[File:api.png|right|alt="api"|link=]]
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta>

 
=About=
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.

MOR accepts requests by HTML POST and returns results in XML.

 
=MOR users that are allowed to use MOR API=
* Admin
* Reseller
* Accountant - only by using Admin Hash and Secret key
* Simple User

 

=Functions=

== API Related ==
* [[API Configuration]] – configuration options for API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.

 
==Balance==
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
Various methods to retrieve User balance
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username

 

==Callback==
* [[MOR API callback init|callback_init]] (callback) – initiates callback.

 
==Calling Cards==
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.
* [[MOR_API_Calling_Cards_get| calling_cards_get]] - get Calling Cards.
* [[MOR_API_Card_Group_create| cc_group_create]] – create Card Group.
* [[MOR_API_Card_Group_update| cc_group_update]] – update Card Group.
* [[MOR API Card Groups get| cc_groups_get]] – show Calling Cards Group info.
 

==Calls==
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.

 

==Conflines==
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.

 
==Credit notes==
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.
* [[MOR API credit_note_update| credit_note_update]] – credit note update.
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.

 
==Device==

* [[MOR API device create| device_create]] – create device
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API device details get | device_details_get]] – shows all information about specified device.
 
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state.
 
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device
 

==DID==

* [[MOR API dids get| dids_get]] – get list of particular DIDs
* [[MOR API did_create| did_create]] – DID create
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription

 

==Email==
* [[MOR API email send| email_send]] (send_email) – send Email.

 
==Financial statements==
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.

 
==Invoices==
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.

 
==Login==
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.

 
==Monitorings==
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon

 
==Payments==
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.

 
==Phonebooks==
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.

 
==Quickforwards==
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.

 
==Rates==
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff

 
==Services==
* [[MOR API Service create| service_create]] – create Service.
* [[MOR API Service delete| service_delete]] – delete Service.
* [[MOR API Services get| services_get]] – get Services.
* [[MOR API Service update| service_update]] – update Service.

 

==SMS==
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.

 
==Subscriptions==
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.
* [[MOR API subscription create|subscription_create]] - Subscription create.
* [[MOR API subscription update|subscription_update]] - Subscription delete.
 

==User==

* [[MOR API user_register| user_register]] – create new user from params.
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
 

== Resellers ==
* [[MOR API reseller group create]] - create new Reseller Group

 
==Version==
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.

 
= Examples =
* [[MOR API PHP Examples]]

 
=HTML POST=
All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username

* username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
 
=Useful to know=

* All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.

 
=See also =
* [[API Configuration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]

MOR API

2015-12-01T15:57:57Z

Aisteb: /* Device */

[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>
[[File:api.png|right|alt="api"|link=]]
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta>

 
=About=
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.

MOR accepts requests by HTML POST and returns results in XML.

 
=MOR users that are allowed to use MOR API=
* Admin
* Reseller
* Accountant - only by using Admin Hash and Secret key
* Simple User

 

=Functions=

== API Related ==
* [[API Configuration]] – configuration options for API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.

 
==Balance==
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
Various methods to retrieve User balance
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username

 

==Callback==
* [[MOR API callback init|callback_init]] (callback) – initiates callback.

 
==Calling Cards==
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.
* [[MOR_API_Calling_Cards_get| calling_cards_get]] - get Calling Cards.
* [[MOR_API_Card_Group_create| cc_group_create]] – create Card Group.
* [[MOR_API_Card_Group_update| cc_group_update]] – update Card Group.
* [[MOR API Card Groups get| cc_groups_get]] – show Calling Cards Group info.
 

==Calls==
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.

 

==Conflines==
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.

 
==Credit notes==
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.
* [[MOR API credit_note_update| credit_note_update]] – credit note update.
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.

 
==Device==

* [[MOR API device create| device_create]] – create device
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API device details get | device_details_get]] – shows all information about specified device.

* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state.

* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device
 

==DID==

* [[MOR API dids get| dids_get]] – get list of particular DIDs
* [[MOR API did_create| did_create]] – DID create
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription

 

==Email==
* [[MOR API email send| email_send]] (send_email) – send Email.

 
==Financial statements==
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.

 
==Invoices==
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.

 
==Login==
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.

 
==Monitorings==
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon

 
==Payments==
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.

 
==Phonebooks==
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.

 
==Quickforwards==
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.

 
==Rates==
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff

 
==Services==
* [[MOR API Service create| service_create]] – create Service.
* [[MOR API Service delete| service_delete]] – delete Service.
* [[MOR API Services get| services_get]] – get Services.
* [[MOR API Service update| service_update]] – update Service.

 

==SMS==
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.

 
==Subscriptions==
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.
* [[MOR API subscription create|subscription_create]] - Subscription create.
* [[MOR API subscription update|subscription_update]] - Subscription delete.
 

==User==

* [[MOR API user_register| user_register]] – create new user from params.
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
 

== Resellers ==
* [[MOR API reseller group create]] - create new Reseller Group

 
==Version==
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.

 
= Examples =
* [[MOR API PHP Examples]]

 
=HTML POST=
All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username

* username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
 
=Useful to know=

* All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.

 
=See also =
* [[API Configuration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]

M4 Users

2015-11-17T11:51:29Z

Aisteb: /* General */

=Where to find user details?=

Go to '''SETTINGS –> Users'''

Here you can see list of all users.

Select the [[image:icon_edit.png]] icon in window above and you will reach personal User settings page. In this window you will see a lot of options grouped into sections.


'''NOTE''' that admin is not shown in Users list. To see your own details go to '''PERSONAL MENU –> Details'''.
 

= 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.
* '''[[Balance and Credit | Balance]]''' – the user's balance.
* '''Balance range''' – minimal and maximal balance which User will be able to have.
* '''[[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.
* '''[[Hide Users | Not Hidden/Hidden]]''' – is this user hidden?
* '''[[Simultaneous call limitation | Call Limit]]''' – how many simultaneous calls the user can make?
* '''Default Currency''' – User's default Currency
* '''Time Zone''' – User's native Time Zone
* '''Responsible accountant''' – dropdown to choose accountant responsible for User's Profit.
* '''PBX Pool''' – PBX pool assigned to User
* '''Hide Non-Answered calls''' – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. 
* '''Ignore Global Alerts''' – check and User will be ignored on checking for [[M2_Alerts | Alerts]]
 

= Blocking =

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

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

More details: [[M2 Warning Balance | Warning Balance]]
 

= Invoices =

* '''Generate Invoice''' – should we generate Invoices for this User?
* '''Billing Period''' – select period for which Invoice should be generated.
* '''Grace Period''' – select period for which Invoice should be paid by User. For example, if you generate Invoice for January 1-31, and you set Grace Period 15 days, then User will see Due Date February 15 (15 days after Invoice period end).
 

= 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/
 
= Company Emails =

Self-explanatory:

* '''Main email'''
* '''NOC email'''
* '''Billing email'''
* '''Rates email'''
 
= Taxes =

Here tax parameters are entered for the user.

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

Self-explanatory.
 
=Blacklists / Whitelists=

'''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 specific Source numbers. If User receives number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''334 - 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 ''335 - 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 ''325 - 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 ''326 - Destination is not in whitelist''

MOR API

2015-11-13T15:57:37Z

Aisteb: /* Calling Cards */

[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>
[[File:api.png|right|alt="api"|link=]]
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta>

 
=About=
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.

MOR accepts requests by HTML POST and returns results in XML.

 
=MOR users that are allowed to use MOR API=
* Admin
* Reseller
* Accountant - only by using Admin Hash and Secret key
* Simple User

 

=Functions=

== API Related ==
* [[API Configuration]] – configuration options for API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.

 
==Balance==
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
Various methods to retrieve User balance
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username

 

==Callback==
* [[MOR API callback init|callback_init]] (callback) – initiates callback.

 
==Calling Cards==
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.
* [[MOR_API_Calling_Cards_get| calling_cards_get]] - get Calling Cards.
* [[MOR_API_Card_Group_create| cc_group_create]] – create Card Group.
* [[MOR_API_Card_Group_update| cc_group_update]] – update Card Group.
* [[MOR API Card Groups get| cc_groups_get]] – show Calling Cards Group info.
 

==Calls==
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.

 

==Conflines==
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.

 
==Credit notes==
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.
* [[MOR API credit_note_update| credit_note_update]] – credit note update.
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.

 
==Device==
* [[MOR API device create| device_create]] – create device
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state.
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device
* [[MOR API device details get | device_details_get]] – shows all information about specified device.
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.

 

==DID==

* [[MOR API dids get| dids_get]] – get list of particular DIDs
* [[MOR API did_create| did_create]] – DID create
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription

 

==Email==
* [[MOR API email send| email_send]] (send_email) – send Email.

 
==Financial statements==
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.

 
==Invoices==
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.

 
==Login==
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.

 
==Monitorings==
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon

 
==Payments==
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.

 
==Phonebooks==
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.

 
==Quickforwards==
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.

 
==Rates==
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff

 
==Services==
* [[MOR API Service create| service_create]] – create Service.
* [[MOR API Service delete| service_delete]] – delete Service.
* [[MOR API Services get| services_get]] – get Services.
* [[MOR API Service update| service_update]] – update Service.

 

==SMS==
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.

 
==Subscriptions==
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.
* [[MOR API subscription create|subscription_create]] - Subscription create.
* [[MOR API subscription update|subscription_update]] - Subscription delete.
 

==User==

* [[MOR API user_register| user_register]] – create new user from params.
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
 

== Resellers ==
* [[MOR API reseller group create]] - create new Reseller Group

 
==Version==
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.

 
= Examples =
* [[MOR API PHP Examples]]

 
=HTML POST=
All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username

* username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
 
=Useful to know=

* All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.

 
=See also =
* [[API Configuration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]

MOR API Card Groups get

2015-11-13T15:56:45Z

Aisteb: moved MOR API cc groups get to MOR API Card Groups get

= NOTE: Available from MOR X7 =

=Description=
[[MOR API]] Calling Cards Groups get
 
=Usage=

* From '''MOR X7''' Calling Cards Groups: '''/api/cc_groups_get'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

* u - username for authentication.
* cc_group_id - Calling Cards Group ID.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
 

===Request===

We have: API Secret Key = secret

We send:
HTML POST: http://<SERVER_IP>/billing/api/cc_groups_get?u=admin&cc_group_id=1&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4
'''NOTE that username is not included in hash'''
 

'''Success'''

<page>
<cc_groups>
<cc_group>
<group_id>1</group_id>
<group_image>example.jpg</group_image>
<group_name>Test_cardgroup</group_name>
<group_description>Test_cardgroup description</group_description>
<group_number_pin_length>10/4</group_number_pin_length>
<group_tarrif>Test Tariff for Users</group_tarrif>
<group_lcr>Primary</group_lcr>
<group_price>10.0840</group_price>
<group_price_without_tax>10.0840</group_price_without_tax>
<group_cards_count>21</group_cards_count>
</cc_group>
</cc_groups>
</page>
 
----

'''Errors'''
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>You are not authorized to use this functionality</error> - User does not have rights to manage Calling Cards.
* <error>Access Denied</error> - User does not have access to Calling Cards.
* <error>Wrong calling cards group ID</error> - User supplied wrong Calling Cards group ID.
* <error>Calling cards groups were not found</error> - Calling cards groups were not found.
 

=See also=

* [[MOR API]]

Profit Stats

2015-11-12T10:59:16Z

Aisteb:

It is important to know at any moment what profit your system is generating for you.

The profit can be seen in '''STATISTICS – Finances – Profit''':
 
[[Image:profit_stats.png]]
 
You can check your Profit by period, selected User and Responsible Accountant.

All fields are self-explanatory.

Total Call Price percentage always 100%. Total Call Self Price and Calls Profit percentage value is calculated from Total Call Price.

The PDF report shows the same information.
 
=See also=

* [[Billing Concepts]]
* [[DID Billing]]
* [[Provider Billing Addon]]

File:Profit stats.png

2015-11-12T10:55:33Z

Aisteb: uploaded a new version of "File:Profit stats.png"

MOR API Card Group create

2015-11-11T15:24:23Z

Aisteb: /* Parameters */

=Description=
[[MOR API]] Card Group create
 
=Usage=

* From '''MOR X7''' Calling Card: '''/api/cc_group_create'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

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

* name - name of a Card Group '''Required'''.

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

* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.
* '''description''' - description for Card Group.
* '''price_with_vat''' - price with TAX for Card Group.
* '''setup_fee''' - setup fee for Card Group.
* '''ghost_min_perc''' - ghost min percent for Card Group.
* '''daily_charge''' - daily charge for Card Group.
* '''tariff_id''' - Card Group Tariff ID.
* '''lcr_id''' - Card Group LCR id.
* '''date_from''' - Card Group valid from date (timestamp).
* '''date_till''' - Card Group valid till date (timestamp).
* '''number_length''' - Card Group number length.
* '''pin_length''' - Card Group PIN length.
* '''location_id''' - Card Group Location ID.
* '''tax_id''' - Card Group TAX ID.
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.
* '''ghost_balance_perc''' - Card Group ghost balance percent.
* '''use_external_function''' - enable or disable use of external script [0-no, 1-yes].
* '''allow_loss_calls''' - Allow Loss Calls for Card Group [0-off, 1-on].
* '''tell_cents''' - tell cents for Card Group [0-off, 1-on].
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency [0-off, 1-on].
* '''solo_pinless''' - Deny to double-use a Card with Pinless dialing, when Card is assigned to some CallerID [0-no, 1-yes].
* '''disable_voucher''' - enable or disable voucher [0-off, 1-on].
* '''callerid_leave''' - Leave CallerID assigned to Card when balance is empty [0-no, 1-yes].
 

===Request===

We have u = admin, API Secret Key = secret
We send:

HTML POST: http://<SERVER_IP>/billing/api/cc_group_create?u=admin&name=card_group_test&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c

* Now we can find 1 newly created Card Group.''' 
'''* Note that if not passing optional parameters, default values will be used.''' 
'''* Note that a Username and a Password are not included into hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Card Group was successfully created</success>
</status>
</page>
 
----

'''Errors'''

* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method.
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.
* <error>Card Group must have name</error> - Card Group name is not given. Name is required parameter.
* <error>Use external function is incorrect format</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.
* <error>Allow loss calls is incorrect format</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.
* <error>Tell cents is incorrect format</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.
* <error>Solo pinless is incorrect format</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.
* <error>Disable voucher is incorrect format</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.
* <error>CallerID leave is incorrect format</error> - Caller ID leave parameter can only be: 1 - enabled, 0 - disabled.
* <error>Invalid date from</error> - UNIX time stamp date not correct.
* <error>Invalid date till</error> - UNIX time stamp date not correct.
* <error>Date from is greater than date till</error> - valid from is greater than valid till.
* <error>Tariff was not found</error> - Tariff id is not correct. There is no such Tariff.
* <error>LCR was not found</error> - LCR ID is not correct. There is no such LCR.
* <error>Location was not found</error> - Location ID is not correct. There is no such Location.
* <error>Currency was not found</error> - Currency ID is not correct. There is no such Currency.
* <error>Invalid Price with TAX</error> - price is not correct, can not be negative.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Invalid solo pinless parameter, should be: 0 or 1</error>
</status>
</page>
 

=See also=

* [[MOR API]]

MOR API Card Group update

2015-11-11T15:23:17Z

Aisteb: /* Parameters */

=Description=
[[MOR API]] Card Group update
 
=Usage=

* From '''MOR X7''' Calling Card: '''/api/cc_group_update'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

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

* cc_Group_id - id of a Card Group '''Required'''.

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

* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.
* '''name''' - name of Card Group.
* '''description''' - description of Card Group.
* '''price_with_vat''' - price with TAX of Card Group.
* '''setup_fee''' - setup fee of Card Group.
* '''use_external_function''' - use of external script [0-no, 1-yes].
* '''ghost_min_perc''' - ghost min percent of Card Group.
* '''ghost_balance_perc''' - ghost balance percent of Card Group.
* '''daily_charge''' - daily charge of Card Group.
* '''tell_cents''' - usage of tell cents [0-no, 1-yes].
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency.
* '''tariff_id''' - tariff if of Card Group
* '''lcr_id''' - LCR id of Card Group
* '''location_id''' - Card Group location id.
* '''date_from''' - Card Group valid from date (timestamp).
* '''date_till''' - Card Group valid till date (timestamp).
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.
* '''allow_loss_calls''' - Allow Loss Calls for Card Group [0-off, 1-on].
* '''solo_pinless''' - Deny to double-use a Card with Pinless dialing, when Card is assigned to some CallerID [0-no, 1-yes].
* '''disable_voucher''' - disable Voucher with same Number as Card if Card is used [0-off, 1-on].
* '''callerid_leave''' - Leave CallerID assigned to Card when balance is empty [0-no, 1-yes].
* '''tax2_enabled''' - [0-no, 1-yes].
* '''tax3_enabled''' - [0-no, 1-yes].
* '''tax4_enabled''' - [0-no, 1-yes].
* '''compound_tax''' - [0-no, 1-yes].
* '''tax1_name''' - name of the first tax.
* '''tax2_name''' - name of the second tax.
* '''tax3_name''' - name of the third tax.
* '''tax4_name''' - name of the fourth tax.
* '''total_tax_name''' - name of total taxes.
* '''tax1_value''' - value of the first tax.
* '''tax2_value''' - value of the second tax.
* '''tax3_value''' - value of the third tax.
* '''tax4_value''' - value of the fourth tax.

 

===Request===

We have u = admin, API Secret Key = secret
We send:

HTML POST: http://<SERVER_IP>/billing/api/cc_group_update?u=admin&cc_Group_id=1&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c

* Now we can find 1 updated Card Group.''' 
'''* Note that a Username and a Password are not included into hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Card Group was successfully updated</success>
</status>
</page>
 
----

'''Errors'''

* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method.
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.
* <error>Card Group was not found</error> - There is no such Card Group id or user is not authorized to manage this Card Group.
* <error>Use external function is incorrect format</error> - Use external script parameter can only be: 1 - enabled, 0 - disabled.
* <error>Tell cents is incorrect format</error> - Tell cents parameter can only be: 1 - enabled, 0 - disabled.
* <error>Currency was not found</error> - Currency id is not correct. There is no such Currency.
* <error>Tariff was not found</error> - There is no such Tariff.
* <error>LCR was not found</error> - LCR id is not correct. There is no such LCR.
* <error>Location was not found</error> - Location id is not correct. There is no such Location.
* <error>Date from is incorrect format</error> - Valid from is incorrect format.
* <error>Time till is incorrect format</error> - Valid till is incorrect format.
* <error>Date from is greater than date till</error> - Valid from is greater than valid till.
* <error>Valid after is incorrect format</error> - Valid after maximum value can be 9999.
* <error>Allow loss calls is incorrect format</error> - Allow loss calls parameter can only be: 1 - enabled, 0 - disabled.
* <error>Solo pinless is incorrect format</error> - Solo pinless parameter can only be: 1 - enabled, 0 - disabled.
* <error>Disable voucher is incorrect format</error> - Voucher parameter can only be: 1 - enabled, 0 - disabled.
* <error>CallerID leave is incorrect format</error> - Caller id leave parameter can only be: 1 - enabled, 0 - disabled.
* <error>Compound TAX enabling value is incorrect format</error> - Compound parameter can only be: 1 - enabled, 0 - disabled.
* <error>TAX 2 enabling value is incorrect format</error> - TAX 2 enabling value parameter can only be: 1 - enabled, 0 - disabled.
* <error>TAX 3 enabling value is incorrect format</error> - TAX 3 enabling value parameter can only be: 1 - enabled, 0 - disabled.
* <error>TAX 4 enabling value is incorrect format</error> - TAX 4 enabling value parameter can only be: 1 - enabled, 0 - disabled.
Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Invalid Price with TAX</error>
</status>
</page>
 

=See also=

* [[MOR API]]

MOR API Calling Cards get

2015-11-11T15:20:25Z

Aisteb: /* Parameters */

=Description=
[[MOR API]] Returns the list of Calling Cards with respect to provided search parameters.
 
=Usage=

* Call: /api/calling_cards_get '''(from MOR X7)'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the required '''parameters''' (in this case none of the parameters is required). The hash will contain only an '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.
* number - Calling Card's number.
* name - Calling Card's name
* pin - Calling Card's PIN code.
* batch_number - Calling Card's batch number.
* min_balance - lower boundary of the Calling Card's balance range.
* max_balance - upper boundary of the Calling Card's balance range.
* callerid - Calling Card's CallerID for "pinless" dialing.
* language - Calling Card's language.
* sold - determines whether a Calling Card is sold or not (send yes/no/all and recognize Card is sold or no by 1 - sold, 0 - not sold).
* distributor - Calling Card's distributor's (User's) id.

 

===Request===

We have u = admin, API Secret Key = secret

We send:

HTML POST: http://<SERVER_IP>/billing/api/calling_cards_get?u=admin&number=1111111119&name=test_card&pin=2668&min_balance=10&max_balance=50&language=en&callerid=3&sold=0&distributor=2&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4

* Now we get a search result containing the Calling Cards with the specified attributes data. 
'''* Note that a Username and a Password are not included into hash'''
 

===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<cards>
<card>
<card_id>26</card_id>
<card_number>1111111119</card_number>
<card_name>test_card</card_name>
<card_pin>2668</card_pin>
<card_batch_number>5</card_batch_number>
<card_callerid>3</card_callerid>
<card_balance>10.0840336134454</card_balance>
<card_minimal_balance>20.0</card_minimal_balance>
<card_first_use/>
<card_daily_charge_paid_till>2015-11-05 02:00:00 +0200</card_daily_charge_paid_till>
<card_sold>0</card_sold>
<card_language>en</card_language>
<card_distributor>Test User #1</card_distributor>
</card>
</cards>
</page>
 
----

'''Errors'''

* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method.
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.
* <error>Cards were not found</error> - no Cards were found with provided search parameters.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Cards were not found</error>
</status>
</page>
 

=See also=

* [[MOR API]]