Kolmisoft Wiki - User contributions [en]

Support

2015-11-26T14:58:46Z

Karolinas: /* Support plans */

= Support plans =

'''IMPORTANT!''' Only the 2 latest versions of MOR are supported, therefore if you own an older version, please contact [mailto:business@kolmisoft.com our sales team] for the consultation on upgrading.

This table shows support plans and how they are served.

{| border="1" cellpadding="5" cellspacing="0"
| '''Support Plan''' || '''Priority''' || '''Reaction time during working hours''' || '''[https://support.kolmisoft.com/forums Forum]'''|| '''[[Ticket System | Support System]]''' || '''Skype Chat''' || [[Support#FULL_SERVICE_-__ENTERPRISE | '''Full Service''' ]]
|-
| '''ENTERPRISE''' ||Highest ||0-1h || [[Image:icon_check.png]] || [[Image:icon_check.png]] || [[Image:icon_check.png]] || [[Image:icon_check.png]]

|-
| PREMIUM||High ||0-3h || [[Image:icon_check.png]] || [[Image:icon_check.png]] || [[Image:icon_check.png]] || [[Image:icon_cross.png]]

|-
| BASIC ||Normal|| 0-12h || [[Image:icon_check.png]] || [[Image:icon_check.png]] || [[Image:icon_cross.png]] || [[Image:icon_cross.png]]

|-

| FREE || Lowest || - || [[Image:icon_check.png]] || [[Image:icon_cross.png]] || [[Image:icon_cross.png]] || [[Image:icon_cross.png]]
|-
|}
 
Reaction time frames apply to both skype and tickets.

Skype support (Skype ID: support_kolmisoft) is available on the best effort (not guaranteed) Monday to Friday 8 AM - 8PM [http://www.timeanddate.com/worldclock/city.html?n=660 GMT+2] (Lithuanian time).

If Skype support is offline, please report your problem or question in the [[Ticket System | Support System]].

'''Emergency Support''' (for '''BLOCKER''' priority tickets) is available 24x7 and support is provided only through the [[Ticket System | Support System]].
 

= Ticket Priorities =

Based on the severity tickets are divided into priorities by which support engineers decide which ticket should be solved first.

* Blocker - The system is down or severely degraded or business operations are being critically impacted
* High - The system is degraded
* Medium - The system operation is impaired, yet generally functional
* Low - Configuration or planning assistance is requested to optimize performance of the system. This includes web interface usage and the like.
 

= Rates of technical services =

{| border="1" cellpadding="5" cellspacing="0"
| '''Task''' || '''Price''' || '''Description'''
|-
| '''[[Migration_to_other_server | Migration]]''' || 200 EUR|| Complete process is done by Kolmisoft engineers
|-
| '''[[Heartbeat_configuration | Heartbeat / Virtual IP configuration]]''' || 200 EUR|| Complete process is done by Kolmisoft engineers
|-
| '''[[MySQL_Replication | MySQL Replication]]''' || 200 EUR|| Complete process is done by Kolmisoft engineers
|-
| '''Hourly rate support''' || 100 EUR/h || This support is provided if client does not have any service plan
|-
| '''[[Training#Personalized_Training | Personal training]]''' || 100 EUR/h || Training is done online by Skype
|-
| Remote '''MOR FREE installation'''(10 concurrent calls, all add-ons) || 100 EUR || Remote installation is paid. If Vmware Image suits you, you can download it [[MOR_VMware_images | here]].
|-
| '''License re-installation''' || 100 EUR || This task is free only if the need of the reinstallation arose because of Kolmisoft's fault
|-
| '''BUG fixing''' || - || BUG fixing is free for one year after the last upgrade (only two newest versions are supported)
|-
| '''PUBLIC forum''' || - || Tickets in PUBLIC forum are free. User can request to move a ticket to PRIVATE by agreeing to use '''hourly rate support''' or '''support plan'''
|-
|}
 

= What is included into BASIC/PREMIUM support =

* Helping to solve problems
* Activation of the license after server crash (core upgrade, core recompile)
* Activation of the license after migration to new server (core upgrade, core recompile). Data migration not included

 

= What is NOT included into ENTERPRISE/BASIC/PREMIUM support =

* Testing customers settings - we only explain how to do that yourself (TeamViewer and other methods of screen sharing are not used).
* Custom development - no additional functionality programming is included. It can be ordered separately.
* Server migration (migration of data and license)
* Additional server configuration
* MySQL Replication configuration
* Redundancy configuration
* Personal Training (Online Group Training is included)
* Custom iptables, firewall configurations
* Server re-installation
* Linux (CentOS) support
* Custom database modifications AND DB/data restoration after broken DB integrity because of manual interference into DB
* Custom Asterisk modifications
* MySQL replication re-build.
 

= FULL SERVICE - '''ENTERPRISE''' =

Dedicated for companies who want to transfer MOR configuration (adding providers, uploading rates, creating clients, etc), system monitoring and all VoIP related problems to Kolmisoft support team. It is same as to hire full-time employee to work with MOR and VoIP issues. Furthermore, differently from hiring employee, Kolmisoft does not require training and we will make sure your tasks are done in the highest priority.
 

NOT INCLUDED:

* Custom development - no additional functionality programming is included. It can be ordered separately
* Iptables, firewall configuration
* Configuration of third party software/hardware (sotphones, IP phones, dialers, PBXes, gateways, etc)
* Enterprise support plan does not include periodic hand-made reports or documenting configurations/features additionally.
* Purchasing DIDs, making agreements with other service providers and other tasks which include any monetary activities.
** After purchase is done by the Client, Kolmisoft engineers are able to configure DID (in the MOR and in the DID Provider configuration panel) or Provider connection (in the MOR)
 

= Jobs NOT done by Kolmisoft =

* SNMP service configuration
* TDM/PSTN card installation/configuration
* [[Install_Dahdi | Zaptel/DAHDI]] installation/ configuration
* VPN configuration
* Iptables, firewall, network configuration
* Partitions and storage devices management
** Too risky not knowing whole network configuration - one small mistake makes server unreachable. This task should be done by local technician with physical access to the server.
* Dealing with 3rd party providers.
 

= See also =
* [[Support System explanation]]
* [[Create new Ticket in Ticket System]]
* [[Write comment to the Ticket]]

Rate import from CSV

2015-11-26T10:54:24Z

Karolinas: /* 4. Analysis */

= File format =

File should be CSV (comma separated values).

Necessary fields in CSV line:

* Prefix
* Price

No other fields are necessary.

First line can be header.

''Value Separator'' and ''Decimal Separator'' MUST be set correctly in '''SETTINGS -> Setup -> Settings -> Functionality''':

* CSV Column Separator
* CSV Decimal Separator
 
[[File:Settings-functionality.png]]
 
File and CSV separator settings should match. If they do not, you will get errors when trying to import file.

* [[Good CSV rate file examples]]
* [[Bad CSV rate file examples]]
 
=== Where can I get an example file with available prefixes? ===

Go to '''SETTINGS -> Billing -> Tariffs''' and click on [[Image:icon_excel.png]] '''Destinations CSV'''.
 
= Description =

It is very tedious work to add several thousand rates by hand, so you can import them from a CSV file.

There are seven steps for importing rates from a CSV file:

# File upload
# Column assignment
# Column confirmation
# Analysis
# Creating destinations
# Updating rates
# Creating new rates

We will cover each of these one by one.

'''IMPORTANT NOTE: When importing, prefixes should be in E.164 format!!! For example, no international prefixes!'''
 
== 1. File upload ==

Select [[Image:excel.png]] '''Import from CSV''' for the Tariff you want to import rates.

Then click on '''Browse''' and select CSV file with rates. Click '''Upload file''':
 
[[Image:rateimportfromcsv1.png]]
 
== 2.1 Column assignment - wrong separators detected ==
Sometimes the system is able to detect that CSV separators are wrong and suggests you to change them:
 
[[File:Tariff_import_wrong_separators.png]]
 
== 2.2 Column assignment ==

The file is uploaded and the first five lines of the file are available to check:
 
[[Image:rateimportfromcsv2.png]]
 
This helps us in the next step, to assign CSV file's columns to MOR's variables. We have the following window:
 
[[Image:rateimportfromcsv3_2.png]]
 
Here we must assign columns from the CSV file. '''Prefix''' and '''Rate''' are mandatory fields. All other fields can be empty. If during import system will find corresponding headers in CSV file, columns will be assigned automatically. You just need to check is it correct.

'''[[Rate Effective From | Effective from]]''' date can be imported in various formats of date. If there is no Effective From date in CSV file you are able to set that date manually, otherwise Default value (it is now) will be taken.

In addition, you can also use of one of the '''quick''' buttons to set the time to '''Now''' (this will give you a full current time, e.g. 2015-09-29 19:06:21) or '''Start of today''' (e.g. 2015-09-29 00:00:00).

'''Connection Fee''', '''Increment''' and '''Min. Time''' have their defaults. If you wish, you can enter values manually for them. Manually entered values have the highest priority. If you omit them, then MOR inserts values from the CSV file. If there is no assigned column for these fields, then default values will be added to database (DB).

You can also import '''Ghost Percent''' with the rates. It works the same way as the '''Ghost minute percent''' in the [[Calling_Card_Groups | Calling Cards Groups]]: it is a value to trick the user into thinking he has more minutes when he really has less.

This way of selecting CSV rows and assigning them to MOR values lets us import various CSV file formats.
 
===Additional options===
 
[[File:Importfromcsv.png]]
 
'''Rate Day Type''' 

It is possible to select to which Day Type rates apply before importing them.

So in two steps it is possible to import separate Rates for Work Days and Free Days, or (in a single step) to import rates for All Days at once.

'''On/Off Peak Tariff import''' 

If you need to import tariffs for on/off peak periods, all you need to do is upload another tariff on top of the one you have with a different
time period.
* You are now able to specify peak and off-peak periods (hours, minutes, seconds) when importing tariffs for work days and weekdays.
* Important notice - time periods cannot cover each other.
* If for example you upload a tariff from 8am to 12pm. The Tariff that is uploaded on top can only be from 12pm to 8am.

'''Update Destination Names from file''' 

When this option is selected destination name is updated from csv file during rate import.

'''Delete Rates for Prefixes which are not present in imported file'''

This option allows you to delete existing rates, which will not be updated.(The prefixes that belong to these rates are not a part of the file being imported).
 

== 3. Column confirmation ==

The next step is to review our selection and confirm that everything is correct. We can go Back or forward to the next step:
 
[[Image:rateimportfromcsv5.png]]
 
'''NOTE''' Steps where is nothing to do (value = 0) will be skipped.
 

== 4. Analysis ==

It will take some time to accomplish this step. MOR checks many things from DB and CSV files: it compares rates, searches for duplicates, fixes small errors and so on. After the analysis is completed, we get something like this :
 
[[Image:Rate_import_analize.png]]
 
The most interesting line is '''737 bad destination(s)'''. We click on the List to check them. In the new window, we can see which destinations are bad and we can decide what to do with them. Is it possible that there are no directions for them, MOR doesn't know to which country to assign this destination, or maybe these destinations have duplicates in CSV file? You have to fix this if you want to import the whole file. Here you can stop and fix your CSV file, or you can ignore these errors and continue. 
Line '''Zero Rates in CSV file''' displays number of rates wich has zero value. These rates will not be ignored, and will be imported. 

We continue the demo by clicking ''Proceed''.

The following steps are separated to avoid excessive demands on processing power if a rate file is huge. This keeps the browser from crashing and allows it to successfully import 160.000+ destinations from one CSV file (this has been tested).
 

== 5.1. Creating Destinations ==

MOR creates new destinations here. These Destinations are necessary for the Rates, which will be added in step 7. This window is just informative, no decisions here:

MOR creates only Destinations for prefixes which are not yet in MOR's DB and determines whether it is possible to find out the Direction (Country) for these new prefixes (Destinations).

This may be done in two ways:

1. The system checks the available prefixes for the best match and selects found Direction as a basis for the new prefix (Destination).

For example: if you try to import the rate for prefix 370630 and this prefix is unknown to MOR, MOR checks the longest matching prefix - 3706 in this case - and finds out that it is Lithuania Mobile. So it creates a new Destination with Prefix 370630 in which the Direction will be Lithuania.

2. If Country code is available in the imported file, MOR assigns this Direction to the newly created Destination.

For example: if again you try to import 370630 and it is unknown to MOR, but you have LTU in same CSV line for Country Code field, MOR will create such a Destination with Direction = Lithuania.
 
[[Image:rateimportfromcsv7.png]]
 
'''NOTE''' Because Destination cannot be empty (space), during the Destination creation, MOR automatically sets Destination name as Direction, Destination name will be Direction.
 
== 5.2. Updating Destinations ==

Step appears when '''Update Destination Names from file''' is check in second step.
 
== 6. Updating rates ==

Here MOR updates rates with the values from CSV files. These rates already exist in DB. Just click ''Proceed'':
 
[[Image:rateimportfromcsv8.png]]
 
== 7. Creating new rates ==

Here, MOR creates rates that have not existed previously. Click ''Proceed'' afterwards.
 
[[Image:rateimportfromcsv9.png]]
 
== 8. Deleting rates ==

This is the final step. MOR deletes the rates which were not a part of the file being imported.
You're all done!

== NOTES ==

Rate import is VERY CPU-intensive.

If there are a lot of rates, please be patient and let MOR finish its job. It may take some time to count everything and come back to life.

At some point it may seem that browser is not responding. That is not the case – it is just working very hard, importing your very own rates from the CSV file.

If you get a timeout error, try to import the file in smaller pieces.

= Destination to create from CSV =

When importing rates from the CSV file, you can check which Destinations will be created automatically.

You can view them in a separate window when you click List in step 4 in the field "Destinations to create".

Such destinations do not exist in MOR's database but MOR will create them when importing the rate file.

More info: [[Integrity Check]]
 
= Example Videos =

<flashow>http://wiki.kolmisoft.com/videos/rates_import_from_csv.swf|width=600|height=455</flashow>

Similar video with different tariff:

<flashow>http://wiki.kolmisoft.com/videos/tariff_import_from_csv.swf|width=800|height=618</flashow>
 

Another example:

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

Another example with Provider tariff:

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

= See also =

* [[Importing Tariffs from CSV with wrong Regional Settings]]
* [[Good CSV rate file examples]]
* [[Bad CSV rate file examples]]
* [[How to create a csv file]]

Rate import from CSV

2015-11-26T10:53:08Z

Karolinas: /* 4. Analysis */

= File format =

File should be CSV (comma separated values).

Necessary fields in CSV line:

* Prefix
* Price

No other fields are necessary.

First line can be header.

''Value Separator'' and ''Decimal Separator'' MUST be set correctly in '''SETTINGS -> Setup -> Settings -> Functionality''':

* CSV Column Separator
* CSV Decimal Separator
 
[[File:Settings-functionality.png]]
 
File and CSV separator settings should match. If they do not, you will get errors when trying to import file.

* [[Good CSV rate file examples]]
* [[Bad CSV rate file examples]]
 
=== Where can I get an example file with available prefixes? ===

Go to '''SETTINGS -> Billing -> Tariffs''' and click on [[Image:icon_excel.png]] '''Destinations CSV'''.
 
= Description =

It is very tedious work to add several thousand rates by hand, so you can import them from a CSV file.

There are seven steps for importing rates from a CSV file:

# File upload
# Column assignment
# Column confirmation
# Analysis
# Creating destinations
# Updating rates
# Creating new rates

We will cover each of these one by one.

'''IMPORTANT NOTE: When importing, prefixes should be in E.164 format!!! For example, no international prefixes!'''
 
== 1. File upload ==

Select [[Image:excel.png]] '''Import from CSV''' for the Tariff you want to import rates.

Then click on '''Browse''' and select CSV file with rates. Click '''Upload file''':
 
[[Image:rateimportfromcsv1.png]]
 
== 2.1 Column assignment - wrong separators detected ==
Sometimes the system is able to detect that CSV separators are wrong and suggests you to change them:
 
[[File:Tariff_import_wrong_separators.png]]
 
== 2.2 Column assignment ==

The file is uploaded and the first five lines of the file are available to check:
 
[[Image:rateimportfromcsv2.png]]
 
This helps us in the next step, to assign CSV file's columns to MOR's variables. We have the following window:
 
[[Image:rateimportfromcsv3_2.png]]
 
Here we must assign columns from the CSV file. '''Prefix''' and '''Rate''' are mandatory fields. All other fields can be empty. If during import system will find corresponding headers in CSV file, columns will be assigned automatically. You just need to check is it correct.

'''[[Rate Effective From | Effective from]]''' date can be imported in various formats of date. If there is no Effective From date in CSV file you are able to set that date manually, otherwise Default value (it is now) will be taken.

In addition, you can also use of one of the '''quick''' buttons to set the time to '''Now''' (this will give you a full current time, e.g. 2015-09-29 19:06:21) or '''Start of today''' (e.g. 2015-09-29 00:00:00).

'''Connection Fee''', '''Increment''' and '''Min. Time''' have their defaults. If you wish, you can enter values manually for them. Manually entered values have the highest priority. If you omit them, then MOR inserts values from the CSV file. If there is no assigned column for these fields, then default values will be added to database (DB).

You can also import '''Ghost Percent''' with the rates. It works the same way as the '''Ghost minute percent''' in the [[Calling_Card_Groups | Calling Cards Groups]]: it is a value to trick the user into thinking he has more minutes when he really has less.

This way of selecting CSV rows and assigning them to MOR values lets us import various CSV file formats.
 
===Additional options===
 
[[File:Importfromcsv.png]]
 
'''Rate Day Type''' 

It is possible to select to which Day Type rates apply before importing them.

So in two steps it is possible to import separate Rates for Work Days and Free Days, or (in a single step) to import rates for All Days at once.

'''On/Off Peak Tariff import''' 

If you need to import tariffs for on/off peak periods, all you need to do is upload another tariff on top of the one you have with a different
time period.
* You are now able to specify peak and off-peak periods (hours, minutes, seconds) when importing tariffs for work days and weekdays.
* Important notice - time periods cannot cover each other.
* If for example you upload a tariff from 8am to 12pm. The Tariff that is uploaded on top can only be from 12pm to 8am.

'''Update Destination Names from file''' 

When this option is selected destination name is updated from csv file during rate import.

'''Delete Rates for Prefixes which are not present in imported file'''

This option allows you to delete existing rates, which will not be updated.(The prefixes that belong to these rates are not a part of the file being imported).
 

== 3. Column confirmation ==

The next step is to review our selection and confirm that everything is correct. We can go Back or forward to the next step:
 
[[Image:rateimportfromcsv5.png]]
 
'''NOTE''' Steps where is nothing to do (value = 0) will be skipped.
 

== 4. Analysis ==

It will take some time to accomplish this step. MOR checks many things from DB and CSV files: it compares rates, searches for duplicates, fixes small errors and so on. After the analysis is completed, we get something like this :
 
[[Image:Rate_import_analize.png]]
 
The most interesting line is '''737 bad destination(s)'''. We click on the List to check them. In the new window, we can see which destinations are bad and we can decide what to do with them. Is it possible that there are no directions for them, MOR doesn't know to which country to assign this destination, or maybe these destinations have duplicates in CSV file? You have to fix this if you want to import the whole file. Here you can stop and fix your CSV file, or you can ignore these errors and continue. 
Line '''Zero Rates in CSV file''' displays number of rates wich has zero value. These rates will not be ignored, and will be imported. 

We continue the demo by clicking ''Proceed''.

The following steps are separated to avoid excessive demands on processing power if a rate file is huge. This keeps the browser from crashing and allows it to successfully import 160.000+ destinations from one CSV file (this has been tested).

'''NOTE''', that unnecessary steps (e.g no destinations are planed to be created or rates to be updated) are always skipped to avoid clicking "Proceed" button.
 

== 5.1. Creating Destinations ==

MOR creates new destinations here. These Destinations are necessary for the Rates, which will be added in step 7. This window is just informative, no decisions here:

MOR creates only Destinations for prefixes which are not yet in MOR's DB and determines whether it is possible to find out the Direction (Country) for these new prefixes (Destinations).

This may be done in two ways:

1. The system checks the available prefixes for the best match and selects found Direction as a basis for the new prefix (Destination).

For example: if you try to import the rate for prefix 370630 and this prefix is unknown to MOR, MOR checks the longest matching prefix - 3706 in this case - and finds out that it is Lithuania Mobile. So it creates a new Destination with Prefix 370630 in which the Direction will be Lithuania.

2. If Country code is available in the imported file, MOR assigns this Direction to the newly created Destination.

For example: if again you try to import 370630 and it is unknown to MOR, but you have LTU in same CSV line for Country Code field, MOR will create such a Destination with Direction = Lithuania.
 
[[Image:rateimportfromcsv7.png]]
 
'''NOTE''' Because Destination cannot be empty (space), during the Destination creation, MOR automatically sets Destination name as Direction, Destination name will be Direction.
 
== 5.2. Updating Destinations ==

Step appears when '''Update Destination Names from file''' is check in second step.
 
== 6. Updating rates ==

Here MOR updates rates with the values from CSV files. These rates already exist in DB. Just click ''Proceed'':
 
[[Image:rateimportfromcsv8.png]]
 
== 7. Creating new rates ==

Here, MOR creates rates that have not existed previously. Click ''Proceed'' afterwards.
 
[[Image:rateimportfromcsv9.png]]
 
== 8. Deleting rates ==

This is the final step. MOR deletes the rates which were not a part of the file being imported.
You're all done!

== NOTES ==

Rate import is VERY CPU-intensive.

If there are a lot of rates, please be patient and let MOR finish its job. It may take some time to count everything and come back to life.

At some point it may seem that browser is not responding. That is not the case – it is just working very hard, importing your very own rates from the CSV file.

If you get a timeout error, try to import the file in smaller pieces.

= Destination to create from CSV =

When importing rates from the CSV file, you can check which Destinations will be created automatically.

You can view them in a separate window when you click List in step 4 in the field "Destinations to create".

Such destinations do not exist in MOR's database but MOR will create them when importing the rate file.

More info: [[Integrity Check]]
 
= Example Videos =

<flashow>http://wiki.kolmisoft.com/videos/rates_import_from_csv.swf|width=600|height=455</flashow>

Similar video with different tariff:

<flashow>http://wiki.kolmisoft.com/videos/tariff_import_from_csv.swf|width=800|height=618</flashow>
 

Another example:

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

Another example with Provider tariff:

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

= See also =

* [[Importing Tariffs from CSV with wrong Regional Settings]]
* [[Good CSV rate file examples]]
* [[Bad CSV rate file examples]]
* [[How to create a csv file]]

MOR API Calling Cards create

2015-11-05T10:09:49Z

Karolinas: /* Request */

=Description=
[[MOR API]] Calling Cards create
 
=Usage=

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

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

* card_group_id - id of a Card Group '''Required'''.
* cards_from - Cards' (to be created) number range beginning '''Required'''.
* cards_till - Cards' (to be created) number range ending '''Required'''.

'''* Note that cards_from <= cards_till. Both of the previous parameters are 10-digit-long integers.''' 
'''* 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 an API_Secret_Key.'''

 
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'''.
* batch_number - batch number for the Calling Cards.
* min_balance - minimum balance for the Calling Cards.
* distributor_id - Calling Cards' distributor's (User's) id.
* language - Language for the Calling Cards.
 

===Request===

We have u = admin, API Secret Key = secret

We send:

HTML POST: http://<SERVER_IP>/billing/api/calling_cards_create?u=admin&card_group_id=1&cards_from=1000000025&cards_till=1000000035&batch_number=50&
min_balance=15&language=en&distributor_id=2&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c

* Now we can find 11 newly created Calling Cards (number range: 1000000025-1000000035) in the Card Group's (id = 1) Cards' list.''' 
'''* Note that some Calling Cards may fail on creation if a given range overlaps with already existing Cards in a Card Group.''' 
'''* Note that passing invalid optional parameters will not be notified. Default values will be used instead.''' 
'''* Note that a Username and a Password are not included into hash'''
 

===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Cards created: 11/11</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>Bad login</error> - User is not authorized (possibly wrong Username).
* <error>Card Group was not found</error> - Card Group under a given id does not exist or a card_group_id parameter is missing from the API parameters' list.
* <error>Cards from was not found</error> - required cards_from parameter is missing.
* <error>Cards till was not found</error> - required cards_till parameter is missing.
* <error>Cards from is in incorrect format</error> - cards_from parameter's value is not numeric or is not 10-digit-long.
* <error>Cards till is in incorrect format</error> - cards_till parameter's value is not numeric or is not 10-digit-long.
* <error>Cards from must not be greater than Cards till</error> - cards_from parameter's value must not be grater than cards_till parameter's value. No proper Cards' number range is possible.
* <error>PIN is too short for this interval</error> - Card Group does not provide enough PIN codes for a given Cards' number range.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Cards from must not be greater than Cards till</error>
</status>
</page>
 

=See also=

* [[MOR API]]

M4 Custom Tariffs

2015-07-28T09:49:06Z

Karolinas:

== Description ==

Custom Tariff Rates have a higher priority than regular Tariff Rates. For example, if a Device has both Tariff and Custom Tariff and some Rate prefixes match between those Tariffs, the end user will view the specific Rates of Custom Tariff. Custom Tariffs functionality is accessible by Admin and Manager with Custom Tariff Permission rights.

== Usage ==

The functionality is accessible through /billing/tariffs/custom_tariffs

[[File:Custom_tariffs.png]]

To apply Custom Tariff for Connection Point go to /billing/devices/device_edit/X Origination Point section and choose Custom Tariff from dropdown.

[[File:Custom tariff in device.png]]

File:Custom tariff in device.png

2015-07-28T09:40:38Z

Karolinas:

M4 Custom Tariffs

2015-07-28T09:25:28Z

Karolinas:

[[File:Custom_tariffs.png]]

Custom Tariff Rates have a higher priority than regular Tariff Rates. For example, if a Device has both Tariff and Custom Tariff and some Rate prefixes match between those Tariffs, the end user will view the specific Rates of Custom Tariff.

M4 Custom Tariffs

2015-07-28T09:22:36Z

Karolinas:

[[File:Custom_tariffs.png]]

Custom tariff rates have a higher priority than regular tariff rates. For example, if a device has both tariff and custom tariff and some rate prefixes match between those tariffs, the end user will view the specific rates of custom tariff.

M4 Custom Tariffs

2015-07-28T09:13:25Z

Karolinas: Created page with 'File:Custom_tariffs.png'

[[File:Custom_tariffs.png]]

File:Custom tariffs.png

2015-07-28T09:07:45Z

Karolinas: Custom tariffs

Custom tariffs

MOR API user register

2015-04-14T11:37:13Z

Karolinas: /* 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'''.

'''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.
* '''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).
* '''client_id''' - Company/Personal ID.
* '''vat_number''' - TAX Registration Number.
* '''state'''
* '''county'''
* '''city'''
* '''postcode''' - Postcode/ZIP.
* '''address'''
* '''device_location_id'''
* '''lcr_id'''
* '''usertype'''
* '''permissions_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
 

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

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

* [[MOR API]]

M4 CDR Rerating

2015-03-31T11:44:12Z

Karolinas: /* Step 1 */

===CDR Rerating===

In M2 administrator is able to rerate previously made calls in case the tariff's rated weren't updated in time, so the user is billed properly to avoid any unjust money losses. In order to rerate user's calls you should first update his tariff's rates. Or choose a new tariff for him.
 
You can find the rerating functionality under '''BILLING''' -> '''CDR''' -> '''Rerating'''
 
The rerating functionality will prompt you with the following steps:

=Step 1=
The first step allows you to configure the period for the calls you are going to rerate, aswell as test the functionality and see the results without permanently changing the records in your database.

'''Available options:'''
* From - the beginning of the period you are going to rerate.
* To - the end of the period you are going to rerate.
* User - the user, whose calls are going to be rerated.
* Tariff for User - tariff which will be used for the selected user's devices - '''THIS IS USED IN TESTING MODE ONLY'''.

=Step 2=
The second step is basically a confirmation step. It displays the data you have selected in the first step and calculates the billsec for calls that are going to be related, aswell as the price for the Origination and the Termination points.

'''Displayed data:'''
* User - user whose calls are being rerated.
* Time period - the interval in which the calls are going to be related.
* Testing mode - shows whether the rerating is in testing mode.
* Total calls - the amount of calls that are going to be rerated.

* Total time - calculated billing time for the calls that are going to be related.
* Total Termination Point price - calculated price for Termination Points for the selected rerating period.
* Total User price - calculated price for the Origination Points for the selected rerating period.

=Step 3=
The third and final step displays the results of the rerating.

'''Displayed data:'''
* User - user whose calls are being rerated.
* Time period - the interval in which the calls are going to be related.
* Testing mode - shows whether the rerating is in testing mode.
* Total calls - the amount of calls that are going to be rerated.

* Total time
** Prior rerating - shows the calculated billing time for rerated calls prior to rerating.
** After rerating - shows the new calculated billing time for rerated calls after rerating.
** Difference - difference between the two above.
* Total Termination Point price
** Prior rerating - shows the calculated Termination Point price prior to rerating.
** After rerating - shows the new Origination Point price after rerating.
** Difference - difference between the two above.
* Total User price
** Prior rerating - shows the calculated Termination Point price prior to rerating.
** After rerating - shows the new Origination Point price after rerating.
** Difference - difference between the two above.

PBX Pools

2015-02-24T14:12:38Z

Karolinas:

=Description=

PBX Pools allows to create multiple Extensions in one system. It means that on one system can live big amount of different companies and each company can use same Extension as other is using.

Extensions are created for [[Devices]], [[Call Queues]], [[PBX Function External DID|External DIDs]], [[Ring-Groups|Ring Groups]]
 
=Usage=

Go to '''ADDONS –> PBX Functions –> PBX Pools'''
 
[[File:pbx_pool_path.png]]
 
Here you are able to see list of all PBX Pools which you have:
 
[[File:pbx_pool_list.png]]
 
In this page you can [[Image:icon_add.png]]'''Add new PBX Pool''', [[image:icon_edit.png]] edit or delete old one. You are not able to delete Global PBX Pool.

Click on blue user icon to see Users, who belongs to particular PBX Pool.
 
[[File:pbx_pools_users.png]]
 
Click on [[Image:view_icon.png]] icon to see Extensions which belongs to particular PBX Pool.
 

 
By default admin will have Global PBX Pool. '''This Pool is a set of Extensions which will be used if Extension is not found in other PBX Pools'''.
 
PBX Pools have to be assigned for
* [[Users]] (whose Devices will have Extensions),
* [[Call Queues]],
* [[PBX Function External DID|External DIDs]]
* [[Ring-Groups|Ring Groups]]

'''NOTE''' At same time '''PBX Pool cannot have two or more same Extensions'''. To prevent conflict some of PBX Pools, where duplicate Extension exists, will not be shown between selections.
 
=Example=

Let's say we have 3 different companies on one MOR system and all of them wants to use Extensions 101, 102, 103, 104. To make this situation work, need to create 3 different PBX Pools and assign them to [[Users]] (whose Devices will have Extensions), [[Call Queues]], [[PBX Function External DID|External DIDs]] or [[Ring-Groups|Ring Groups]].

File:Pbx pools users.png

2015-02-24T14:10:38Z

Karolinas: Picture for pbx pools users

Picture for pbx pools users

MOR API Subscriptions get

2015-01-12T10:43:01Z

Karolinas: /* Request */

= NOTE: Available from MOR X5 =

=Description=
[[MOR API]] Subscriptions get
 
=Usage=

* From '''MOR X5''' Call: '''/api/subscriptions_get'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

* u - username for authentication. '''Required'''.
* service_id - Subscription's Service id.
* subscription_activation_start - Subscription's Activation Start timestamp in System Time Zone (if defined - only time equal to it or after it).
* subscription_activation_end - Subscription's Activation End timestamp in System Time Zone (if defined - only time equal to it or before it).
* subscription_memo - Subscription's memo.
* subscription_until_canceled - defines if Subscription can be Until canceled - can not to have Activation End (0 - off, 1 - on, default - off).
* user_id - Subscription's User 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/subscriptions_get?&u=admin&service_id=2&subscription_activation_start=1307167264&subscription_activation_end=1307167265
&subscription_memo=Subscriptions memo&subscription_until_canceled=1&user_id=2
'''NOTE that username is not included in hash'''
 

'''Success'''

<page>
<status>
<subscriptions>
<subscription>
<user>Test User #1</user>
<device></device>
<service>Service Name</service>
<from>2011-06-04 06:01:04 +0200</from>
<till></till>
<time_left></time_left>
<memo>Subscriptions memo</memo>
<type>Subscription type</type>
<price></price>
<user_id></user_id>
</subscription>
</subscriptions>
</status>
</page>
 
----

'''Errors'''
* <error>No Subscriptions found</error> - Subscription was not found using specified params. Use correct params.
* <error>You are not authorized to manage Subscriptions</error> - Such username does not exist in the database or User does not have rights to manage Subscriptions.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key while concatenating hash_string.
 

=See also=

* [[MOR API]]
* [[MOR API subscription delete]]
* [[MOR API subscription create]]
* [[MOR API subscription update]]

PayPal Website Payments Pro technical details

2015-01-12T10:36:11Z

Karolinas: /* Configuration from MOR */

= Description =
[[Image:paypalpro_logo.jpg|right|100px]]
http://www.paypal.com/cgi-bin/webscr?cmd=_wp-pro-overview-outside
 
=What do you need to get started?=

In order to use PayPal Website Payments Pro in MOR, you need to generate a PayPal Live certificate.
Here is what you need to do:
 
1. Log in to https://www.paypal.com.
 
2. Click on "My Account" then "Profile".
 
3. Click the API Certificate Request link.
 
4. Enter API Username(from paypal page) in Login field in MOR PayPal payments PRO gateway.
 
5. Enter API Password(from paypal page) in Password field in MOR PayPal payments PRO gateway
 
6. Enter Signature in(from paypal page) in Signature field in MOR PayPal payments PRO gateway
 
=Configuration from MOR=

Go to '''ADDONS –> Payment gateways''' and click on PayPal Website Payments Pro (US) logo.
 
[[File:payment_gateways_path.png]]
 
Configuration settings will appear:
 
[[Image:paypal_pro.png]]
 
*'''Default currency''' – United States Currency will be used for Payments. During the payment, there is ability to choose one of active Currencies during the payment, but it will be converted to USD and payment will be send in USD.
*'''Enabled''' – check to activate PayPal Pro Payment Gateway.
*'''Login''' – username of PayPal Pro account.
*'''Password''' – password of PayPal Pro account.
*'''Signature'''
*'''Tax in amount''' – "Include" tax into amount that user has to pay or "Exclude" if you want to exclude the tax from the amount that is added to user's balance.
*'''Minimum amount''' – minimum amount which should be paid.
*'''Maximum amount''' – maximum amount which client should be able to pay.
''*Note - when executing Payment, Minimum and Maximum amount will be displayed in Currency which User has selected for this specific Payment''
*'''Payment confirmation by you'''
** '''Not required''' – No confirmation is required. Every payment is added to clients balance immediately.
** '''Required for suspicious payments''' – currently iDeal doesn't provide enough info to calculate suspiciousness.
** '''Required for all payments''' – When payments are completed they must be confirmed manually.
*'''Notify by email''' – check if you want to be notified by email after each payment.
*'''Logo''' – you can choose your own logo, which will be on the Start Page.
*'''Test mode''' – Turns on the test mode. Use this option only if you know what you are doing. In test mode MOR will send payment requests to bank's test environment, so the payments will not transfer actual money. On the other hand MOR still counts these payments as real and updates user's balance.
*'''PayPal custom redirect''' – check to redirect client after successful payment.
*'''Return URL on successful payment''' – address of page where client should be redirected after successful payment.
 

=Troubleshooting=

*[[PayPal_payments_do_not_work|PayPal payments do not work]]
 
=See also=

* [[Payment Gateway Addon]]

PayPal Website Payments Pro technical details

2015-01-12T10:32:43Z

Karolinas: /* Configuration from MOR */

= Description =
[[Image:paypalpro_logo.jpg|right|100px]]
http://www.paypal.com/cgi-bin/webscr?cmd=_wp-pro-overview-outside
 
=What do you need to get started?=

In order to use PayPal Website Payments Pro in MOR, you need to generate a PayPal Live certificate.
Here is what you need to do:
 
1. Log in to https://www.paypal.com.
 
2. Click on "My Account" then "Profile".
 
3. Click the API Certificate Request link.
 
4. Enter API Username(from paypal page) in Login field in MOR PayPal payments PRO gateway.
 
5. Enter API Password(from paypal page) in Password field in MOR PayPal payments PRO gateway
 
6. Enter Signature in(from paypal page) in Signature field in MOR PayPal payments PRO gateway
 
=Configuration from MOR=

Go to '''ADDONS –> Payment gateways''' and click on PayPal Website Payments Pro (US) logo.
 
[[File:payment_gateways_path.png]]
 
Configuration settings will appear:
 
[[Image:paypal_pro.png]]
 
*'''Default currency''' – United States Currency will be used for Payments. During the payment, there is ability to choose one of active Currencies during the payment, but it will be converted to USD and payment will be send in USD.
*'''Enabled''' – check to activate PayPal Pro Payment Gateway.
*'''Login''' – username of PayPal Pro account.
*'''Password''' – password of PayPal Pro account.
*'''Signature'''
*'''Tax in amount''' – "Include" tax into amount that user has to pay or "Exclude" if you want to exclude the tax from the amount that is added to user's balance.
*'''Minimum amount''' – minimum amount which should be paid.
*'''Maximum amount''' – maximum amount which client should be able to pay.
*'''Payment confirmation by you'''
** '''Not required''' – No confirmation is required. Every payment is added to clients balance immediately.
** '''Required for suspicious payments''' – currently iDeal doesn't provide enough info to calculate suspiciousness.
** '''Required for all payments''' – When payments are completed they must be confirmed manually.
*'''Notify by email''' – check if you want to be notified by email after each payment.
*'''Logo''' – you can choose your own logo, which will be on the Start Page.
*'''Test mode''' – Turns on the test mode. Use this option only if you know what you are doing. In test mode MOR will send payment requests to bank's test environment, so the payments will not transfer actual money. On the other hand MOR still counts these payments as real and updates user's balance.
*'''PayPal custom redirect''' – check to redirect client after successful payment.
*'''Return URL on successful payment''' – address of page where client should be redirected after successful payment.
''*Note - when executing Payment, Minimum and Maximum amount will be displayed in Currency which User has selected for this specific Payment''
 

=Troubleshooting=

*[[PayPal_payments_do_not_work|PayPal payments do not work]]
 
=See also=

* [[Payment Gateway Addon]]

PBX Function External DID

2014-12-03T13:22:19Z

Karolinas: /* Usage */

=Description=

'''!!WARNING - Deep Asterisk knowledge is a must before proceeding!!''' 

External DID function allows you to implement different PBX (or other Asterisk related functions) into MOR. 
When you assign some DID number pbxfunction External DID your call is forwarded to an extension file
in Asterisk called:

/etc/asterisk/extensions_mor_external_did.conf

Prior to making configurations in that file, please keep in mind, that:

When call comes to DID, for example DID number 1234567890 it will be forwarded to the dial plan in that file with extension:
 
exten => 1234567890,1,...
 
[[Image:warning.png|50px]]DID number and PBX function Extension '''CANNOT''' be the same. So if your DID is 1234567890, your PBX function extension
cannot be 1234567890, it can be any other number, like *235485.
 
In this file you can basically configure any function that Asterisk supports to handle your call, like:

* [http://www.voip-info.org/wiki/view/Asterisk+howto+dial+plan Custom dial plans] 
* [http://www.voip-info.org/wiki/view/Asterisk#HowtosandTutorials And many others] 
 

=Usage=

Go to '''ADDON –> PBX functions –> External DIDs''':
 
[[File:Pbx_functions_menu.png]]
 
Here you will see list off PBX function External DIDs
 
[[File:Pbx_function_external_did.png]]
 
Click on [[image:icon_edit.png]] icon to make changes for existing settings or enter Extension and Dial Plan name, select PBX Pool and PBX Function name and click on [[Image:icon_add.png]] icon to create new one.

*'''Note''': you can change the User who will be billed by pressing the edit button;
duplicate Extensions can not be created in same PBX Pool.

=See also=

* [[PBX Functions Addon]]

Ring-Groups

2014-12-03T13:15:13Z

Karolinas: /* How to create a new Ring Group? */

=About=

A ring group acts like any other Asterisk extension number except it rings a collection of Asterisk extensions which you specify. If you dial a ring group number, it will ring all of the Asterisk extensions associated with that ring group.
 

=Currently supported Dialing Strategies=

Currently MOR supports these Dialing Strategies:
*ringall

''If you need other dialing strategies to be implemented - please submit a ticket in Support system.''

 

==What is needed to setup a Ring Group?==
* At least one DID number, you can get one from [http://www.didww.com/ DIDWW]
 
==Where to find Ring Groups?==

'''Ring Groups''' currently are available only for admin and can be found in '''ADDONS –> PBX functions –> External DIDs –> Ring Groups''':
 
[[File:Ring groups path.png]]
 

==How to create a new Ring Group?==

1. Go to: '''SETTINGS -> Billing -> DIDs -> PBX functions -> Ring Groups'''

2. Press: [[File:add.png]] '''New Ring Group'''

3. New Ring Group setup will appear:

[[File:Ring_group_2.png]]

* '''Ring Group name:''' enter your Ring Group name here, for example "Sales ring group";
* '''Comment:''' (optional) enter your Ring Group description, for example "This is my Sales Ring group";
* '''This Ring Group will be reached by such local extension:''' Enter an extension, that will be used to dial this ring group
locally. Remember not to duplicate your [[Extension_lines | extensions!]];
* '''Extension belongs to PBX Pool:''' select PBX Pool. NOTE: duplicate Extensions can not be created in same PBX Pool.
* '''Ring Time (how long device will ring):''' Define how many seconds to ring the group of devices (default is 60 seconds);
* '''Options to use when dialing (Advanced):''' '''!!!ATTENTION!!!''' Do not use this field if you are not sure what you are doing. 
This field allows you to enter more advanced Dialing options.
More information can be found [http://www.voip-info.org/wiki/view/Asterisk+cmd+Dial#Dialmacros here];
* '''Dialing Strategy:''' Choose the ring strategy from the drop down list;
* '''CallerID Prefix:''' Define what callerID prefix should be added for the incoming call. For example, if your ring group is used for sales department, you can add a "sales" CallerID name;
* '''Route to DID if No Answer:''' Search for a DID number from the auto-complete list, to which route the call if none of the ring group devices answer the call. DID must be assigned to device or dialplan to be displayed in this list.
 

==How to add devices to a Ring Group?==
[[File:Ring_groups_3.png]]
 
* '''This Ring Group will be reached by such DIDs:''' Click on the [[File:Add_did_rg.png]] to assign a DID number from a drop down menu that will be used to call this Ring Group;
* '''Will ring these devices:''' Click on the [[File:Add_device_rg.png]] and choose [[Users | users]] with their [[Devices | devices]] which will be used in this Ring Group;
* '''Show Extension lines''' Click on this link in order to check the Extension lines which will be used when dialing. This is for information purposes only.
[[File:Extension_rg.png]]
 
* After you have successfully completed the configuration, you should see a similar result on the right hand side on the window (This is ONLY an example!!):
[[File:Ring_group.png]]

===Virtual device===

Adding a virtual device allows calling both to local devices and external numbers at the same time. Create a virtual device (click [[Devices| here]] for detailed information about devices) and then make a Call Flow for it. Click [[File:icon call flow.png]] to see a basic Call Flow and then click [[File:edit.png]] in the ''Before State'' line. Select Action: ''Forward'', Forward to: ''External number'', enter the number and click ''Change''.

[[File:Devices callflow.png]]

Device is now ready to be assigned to a Ring group.

 

= See also =
* [[How to forward Ring Group to Voicemail if not answered]]

Call Queues

2014-12-03T13:12:59Z

Karolinas: /* Queue Options */

=Description=

Call queue is a feature that allows an unlimited number of callers to wait for an available sales representative or for resources to become accessible to assist them. This allows you to provide each customer with the same quality service. In addition, it ensures your customers won’t end up in voicemail.

Queues consist of

*Incoming calls being placed in the queue
*Members that answer the queue (extensions or users that login as agents)
*A strategy for how to handle the queue and divide calls between members
*Music played while waiting in the queue
*Announcements for members and callers

=Usage=

==Queue Options==

'''Queue Name''' – name of Queue. 
'''Assigned DID(s)''' – quantity of DIDs, which are assigned to current Queue. 
'''PBX Pool''' – default PBX Pool is set Global, matching Extensions are not allowed in same PBX Pool. 
'''Extension''' – a short number by which this queue can be reached; must be unique in the pbx pool. 
'''Server''' – allows to choose server in multiple servers system. Server id on which server queue application will be executed 
'''Ring Strategies''' – Calls are distributed among the members handling a queue with one of several strategies: 
*ringall: ring all available channels until one answers (default)
*roundrobin: take turns ringing each available interface
*leastrecent: ring interface which was least recently called by this queue
*fewestcalls: ring the one with fewest completed calls from this queue
*random: ring random interface
*rrmemory: round robin with memory, remember where we left off last ring pass
*linear: rings members in the order specified, always starting at the beginning of the list
*wrandom: rings a random member, but uses the members’ penalties as a weight.
*rrorder: same as rrmemory, except the queue member order from configuration is preserved 

'''Queue Weight''' – for comparing with other queues, higher weights get first shot at available channels when the same channel is included in more than one queue. 
'''Autofill''' – makes sure that when the waiting callers are connecting with available members in a parallel fashion until there are no more available members or no more waiting callers. 
'''Skip Busy Agents''' – lets do not send calls to members whose devices are known to be 'in use'(Note: only the SIP channel driver currently is able to report 'in use'.) 
'''Fail Over Actions''' – set action what to do after Queue 
*Hangup
*Transfer to Extension
*Transfer to DID
*Transfer to Device 
 

==Agent Options==

'''CID Name Prefix''' – The CID Name Prefix is used to prefix the caller ID of callers in the queue with the value entered in this field. This is often used when agents are members of
multiple queues so that they know which department a person has called(for example, a CID may be prefixed with "Sales" or "Tech Support"). 
'''Report Hold Time''' – If you wish to report the caller's hold time to the member before they are connected to the caller, set this to yes. 
'''Agent Announcement''' – An announcement announce may be specified which is played for the member as soon as they answer a call, typically to indicate to them which queue this call hould be answered as, so that agents or members who are listening to more than one queue can differentiated how they should engage the customer 
'''Agent Delay''' – If you wish to have a delay before the member is connected to the caller (or before the member hears any announcement messages), set this to the number of seconds to delay. 
'''Agent Timeout''' – This timeout specifies the amount of time to try ringing a member's phone before considering the member to be unavailable. 
'''Retry''' – How long do we wait before trying all the members again? 
'''Wrap-Up-Time''' – After a successful call, how long to wait before sending a potentially free member another call (default is 0, or no delay) 
'''Allow hangup by *''' – allow callee to hang up by pressing 
 
==Static Agents==

To add Static Agent click on '''Add new Static Agent''' link and choose Device and Penalty.

'''Penalties'''

Queue members can be defined as having a penalty - e.g.
member => SIP/200,1
member => SIP/201,2
member => SIP/202,3
member => SIP/203,2
If the strategy is defined as 'ringall', then only those available members with the lowest priorities will ring. In the example above, if 200 is not busy, then only 200 will ring. If 200 is busy, then only 201 and 203 will ring. If 200, 201 and 203 are busy, then 202 will ring.

'''NOTE''' that if extension 200 does not pick up it will not automatically go to extension 201. It will keep ringing 200 until they pick up. It will only go to the next extension if the current extension is either busy or unavailable.
 
==Caller Options==

'''Max Callers''' – Maximum number of people waiting in the queue (0 for unlimited) 
'''Join Announcement''' – The Join Announcement drop-down menu is used to select a sound file to be played back to the caller before they are dropped into the queue. This file must be pre-recorded or uploaded to the system. This announcement is optional, but will usually state that the caller is being placed into a queue, and that their call will be answered in priority sequence. 
'''Ringing instead of MOH''' – ring instead of playing MOH. 
'''Music On Hold Class''' – Musicclass sets which music applies for this particular call queue. 
'''Ring at once when Agent is ringing''' – stops MOH and rings once an agent is ringing (Asterisk Trunk) 
'''Join Empty''' – This setting controls whether callers can join a queue with no members. 
*paused - a member is not considered available if he is paused
*penalty - a member is not considered available if his penalty is less than QUEUE_MAX_PENALTY
*inuse - a member is not considered available if he is currently on a call
*ringing - a member is not considered available if his phone is currently ringing
*unavailable - This applies mainly to Agent channels. If the agent is a member of the queue but has not logged in, then do not consider the member to be available
*invalid - Do not consider a member to be available if he has an "invalid" device state. This generally is caused by an error condition in the member's channel driver.
*unknown - Do not consider a member to be available if we are unable to determine the member's current device state.
*wrapup - A member is not considered available if he is currently in his wrapuptime after taking a call.
'''Leave When Empty''' – if you wish to remove callers from the queue when new callers cannot join, set this setting to one of the same choices for 'Join Empty' described above. 
'''Allow hangup by *''' – allow caller to hang up by pressing * 
'''IVR Brake-Out Menu''' – A context may be specified, in which if the user types a SINGLE digit extension while they are in the queue, they will be taken out of the queue and sent to that extension in this context. 
'''Max Wait Time''' – 'timeout' sets the time in seconds that a call will wait in the queue before it is routed to the next priority in the dialplan. It defaults to 300 seconds (5 minutes). 
 

==Caller Announcements==

'''Repeat Frequency''' – How often to announce queue position and/or estimated holdtime to caller 
'''Min. Announce Frequency''' – The absolute minimum time between the start of each queue position and/or estimated holdtime announcement This is useful for avoiding constant announcements when the caller's queue position is changing frequently (see announce-frequency) 
'''Announce Position''' – Queue position announce? Valid values are "yes," "no," "limit," or "more." If set to "no," then the caller's position will never be announced. If "yes," then the caller's position in the queue will be announced to the caller. If set to "more," then if the number of callers is more than the number specified by the announce-position-limit option, then the caller will hear that there are more than that many callers waiting (i.e. if a caller number 6 is in a queue with the announce-position-limit set to 5, then that caller will hear that there are more than 5 callers waiting). If set to "limit," then only callers within the limit specified by announce-position-limit will have their position announced. 
If you have specified "limit" or it "more" for the announce-position option, then the following value is what is used to determine what announcement to play to waiting callers. If you have set the announce-position option to anything else, then this will have no bearing on queue operation 
'''Announce Hold Time''' – Should we include estimated hold time in position announcements? Either yes, no, or only once. Hold time will be announced as the estimated time, or "less than 2 minutes" when appropriate. 
'''Round Seconds''' – What's the rounding time for the seconds? If this is non-zero, then we announce the seconds as well as the minutes rounded to this value. 
 
==Periodic Announcements==

This block allows a message like "Thank you for holding, your call is important to us." to be played at regular intervals while a caller is in the queue.

'''Repeat Frequency''' – How often to make any periodic announcement (see periodic-announce) 
'''Random''' – Should the periodic announcements be played in a random order? Default is no. 
'''Relative''' – If set to yes, the periodic announcment frequency will be timed from the end of each announcment rather than from the start of each announcment. This defaults to off.
 
'''Announcment''' – sound message 
 
==Vizualization==

[[Image:queue_visualization.png]]
 

=From Reseller/Reseller PRO=

Reseller/Reseller PRO is not able to use Queue functionality.
 
=From Accountant=

Accountant can manage Admins Queues if there are set '''Mange Queues''' permission in [[Accountant permissions]].

 
= Not supported additional functionality =

* Dynamic Agents (users who can login/logout to/from queue)
* Queue usage statistics

Such functionality is not planned, because MOR is not proper solution for Call Center environment with high-load. Queues in MOR are mainly for small office use.

This can change due to high-demand from our Clients.

M4 Routing Groups

2014-12-03T12:51:32Z

Karolinas:

Routing Group is logical routing entity (group of [[M2 Dial Peers | Dial Peers]]) which is assigned to [[M2 Origination Points | Origination Point]] and determines the route of the call from this [[M2 Origination Points | Origination Point]].
Routing group is able to have up to two Failover Routing Groups.

== Usage ==

Assume there are three Routing Groups: Group1, Group2 and Group3. Group1 has Group2 as Failover Group, Group2 has Group3 as Failover Group. When Routing Group - Group4 is created, it cannot have a Failover Group Group1 and neither can it be a Failover Group for Group3, because it exceeds maximum sequence length (3).

= Assigning Dial Peers =
Routing > Routing Groups > press on button in Dial Peers column
 
[[File:M2_assigned_dial_peers.png]]
 
Dial Peers can be assigned to Routing Groups, by pressing ASSIGN DIAL PEER button (1) then selecting Dial Peer from Dial Peers drop down list (2), setting Priority (3) and pressin ASSIGN button (7) 
Active column (4) shows if Dial Peer is active. It can be edited in Dial Peers edit page. 
Pressing on Dial Peers name (5) redirects to Dial Peers edit page. 
Pressing on Priority (6) allows to update Priority. In order to save it just pres somewhere else in the page. 
Pressing on REMOVE button (8) removes Dial Peer.

M4 Routing Groups

2014-12-03T12:50:56Z

Karolinas:

Routing Group is logical routing entity (group of [[M2 Dial Peers | Dial Peers]]) which is assigned to [[M2 Origination Points | Origination Point]] and determines the route of the call from this [[M2 Origination Points | Origination Point]].
Routing group is able to have up to two Failover Routing Groups

== Usage ==

Assume there are three Routing Groups: Group1, Group2 and Group3. Group1 has Group2 as Failover Group, Group2 has Group3 as Failover Group. When Routing Group - Group4 is created, it cannot have a Failover Group Group1 and neither can it be a Failover Group for Group3, because it exceeds maximum sequence length (3).

= Assigning Dial Peers =
Routing > Routing Groups > press on button in Dial Peers column
 
[[File:M2_assigned_dial_peers.png]]
 
Dial Peers can be assigned to Routing Groups, by pressing ASSIGN DIAL PEER button (1) then selecting Dial Peer from Dial Peers drop down list (2), setting Priority (3) and pressin ASSIGN button (7) 
Active column (4) shows if Dial Peer is active. It can be edited in Dial Peers edit page. 
Pressing on Dial Peers name (5) redirects to Dial Peers edit page. 
Pressing on Priority (6) allows to update Priority. In order to save it just pres somewhere else in the page. 
Pressing on REMOVE button (8) removes Dial Peer.

File:Ring groups 3.png

2014-12-03T12:43:08Z

Karolinas: uploaded a new version of "File:Ring groups 3.png"

File:Ring group 2.png

2014-12-03T12:34:25Z

Karolinas: uploaded a new version of "File:Ring group 2.png"

MOR API Service create

2014-12-03T11:59:42Z

Karolinas: /* Parametres */

=Description=
[[MOR API]] Create Service
 
=Usage=

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

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

* new_service_name - name of the Service '''Required'''.
* new_service_type - periodic_fee, one_time_fee or flat_rate. '''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 '''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'''. 
* '''u''' - username for authentication. '''Required'''.
* service_sell_price - price of the Service.
* service_self_cost - self cost of the Service.
* service_period - month or day. For Periodic fee service type only.
* service_minutes_per_month - for Flat-Rate service type only.
* new_owner_id - Only for admin, id of owner of service, which is admin or reseller
 

===Request===

We have u = admin, API Secret Key = secret

We send:

HTML POST: http://<SERVER_IP>/billing/api/service_create?u=admin&new_service_type=flat_rate&service_minutes_per_month=5&new_service_name=name&hash=38282ca5e65e63746498ef5b39a2fe71c6448df4

*Now we can find this Service in GUI Services list.

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

'''Success'''

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

'''Errors'''

* <error>Access Denied</error> - user was not authorized or is simple user. Only admin, reseller or accounant can use this API method.
* <error>Incorrect hash</error> - hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Service must have service type</error> - type must be one of periodic_fee, one_time_fee or flat_rate.
* <error>Flat Rate Service must have quantity</error> - Flat-Rate Service must have Minutes/month provided.
* <error>Quantity must be numeric</error> - Minutes/month must be a number.
* <error>Quantity must be greater than zero</error>
* <error>Service Price must be numeric</error>
* <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 has no permissions to manage Services.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Quantity must be numeric</error>
</status>
</page>
 

=See also=

* [[MOR API]]
* [[MOR_API_Service_delete | Services delete]]
* [[MOR_API_Service_update | Service update]]

PBX Function External DID

2014-12-03T11:05:01Z

Karolinas: /* Usage */

=Description=

'''!!WARNING - Deep Asterisk knowledge is a must before proceeding!!''' 

External DID function allows you to implement different PBX (or other Asterisk related functions) into MOR. 
When you assign some DID number pbxfunction External DID your call is forwarded to an extension file
in Asterisk called:

/etc/asterisk/extensions_mor_external_did.conf

Prior to making configurations in that file, please keep in mind, that:

When call comes to DID, for example DID number 1234567890 it will be forwarded to the dial plan in that file with extension:
 
exten => 1234567890,1,...
 
[[Image:warning.png|50px]]DID number and PBX function Extension '''CANNOT''' be the same. So if your DID is 1234567890, your PBX function extension
cannot be 1234567890, it can be any other number, like *235485.
 
In this file you can basically configure any function that Asterisk supports to handle your call, like:

* [http://www.voip-info.org/wiki/view/Asterisk+howto+dial+plan Custom dial plans] 
* [http://www.voip-info.org/wiki/view/Asterisk#HowtosandTutorials And many others] 
 

=Usage=

Go to '''ADDON –> PBX functions –> External DIDs''':
 
[[File:Pbx_functions_menu.png]]
 
Here you will see list off PBX function External DIDs
 
[[File:Pbx_function_external_did.png]]
 
Click on [[image:icon_edit.png]] icon to make changes for existing settings or enter Extension and Dial Plan name, select PBX Pool and PBX Function name and click on [[Image:icon_add.png]] icon to create new one.

*'''Note''': you can change the User who will be billed by pressing the edit button;
PBX Pool with same Extension in it can not be selected twice.

=See also=

* [[PBX Functions Addon]]

File:Pbx function external did.png

2014-12-03T10:51:18Z

Karolinas: uploaded a new version of "File:Pbx function external did.png": Reverted to version as of 10:45, 3 December 2014

File:Pbx function external did.png

2014-12-03T10:47:37Z

Karolinas: uploaded a new version of "File:Pbx function external did.png"

File:Pbx function external did.png

2014-12-03T10:45:38Z

Karolinas: uploaded a new version of "File:Pbx function external did.png"

MOR API conflines update

2014-11-26T10:45:48Z

Karolinas: /* Request */

=Description=


[[MOR API]] changes settings for API, Default User or Default Device.
 
=Usage=

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

No parameters are '''included''' into hash. Hash is generated only using admin's API secret key.
 
Parameters which are '''not included''' into hash:
* '''u''' - username for authentication. '''Required'''.
* '''allow_api''' - disable api (send 0 to disable). NOTE: you can enable API only in GUI.
* '''api_secret_key''' - change API secret key.
* '''default_user_password_length''' - positive number between 6 and 30 digits.
* '''default_user_credit''' - send -1 for unlimited, 0 and bigger for amount.
* '''default_user_balance''' - send any number to change Default User Balance.
* '''default_user_postpaid''' - send 0 for prepaid, 1 - postpaid.
* '''default_user_allow_loss_calls''' - send 0 for disabled, 1 - enabled.
* '''default_user_call_limit''' - send any positive number.
* '''default_user_time_zone''' - case sensitive name of the time zone. Send only name, for example: Atlantic Time (Canada).
* '''default_user_currency''' - 3 letters code of the [http://wiki.kolmisoft.com/index.php/Currencies#Default_supported_currencies currency]
* '''default_user_quickforwards_rule_id''' - id of the quickforward DID rule.
* '''default_user_recording_enabled''' - send 0 for disabled, 1 - enabled.
* '''default_user_recording_forced_enabled''' - send 0 for disabled, 1 - enabled.
* '''default_device_call_limit''' - send positive number
* '''default_device_canreinvite''' - one of these values: ''yes'', ''no'', ''nonat'', ''update'', ''update,nonat''.
* '''default_device_nat''' - one of these values: ''yes'', ''no'', ''force_rport'', ''comedia''.
* '''default_device_qualify''' - send ''no'' or value equal 1000 or more.
* '''default_device_grace_time''' - send positive number.
* '''default_device_audio_codecs''' - send the name of codecs you want to have enabled. The ones not mentioned, will be turned off. Available values: ''alaw'', ''ulaw'', ''g723'', ''g726'', ''g729'', ''gsm'', ''ilbc'', ''lpc10'', ''speex'', ''sdpcm'', ''slin''.
* '''default_device_video_codecs''' - send the name of codecs you want to have enabled. The ones not mentioned, will be turned off. Available values: ''h261'', ''h263'', ''h263p'', ''h264''.
* '''default_device_location_id''' - ID of existing Location.
* '''default_user_tariff_id''' - ID of existing Tariff.
* '''[[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'''. 
 
'''NOTE:''' reseller is not required to enable API. This method uses admin's API settings.

===Request===

HTML POST: http://<SERVER_IP>/billing/api/conflines_update?u=admin&api_secret_key=987654321&default_user_tariff_id=2&default_device_location_id=3&
default_device_video_codecs=h263&default_device_audio_codecs=ilbc,speex&default_device_grace_time=111&default_device_qualify=2356&default_device_nat=force_rport&
default_device_canreinvite=update,nonat&default_device_call_limit=9985&default_user_recording_forced_enabled=0&default_user_recording_enabled=0&
default_user_currency=EUR&default_user_time_zone=Mountain Time (US %26 Canada)&default_user_call_limit=72&default_user_allow_loss_calls=0&default_user_postpaid=1&
default_user_balance=102.65948&default_user_credit=-1&default_user_password_length=23&
default_user_quickforwards_rule_id=0hash=7c4a8d09ca3762af61e59520943dc26494f8941b
 

===Returns===

'''Success'''

<page>
<status>
<success>Conflines successfully updated</success>
</status>
</page>
 
----
'''Errors'''

* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Access Denied</error> - access not allowed.
* <error>Device was not found</error> - Device id incorrect or does not exist.
* <error>default_user_password_length must be between 6 and 30</error>
* <error>default_user_credit must be positive number or -1 for infinity</error>
* <error>default_user_balance must be number</error>
* <error>default_user_postpaid must be 0 or 1</error>
* <error>default_user_allow_loss_calls must be 0 or 1</error>
* <error>default_user_credit must be positive integer</error>
* <error>default_user_time_zone name was not correct</error>
* <error>default_user_currency name was not correct</error>
* <error>default_user_currency name was not correct</error>
* <error>default_user_quickforwards_rule_id was not found</error>
* <error>default_user_recording_enabled must be 0 or 1</error>
* <error>default_user_recording_forced_enabled must be 0 or 1</error>
* <error>default_device_call_limit must be positive integer</error>
* <error>default_device_canreinvite can only be one of the following: 'yes', 'no', 'nonat', 'update', 'update,nonat'</error>
* <error>default_device_nat can only be one of the following: 'yes', 'no', 'force_rport', 'comedia'</error>
* <error>default_device_qualify can only be 'no' or >= 1000 integer</error>
* <error>default_device_grace_time must be positive integer</error>
* <error>default_device_location_id was not found</error> - Locationd with such ID was not found.
* <error>default_user_tariff_id was not found</error> - Tariff with such ID was not found.
* <error>allow_api must be 0 or 1</error>
* <error>api_secret_key length must be higher than 5</error>
 

=See also=

* [[MOR API]]

MOR API conflines update

2014-11-26T10:39:18Z

Karolinas: /* Returns */

=Description=


[[MOR API]] changes settings for API, Default User or Default Device.
 
=Usage=

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

No parameters are '''included''' into hash. Hash is generated only using admin's API secret key.
 
Parameters which are '''not included''' into hash:
* '''u''' - username for authentication. '''Required'''.
* '''allow_api''' - disable api (send 0 to disable). NOTE: you can enable API only in GUI.
* '''api_secret_key''' - change API secret key.
* '''default_user_password_length''' - positive number between 6 and 30 digits.
* '''default_user_credit''' - send -1 for unlimited, 0 and bigger for amount.
* '''default_user_balance''' - send any number to change Default User Balance.
* '''default_user_postpaid''' - send 0 for prepaid, 1 - postpaid.
* '''default_user_allow_loss_calls''' - send 0 for disabled, 1 - enabled.
* '''default_user_call_limit''' - send any positive number.
* '''default_user_time_zone''' - case sensitive name of the time zone. Send only name, for example: Atlantic Time (Canada).
* '''default_user_currency''' - 3 letters code of the [http://wiki.kolmisoft.com/index.php/Currencies#Default_supported_currencies currency]
* '''default_user_quickforwards_rule_id''' - id of the quickforward DID rule.
* '''default_user_recording_enabled''' - send 0 for disabled, 1 - enabled.
* '''default_user_recording_forced_enabled''' - send 0 for disabled, 1 - enabled.
* '''default_device_call_limit''' - send positive number
* '''default_device_canreinvite''' - one of these values: ''yes'', ''no'', ''nonat'', ''update'', ''update,nonat''.
* '''default_device_nat''' - one of these values: ''yes'', ''no'', ''force_rport'', ''comedia''.
* '''default_device_qualify''' - send ''no'' or value equal 1000 or more.
* '''default_device_grace_time''' - send positive number.
* '''default_device_audio_codecs''' - send the name of codecs you want to have enabled. The ones not mentioned, will be turned off. Available values: ''alaw'', ''ulaw'', ''g723'', ''g726'', ''g729'', ''gsm'', ''ilbc'', ''lpc10'', ''speex'', ''sdpcm'', ''slin''.
* '''default_device_video_codecs''' - send the name of codecs you want to have enabled. The ones not mentioned, will be turned off. Available values: ''h261'', ''h263'', ''h263p'', ''h264''.
* '''default_device_location_id''' - ID of existing Location.
* '''default_user_tariff_id''' - ID of existing Tariff.
* '''[[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'''. 
 
'''NOTE:''' reseller is not required to enable API. This method uses admin's API settings.

===Request===

HTML POST: http://<SERVER_IP>/billing/api/conflines_update?u=admin&api_secret_key=987654321&default_device_video_codecs=h263&default_device_audio_codecs=ilbc,speex&default_device_grace_time=111&default_device_qualify=2356&default_device_nat=force_rport&default_device_canreinvite=update,nonat&default_device_call_limit=9985&default_user_recording_forced_enabled=0&default_user_recording_enabled=0&default_user_currency=EUR&default_user_time_zone=Mountain Time (US %26 Canada)&default_user_call_limit=72&default_user_allow_loss_calls=0&default_user_postpaid=1&default_user_balance=102.65948&default_user_credit=-1&default_user_password_length=23&default_user_quickforwards_rule_id=0&hash=7c4a8d09ca3762af61e59520943dc26494f8941b
 

===Returns===

'''Success'''

<page>
<status>
<success>Conflines successfully updated</success>
</status>
</page>
 
----
'''Errors'''

* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Access Denied</error> - access not allowed.
* <error>Device was not found</error> - Device id incorrect or does not exist.
* <error>default_user_password_length must be between 6 and 30</error>
* <error>default_user_credit must be positive number or -1 for infinity</error>
* <error>default_user_balance must be number</error>
* <error>default_user_postpaid must be 0 or 1</error>
* <error>default_user_allow_loss_calls must be 0 or 1</error>
* <error>default_user_credit must be positive integer</error>
* <error>default_user_time_zone name was not correct</error>
* <error>default_user_currency name was not correct</error>
* <error>default_user_currency name was not correct</error>
* <error>default_user_quickforwards_rule_id was not found</error>
* <error>default_user_recording_enabled must be 0 or 1</error>
* <error>default_user_recording_forced_enabled must be 0 or 1</error>
* <error>default_device_call_limit must be positive integer</error>
* <error>default_device_canreinvite can only be one of the following: 'yes', 'no', 'nonat', 'update', 'update,nonat'</error>
* <error>default_device_nat can only be one of the following: 'yes', 'no', 'force_rport', 'comedia'</error>
* <error>default_device_qualify can only be 'no' or >= 1000 integer</error>
* <error>default_device_grace_time must be positive integer</error>
* <error>default_device_location_id was not found</error> - Locationd with such ID was not found.
* <error>default_user_tariff_id was not found</error> - Tariff with such ID was not found.
* <error>allow_api must be 0 or 1</error>
* <error>api_secret_key length must be higher than 5</error>
 

=See also=

* [[MOR API]]

MOR API conflines update

2014-11-26T10:36:52Z

Karolinas: /* Parameters */

=Description=


[[MOR API]] changes settings for API, Default User or Default Device.
 
=Usage=

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

No parameters are '''included''' into hash. Hash is generated only using admin's API secret key.
 
Parameters which are '''not included''' into hash:
* '''u''' - username for authentication. '''Required'''.
* '''allow_api''' - disable api (send 0 to disable). NOTE: you can enable API only in GUI.
* '''api_secret_key''' - change API secret key.
* '''default_user_password_length''' - positive number between 6 and 30 digits.
* '''default_user_credit''' - send -1 for unlimited, 0 and bigger for amount.
* '''default_user_balance''' - send any number to change Default User Balance.
* '''default_user_postpaid''' - send 0 for prepaid, 1 - postpaid.
* '''default_user_allow_loss_calls''' - send 0 for disabled, 1 - enabled.
* '''default_user_call_limit''' - send any positive number.
* '''default_user_time_zone''' - case sensitive name of the time zone. Send only name, for example: Atlantic Time (Canada).
* '''default_user_currency''' - 3 letters code of the [http://wiki.kolmisoft.com/index.php/Currencies#Default_supported_currencies currency]
* '''default_user_quickforwards_rule_id''' - id of the quickforward DID rule.
* '''default_user_recording_enabled''' - send 0 for disabled, 1 - enabled.
* '''default_user_recording_forced_enabled''' - send 0 for disabled, 1 - enabled.
* '''default_device_call_limit''' - send positive number
* '''default_device_canreinvite''' - one of these values: ''yes'', ''no'', ''nonat'', ''update'', ''update,nonat''.
* '''default_device_nat''' - one of these values: ''yes'', ''no'', ''force_rport'', ''comedia''.
* '''default_device_qualify''' - send ''no'' or value equal 1000 or more.
* '''default_device_grace_time''' - send positive number.
* '''default_device_audio_codecs''' - send the name of codecs you want to have enabled. The ones not mentioned, will be turned off. Available values: ''alaw'', ''ulaw'', ''g723'', ''g726'', ''g729'', ''gsm'', ''ilbc'', ''lpc10'', ''speex'', ''sdpcm'', ''slin''.
* '''default_device_video_codecs''' - send the name of codecs you want to have enabled. The ones not mentioned, will be turned off. Available values: ''h261'', ''h263'', ''h263p'', ''h264''.
* '''default_device_location_id''' - ID of existing Location.
* '''default_user_tariff_id''' - ID of existing Tariff.
* '''[[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'''. 
 
'''NOTE:''' reseller is not required to enable API. This method uses admin's API settings.

===Request===

HTML POST: http://<SERVER_IP>/billing/api/conflines_update?u=admin&api_secret_key=987654321&default_device_video_codecs=h263&default_device_audio_codecs=ilbc,speex&default_device_grace_time=111&default_device_qualify=2356&default_device_nat=force_rport&default_device_canreinvite=update,nonat&default_device_call_limit=9985&default_user_recording_forced_enabled=0&default_user_recording_enabled=0&default_user_currency=EUR&default_user_time_zone=Mountain Time (US %26 Canada)&default_user_call_limit=72&default_user_allow_loss_calls=0&default_user_postpaid=1&default_user_balance=102.65948&default_user_credit=-1&default_user_password_length=23&default_user_quickforwards_rule_id=0&hash=7c4a8d09ca3762af61e59520943dc26494f8941b
 

===Returns===

'''Success'''

<page>
<status>
<success>Conflines successfully updated</success>
</status>
</page>
 
----
'''Errors'''

* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Access Denied</error> - access not allowed.
* <error>Device was not found</error> - Device id incorrect or does not exist.
* <error>default_user_password_length must be between 6 and 30</error>
* <error>default_user_credit must be positive number or -1 for infinity</error>
* <error>default_user_balance must be number</error>
* <error>default_user_postpaid must be 0 or 1</error>
* <error>default_user_allow_loss_calls must be 0 or 1</error>
* <error>default_user_credit must be positive integer</error>
* <error>default_user_time_zone name was not correct</error>
* <error>default_user_currency name was not correct</error>
* <error>default_user_currency name was not correct</error>
* <error>default_user_quickforwards_rule_id was not found</error>
* <error>default_user_recording_enabled must be 0 or 1</error>
* <error>default_user_recording_forced_enabled must be 0 or 1</error>
* <error>default_device_call_limit must be positive integer</error>
* <error>default_device_canreinvite can only be one of the following: 'yes', 'no', 'nonat', 'update', 'update,nonat'</error>
* <error>default_device_nat can only be one of the following: 'yes', 'no', 'force_rport', 'comedia'</error>
* <error>default_device_qualify can only be 'no' or >= 1000 integer</error>
* <error>default_device_grace_time must be positive integer</error>
* <error>allow_api must be 0 or 1</error>
* <error>api_secret_key length must be higher than 5</error>
 
=See also=

* [[MOR API]]

MOR API device create

2014-11-26T10:19:17Z

Karolinas: /* Description */

=Description=
[[MOR API]] Create Device
 

=Usage=

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

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

* user_id - User ID in MOR database, for which user device should be created. '''Required'''.
* description - string
* pin - [number. '']. If pin param not send -> random_numbers . If blank -> pinless
* type - Device type [SIP, IAX2, FAX, Virtual,H323, ZAP, Skype, '']. When is '' -> default device type. If default device type is empty -> 'SIP'
* devicegroup_id - device group ID
* caller_id - CallerID
'''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'''. 
* '''u''' - username for authentication. '''Required'''.
* '''extension''' - Device Extension
 

===Request===

We have user_id = 2, API Secret Key = secret

We send:

HTML POST: http://<SERVER_IP>/billing/api/device_create?u=admin&user_id=2&description=desription1&pin=3&hash=6e79d4a82f68102f43be11d873177f47817f84df

*Now we can find these Devices in GUI Devices list.

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

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>Device created</status>
<id>id of new device</id>
<username>username of new device</username>
<password>password of new device</password>
</page>
 
----

'''Errors'''

* <error>User was not found</error> - User was not found using user_id. Use correct user id.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Dont be so smart</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.
* <error>Device type invalid</error> - Enter correct type.
* <error>Device group invalid</error> - Device group with id not found. Enter group id.
* <error>Pin is already used</error> - Enter onother pin.
* <error>Pin must be numeric</error> - Enter correct pin.
* <error>You are not authorized to manage callerid</error> - User does not have permissions to manage CallerID option.
* <error>Device was not created</error>
** <message>problem message</message>

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<error>Error message</error>
</page>
 

=See also=

* [[MOR API]]

MOR API device create

2014-11-26T10:18:44Z

Karolinas: /* Parametres */

=Description=
[[MOR API]] Create device
 
=Usage=

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

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

* user_id - User ID in MOR database, for which user device should be created. '''Required'''.
* description - string
* pin - [number. '']. If pin param not send -> random_numbers . If blank -> pinless
* type - Device type [SIP, IAX2, FAX, Virtual,H323, ZAP, Skype, '']. When is '' -> default device type. If default device type is empty -> 'SIP'
* devicegroup_id - device group ID
* caller_id - CallerID
'''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'''. 
* '''u''' - username for authentication. '''Required'''.
* '''extension''' - Device Extension
 

===Request===

We have user_id = 2, API Secret Key = secret

We send:

HTML POST: http://<SERVER_IP>/billing/api/device_create?u=admin&user_id=2&description=desription1&pin=3&hash=6e79d4a82f68102f43be11d873177f47817f84df

*Now we can find these Devices in GUI Devices list.

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

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>Device created</status>
<id>id of new device</id>
<username>username of new device</username>
<password>password of new device</password>
</page>
 
----

'''Errors'''

* <error>User was not found</error> - User was not found using user_id. Use correct user id.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Dont be so smart</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.
* <error>Device type invalid</error> - Enter correct type.
* <error>Device group invalid</error> - Device group with id not found. Enter group id.
* <error>Pin is already used</error> - Enter onother pin.
* <error>Pin must be numeric</error> - Enter correct pin.
* <error>You are not authorized to manage callerid</error> - User does not have permissions to manage CallerID option.
* <error>Device was not created</error>
** <message>problem message</message>

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<error>Error message</error>
</page>
 

=See also=

* [[MOR API]]

MOR API sms send

2014-11-26T10:17:32Z

Karolinas: /* Returns */

= Description =
SMS API is used to integrate MOR with other external systems like CRM, ERP or other for SMS sending through them.

'''Note:''' SMS API can use only '''Simple Users'''.
 

= Usage =

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

* lcr_id - LCR ID in MOR database. '''Required'''.
* u - username to login. '''Required'''.
* dst - Destination number. '''Required'''.
* src - Source number. '''Required'''.
* message - Message that you want to send. '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.

'''* Note that message must be in [http://meta.wikimedia.org/wiki/Help:URL URL Encode]'''
 
===Request===

We have lcr_id = 1, dst = 937567337911, src = 9375783123767, message = hi, API key = 123456
**We send:
HTML POST: http://<server_ip>/billing/api/sms_send?u=username&lcr_id=1&dst=937567337911&src=9375783123767&message=hi&hash=cc0e27123e27f08de2fbc68a2c8ba0b213654687

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

===Returns===

'''Success'''
<page>
<response>
<status>ok</status>
<message>
<message_id> message id </message_id>
<sms_status_code_tip>SMS is sent</sms_status_code_tip>
<price> price </price>
<currency> currency </currency>
</message>
</response>
</page>
 
----

'''Errors'''

* <error>There is no message or it is empty</error> – message text not found.
* <error>Wrong source</error> – source number is wrong.
* <error>Wrong destination</error> – destination number is wrong.
* <error>There is no such LCR</error> – LCR id not found.
* <error>User is not subscribed to sms service</error> – user is not [[SMS_Addon#Configuration | Subscribed]] for sms usage.
* <error>System owner does not have rate for this destination</error> - SMS status code and tip [[SMS Addon - Status codes]]
* <error>Bad login</error> – User with Username, defined in parameter '''u''', is not found.
* <error>Access Denied</error> – User is not Simple User.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
 

= See also =

* [[MOR API]]

MOR API user details get

2014-11-26T10:13:51Z

Karolinas: /* 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>
</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]]

MOR API user details update

2014-11-26T10:07:25Z

Karolinas: /* Parametres */

=Description=

[[MOR API]] Update user from params.
 
If Admin has checked Allow Resellers to use Admin Tariffs in [[API Configuration]] then using this API Reseller can set for his Users Wholesale or Retail Tariffs which belongs to Admin.
 
'''Please note that it is not necessary to send ALL user parameters - you can send only those you need to update.'''
 

=Usage=

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

===Parametres===

Parameters which are '''included''' into hash (if it is used):

* user_id - Users ID in MOR database, whose details we want to change. '''REQUIRED'''.
* u - username of user which can modify details (admin, reseller or accountant). '''REQUIRED'''.
* u0 - vat number
* u1 - lcr id
* u2 - warning email hour
* u3 - hide destination end
* u4 - currency id
* u5 - tariff id
* u6 - warning email balance
* u7 - spy device id
* u8 - language
* u9 - username
* u10 - warning balance call
* u11 - acc group id
* u12 - generate invoice
* u13 - usertype
* u14 - taxation country
* u15 - blocked
* u16 - quickforwards rule id
* u17 - last name
* u18 - call limit
* u19 - clientid
* u20 - recording hdd quota
* u21 - cyberplat active
* u22 - recordings email
* u23 - first name
* u24 - warning balance sound file id
* u25 - postpaid
* u26 - accounting number
* u27 - agreement number
* u28 - hidden
* ay - agr_date year
* am - agr_date month
* ad - agr_date day
* by - block at date year2011
* bm - block at date month
* bd - block at date day
* pswd - password
* user_warning_email_hour
* pgui - privacy gui [0-off, 1-on]
* pcsv - privacy csv [0-off, 1-on]
* ppdf - privacy pdf [0-off, 1-on]
* recording_forced_enabled - [0-off, 1-on]
* i4 - invoice detailed csv [0-off, 16-on]
* tax4_enabled - [0-off, 1-on]
* tax2_enabled - [0-off, 1-on]
* accountant_type_invalid
* block_at_conditional - 15
* tax3_enabled - [0-off, 1-on]
* accountant_type
* tax1_value - float
* show_zero_calls - [0-off, 1-on]
* warning_email_active - [0-off, 1-on]
* compound_tax - [0-off, 1-on]
* tax4_name -
* allow_loss_calls - [0-off, 1-on]
* tax3_name -
* tax2_name -
* credit - float
* tax1_name -
* total_tax_name -
* tax2_value - float
* tax4_value - float
* ignore_global_monitorings - [0-off, 1-on]
* i1 - invoice pdf [0-off, 2-on]
* tax3_value - float
* cyberplat_active - [0-off, 1-on]
* i2 - invoice csv [0-off, 4-on]
* i3 - invoice detailed pdf [0-off, 8-on]
* recording_enabled - [0-off, 1-on]
* email_warning_sent_test - [0-off, 1-on]
* own_providers - [0-off, 1-on]
* a0 - address
* a1 - city
* a2 - postcode
* a3 - county
* a4 - mob_phone
* a5 - fax
* a6 - direction id
* a7 - phone
* a8 - email
* a9 - state

'''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 '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''REQUIRED'''.
 
'''Additional feature'''
 
If API setting '''Allow Resellers to use Admin Quick Forward Rules''' is enabled: Reseller is able to set Quick Forward Rules inherited from Admin. '''u16''' should be used as a parameter for Quick Forward Rules.
 

===Reguest===

We have user_id = 123, API Secret Key = 456789, u15=1 (we want to block user)

We send:
HTML POST: http://<server_ip>/api/user_details_update?u=username&user_id=123&u15=1&hash=0ab3ede4e93a55c38855a2cc9b9e169d35442c48

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

Other examples:

HTML POST: http://<server_ip>/billing/api/user_update_api?u15=1&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request blocks (u15=1) user with ID 789 (user_id=789). User belongs to admin (u=admin).

HTML POST: http://<server_ip>/billing/api/user_update_api?u16=3&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request changes user quickforwards rule to rule with ID 3 (u16=3) user with ID 789 (user_id=789). User belongs to admin (u=admin).
 
===Returns===

'''Success'''

<page>
<status>User was updated</status>
</page>
 
----
'''Errors'''

* <error>User was not found</error> - User was not found using user_id. Use correct user id.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Access Denied</error> - Check params and permissions.
* <error>You have no editing permission</error> - Accountant dont have permission.
* <error>Tariff not found</error> - Tariff was not found using param u5.
* <error>User was not updated</error>
* <message>problem message</message>
 

=See also=

* [[MOR API]]

MOR API

2014-11-26T10:03:32Z

Karolinas: /* MOR users that are allowed to use MOR API */

[[File:warning.png|100px]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X5. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>

 
=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_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 update | user_balance_update]] (change_user_balance) – changes 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.

 

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

 

==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 Send==
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.

 
==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 sms send

2014-11-26T10:02:00Z

Karolinas: /* Description */

= Description =
SMS API is used to integrate MOR with other external systems like CRM, ERP or other for SMS sending through them.

'''Note:''' SMS API can use only '''Simple Users'''.
 

= Usage =

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

* lcr_id - LCR ID in MOR database. '''Required'''.
* u - username to login. '''Required'''.
* dst - Destination number. '''Required'''.
* src - Source number. '''Required'''.
* message - Message that you want to send. '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.

'''* Note that message must be in [http://meta.wikimedia.org/wiki/Help:URL URL Encode]'''
 
===Request===

We have lcr_id = 1, dst = 937567337911, src = 9375783123767, message = hi, API key = 123456
**We send:
HTML POST: http://<server_ip>/billing/api/sms_send?u=username&lcr_id=1&dst=937567337911&src=9375783123767&message=hi&hash=cc0e27123e27f08de2fbc68a2c8ba0b213654687

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

===Returns===

'''Success'''
<page>
<response>
<status>ok</status>
<message>
<message_id> message id </message_id>
<sms_status_code_tip>SMS is sent</sms_status_code_tip>
<price> price </price>
<currency> currency </currency>
</message>
</response>
</page>
 
----

'''Errors'''

* <error>There is no message or it is empty</error> – message text not found.
* <error>Wrong source</error> – source number is wrong.
* <error>Wrong destination</error> – destination number is wrong.
* <error>There is no such LCR</error> – LCR id not found.
* <error>User is not subscribed to sms service</error> – user is not [[SMS_Addon#Configuration | Subscribed]] for sms usage.
* <error>1 - failed, admin does not have rate for this destination</error> - SMS status code and tip [[SMS Addon - Status codes]]
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
 
= See also =

* [[MOR API]]

MOR API device update

2014-11-26T09:59:49Z

Karolinas: /* Parameters */

=Description=


[[MOR API]] update existing Device from params.
 
=Usage=

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

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

* '''device''' - device_id. '''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 '''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'''. 
* '''u''' - username for authentication. '''Required'''.
* '''new_location_id''' - location_id.
 
'''Additional feature'''
 
If API setting '''Allow Resellers to use Admin Localization Rules''' is enabled: Reseller is able to set location inherited from Admin. '''new_location_id''' should be used as a parameter for location.
 

===Request===

HTML POST: http://<SERVER_IP>/billing/api/device_update?u=admin&device=2&location_id=7&hash=297dab8c386794b2e947d52affb8f576c643569e
 

===Returns===

'''Success'''

<page>
<status>
<success>Device successfully updated</success>
</status>
</page>
 
----
'''Errors'''

* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Access Denied</error> - access not allowed
* <error>Device was not found</error> - Device id incorrect or does not exist
* <error>Location was not found</error> - Location id incorrect or does not exist
 
=See also=

* [[MOR API]]

MOR API device update

2014-11-26T09:56:56Z

Karolinas: /* Parameters */

=Description=


[[MOR API]] update existing Device from params.
 
=Usage=

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

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

* '''device''' - device_id. '''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 '''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'''. 
* '''u''' - username for authentication. '''Required'''.
* '''new_location_id''' - location_id.
 
'''Additional feature''' If API setting '''Allow Resellers to use Admin Localization Rules''' is enabled: Reseller is able to set location inherited from Admin. '''new_location_id''' should be used as a parameter for location.
 

===Request===

HTML POST: http://<SERVER_IP>/billing/api/device_update?u=admin&device=2&location_id=7&hash=297dab8c386794b2e947d52affb8f576c643569e
 

===Returns===

'''Success'''

<page>
<status>
<success>Device successfully updated</success>
</status>
</page>
 
----
'''Errors'''

* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Access Denied</error> - access not allowed
* <error>Device was not found</error> - Device id incorrect or does not exist
* <error>Location was not found</error> - Location id incorrect or does not exist
 
=See also=

* [[MOR API]]

Invoices

2014-11-13T10:06:13Z

Karolinas: /* Configuration */

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

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

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
==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''' -  From Administrator account Invoices for Users are exported according to selected currency in the top of page. From User account Invoices are exported in Users 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''' shows common information like time period, total price and total price with tax. PDF also shows services list, their quantity, unit prices...
*'''Invoice detailed''' PDF shows same information like simple invoice and includes calls list.
*'''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.
 
'''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'''
 
[[Image:invoice_xlsx_settings_x6.png]]
 
'''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]]
 
=== 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.

'''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.
 
= 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 for which users to recalculate invoices.
 
=== 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]]
 
= Send invoices by email =

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

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]

Invoices

2014-11-13T10:05:47Z

Karolinas: /* Configuration */

= 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, User 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''
 

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

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
==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''' -  From Administrator account Invoices for Users are exported according to selected currency in the top of page. From User account Invoices are exported in Users 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''' shows common information like time period, total price and total price with tax. PDF also shows services list, their quantity, unit prices...
*'''Invoice detailed''' PDF shows same information like simple invoice and includes calls list.
*'''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.
 
'''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'''
 
[[Image:invoice_xlsx_settings_x6.png]]
 
'''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]]
 
=== 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.

'''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.
 
= 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 for which users to recalculate invoices.
 
=== 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]]
 
= Send invoices by email =

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

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]

File:Invoice xlsx settings x6.png

2014-11-13T10:01:45Z

Karolinas:

File:Recalculate single invoice x6.png

2014-11-13T09:48:29Z

Karolinas:

File:Generate invoices x6.png

2014-11-13T09:45:38Z

Karolinas:

File:Service details.png

2014-11-13T09:40:24Z

Karolinas:

Invoices

2014-11-13T09:28:54Z

Karolinas: /* Invoice Services Details */

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

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
==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''' -  From Administrator account Invoices for Users are exported according to selected currency in the top of page. From User account Invoices are exported in Users 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''' shows common information like time period, total price and total price with tax. PDF also shows services list, their quantity, unit prices...
*'''Invoice detailed''' PDF shows same information like simple invoice and includes calls list.
*'''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.
 
'''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'''
 
[[Image:invoice_xlsx_settings_x6.png]]
 
'''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]]
 
=== 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.

'''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.
 
= 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 for which users to recalculate invoices.
 
=== 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]]
 
= Send invoices by email =

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

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]

File:Invoice services x6.png

2014-11-13T09:24:26Z

Karolinas:

Invoices

2014-11-13T09:23:53Z

Karolinas: /* Invoice Services Details */

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

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
==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''' -  From Administrator account Invoices for Users are exported according to selected currency in the top of page. From User account Invoices are exported in Users 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''' shows common information like time period, total price and total price with tax. PDF also shows services list, their quantity, unit prices...
*'''Invoice detailed''' PDF shows same information like simple invoice and includes calls list.
*'''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.
 
'''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'''
 
[[Image:invoice_xlsx_settings_x6.png]]
 
'''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]]
 
=== 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 Services Details==
 
[[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.

'''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.
 
= 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 for which users to recalculate invoices.
 
=== 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]]
 
= Send invoices by email =

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

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]