https://wiki.kolmisoft.com/api.php?action=feedcontributions&user=Aisteb&feedformat=atomKolmisoft Wiki - User contributions [en]2024-03-29T10:51:33ZUser contributionsMediaWiki 1.37.1https://wiki.kolmisoft.com/index.php?title=M4_Quick_Stats&diff=20705M4 Quick Stats2016-03-01T20:00:17Z<p>Aisteb: </p>
<hr />
<div>Quick Stats lets you follow your incomes statistics of current month, current day and real time (Active Calls).<br />
<br />
These are stats for all Calls made in the system in mentioned periods:<br />
<br><br><br />
[[Image:m2_admin_quick_stats.png]]<br />
<br><br><br />
Also uptime stats are shown for active servers.<br />
<br />
<!---Admin calls are counted same way as user calls, i.e. profit from then = user price - provider price.---><br />
<br />
Click on the Active Calls value to go to the '''Active Calls''' page for more details.<br><br />
Click on the Calls value to go to the '''Last Calls''' page for more details.<br><br />
Hold mouse pointer over chosen server line for more details.<br />
<br><br><br />
=See Also=<br />
<br />
* [[Active Calls]]<br />
* [[Last Calls]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:M2_admin_quick_stats.png&diff=20704File:M2 admin quick stats.png2016-03-01T19:58:49Z<p>Aisteb: uploaded a new version of "File:M2 admin quick stats.png"</p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:Admin_quick_stats.png&diff=20703File:Admin quick stats.png2016-03-01T19:57:54Z<p>Aisteb: uploaded a new version of "File:Admin quick stats.png"</p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=M2_Archived_Calls&diff=20690M2 Archived Calls2016-02-26T13:52:04Z<p>Aisteb: </p>
<hr />
<div>=Description=<br />
<br />
When there are many old calls that are no longer useful, they can be archived and moved to other place. <br />
<br />
Such house-keeping increases system stability, reliability and speed. <br />
<br><br><br />
=Usage=<br />
<br />
==Configuration==<br />
<br />
Archiving options can be set in '''MAINTENANCE -> Settings -> CALLS''' section:<br />
<br />
* '''Archive to''' - choose where to store Archived Calls. By default Archived Calls are stored in another MySQL table ''mor.calls_old''. You can also choose to store Archived Calls in compressed CSV files by selecting ''File (TGZ)'' option.<br><br />
* '''Archive Calls older than''' – this is the number of days. When Call is older than the number you set, it will be archived and moved to Archived Calls.<br><br />
* '''Archive only ANSWERED calls''' – check to archive only answered Calls. Failed, Busy and No Answer Calls will be deleted.<br><br />
* '''Archive Calls every day at''' – when archiving process should be started? Call archiving requires a lot of system resources therefore it is advisable to start archiving when call traffic is low.<br><br />
* '''Stop Archiving Calls at''' – when archiving process should be stopped? If is advisable to stop archiving before call traffic is increased. If time is not specified, Call archiving will be stopped when all Calls are archived.<br><br />
* '''Delete Calls instead of Archiving''' - if you don't need Calls older than X days, you can delete them instead of archive.<br><br />
* '''Delete Archived Calls older than''' - this is the number of days. When '''archived''' Call is older than the number you set, it will be deleted.<br><br />
<br />
'''NOTE''': you can check the completion of calls archiving process and other information in Background Tasks.<br />
<br><br><br />
==Archived Calls==<br />
<br />
If calls are stored in another MySQL table ''mor.calls_old'' it can be found at '''STATISTICS –> Calls –> Archived Calls'''.<br> <br />
Here you can see similar table to Last Calls, so you can check calls information at anytime you want. You can find more information about each field in [[Last Calls]]<br><br />
<br />
'''NOTE''' Simple Users cannot see Archived Calls page.<br />
<br><br><br />
==Archived Calls in Files==<br />
<br />
If ''Archive to File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).<br> <br />
'''Calls archivation into file allows to avoid growing database and lets to use archived calls data mor flexible.'''<br />
<br />
Files with calls can be found at '''REPORTS –> Calls –> Archived Calls -> Files'''<br />
<br><br><br />
[[File:m2_old_calls_in_file.png|1040px]]<br />
<br><br><br />
'''NOTE''' Files can be reached and managed by '''admin''' only.<br />
<br><br><br />
===Bulk management===<br />
<br />
Files can be deleted one by one with click on '''DELETE''' in files list or few at a time by selecting period in '''Bulk management'''</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=M2_Archived_Calls&diff=20689M2 Archived Calls2016-02-26T13:50:17Z<p>Aisteb: /* Archived Calls in Files */</p>
<hr />
<div>=Description=<br />
<br />
When there are many old calls that are no longer useful, they can be archived and moved to other place. <br />
<br />
Such house-keeping increases system stability, reliability and speed. <br />
<br><br><br />
=Usage=<br />
<br />
==Settings==<br />
<br />
Archiving options can be set in '''MAINTENANCE -> Settings -> CALLS''' section:<br />
<br />
* '''Archive to''' - choose where to store Archived Calls. By default Archived Calls are stored in another MySQL table ''mor.calls_old''. You can also choose to store Archived Calls in compressed CSV files by selecting ''File (TGZ)'' option.<br><br />
* '''Archive Calls older than''' – this is the number of days. When Call is older than the number you set, it will be archived and moved to Archived Calls.<br><br />
* '''Archive only ANSWERED calls''' – check to archive only answered Calls. Failed, Busy and No Answer Calls will be deleted.<br><br />
* '''Archive Calls every day at''' – when archiving process should be started? Call archiving requires a lot of system resources therefore it is advisable to start archiving when call traffic is low.<br><br />
* '''Stop Archiving Calls at''' – when archiving process should be stopped? If is advisable to stop archiving before call traffic is increased. If time is not specified, Call archiving will be stopped when all Calls are archived.<br><br />
* '''Delete Calls instead of Archiving''' - if you don't need Calls older than X days, you can delete them instead of archive.<br><br />
* '''Delete Archived Calls older than''' - this is the number of days. When '''archived''' Call is older than the number you set, it will be deleted.<br><br />
<br />
'''NOTE''': you can check the completion of calls archiving process and other information in Background Tasks.<br />
<br><br><br />
==Archived Calls==<br />
<br />
If calls are stored in another MySQL table ''mor.calls_old'' it can be found at '''STATISTICS –> Calls –> Archived Calls'''.<br> <br />
Here you can see similar table to Last Calls, so you can check calls information at anytime you want. You can find more information about each field in [[Last Calls]]<br><br />
<br />
'''NOTE''' Simple Users cannot see Archived Calls page.<br />
<br><br><br />
==Archived Calls in Files==<br />
<br />
If ''Archive to File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).<br> <br />
'''Calls archivation into file allows to avoid growing database and lets to use archived calls data mor flexible.'''<br />
<br />
Files with calls can be found at '''REPORTS –> Calls –> Archived Calls -> Files'''<br />
<br><br><br />
[[File:m2_old_calls_in_file.png|1040px]]<br />
<br><br><br />
'''NOTE''' Files can be reached and managed by '''admin''' only.<br />
<br><br><br />
===Bulk management===<br />
<br />
Files can be deleted one by one with click on '''DELETE''' in files list or few at a time by selecting period in '''Bulk management'''</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:M2_old_calls_in_file.png&diff=20688File:M2 old calls in file.png2016-02-26T13:49:12Z<p>Aisteb: </p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=M2_Archived_Calls&diff=20687M2 Archived Calls2016-02-26T13:44:16Z<p>Aisteb: /* Bulk management */</p>
<hr />
<div>=Description=<br />
<br />
When there are many old calls that are no longer useful, they can be archived and moved to other place. <br />
<br />
Such house-keeping increases system stability, reliability and speed. <br />
<br><br><br />
=Usage=<br />
<br />
==Settings==<br />
<br />
Archiving options can be set in '''MAINTENANCE -> Settings -> CALLS''' section:<br />
<br />
* '''Archive to''' - choose where to store Archived Calls. By default Archived Calls are stored in another MySQL table ''mor.calls_old''. You can also choose to store Archived Calls in compressed CSV files by selecting ''File (TGZ)'' option.<br><br />
* '''Archive Calls older than''' – this is the number of days. When Call is older than the number you set, it will be archived and moved to Archived Calls.<br><br />
* '''Archive only ANSWERED calls''' – check to archive only answered Calls. Failed, Busy and No Answer Calls will be deleted.<br><br />
* '''Archive Calls every day at''' – when archiving process should be started? Call archiving requires a lot of system resources therefore it is advisable to start archiving when call traffic is low.<br><br />
* '''Stop Archiving Calls at''' – when archiving process should be stopped? If is advisable to stop archiving before call traffic is increased. If time is not specified, Call archiving will be stopped when all Calls are archived.<br><br />
* '''Delete Calls instead of Archiving''' - if you don't need Calls older than X days, you can delete them instead of archive.<br><br />
* '''Delete Archived Calls older than''' - this is the number of days. When '''archived''' Call is older than the number you set, it will be deleted.<br><br />
<br />
'''NOTE''': you can check the completion of calls archiving process and other information in Background Tasks.<br />
<br><br><br />
==Archived Calls==<br />
<br />
If calls are stored in another MySQL table ''mor.calls_old'' it can be found at '''STATISTICS –> Calls –> Archived Calls'''.<br> <br />
Here you can see similar table to Last Calls, so you can check calls information at anytime you want. You can find more information about each field in [[Last Calls]]<br><br />
<br />
'''NOTE''' Simple Users cannot see Archived Calls page.<br />
<br><br><br />
==Archived Calls in Files==<br />
<br />
If ''Archive to File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).<br> <br />
'''Calls archivation into file allows to avoid growing database and lets to use archived calls data mor flexible.'''<br />
<br />
Files with calls can be found at '''REPORTS –> Calls –> Archived Calls -> Files'''<br />
<br><br><br />
[[File:m2_old_calls_in_file.png]]<br />
<br><br><br />
'''NOTE''' Files can be reached and managed by '''admin''' only.<br />
<br><br><br />
===Bulk management===<br />
<br />
Files can be deleted one by one with click on '''DELETE''' in files list or few at a time by selecting period in '''Bulk management'''</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=M2_Archived_Calls&diff=20686M2 Archived Calls2016-02-26T13:43:38Z<p>Aisteb: Created page with '=Description= When there are many old calls that are no longer useful, they can be archived and moved to other place. Such house-keeping increases system stability, reliabili…'</p>
<hr />
<div>=Description=<br />
<br />
When there are many old calls that are no longer useful, they can be archived and moved to other place. <br />
<br />
Such house-keeping increases system stability, reliability and speed. <br />
<br><br><br />
=Usage=<br />
<br />
==Settings==<br />
<br />
Archiving options can be set in '''MAINTENANCE -> Settings -> CALLS''' section:<br />
<br />
* '''Archive to''' - choose where to store Archived Calls. By default Archived Calls are stored in another MySQL table ''mor.calls_old''. You can also choose to store Archived Calls in compressed CSV files by selecting ''File (TGZ)'' option.<br><br />
* '''Archive Calls older than''' – this is the number of days. When Call is older than the number you set, it will be archived and moved to Archived Calls.<br><br />
* '''Archive only ANSWERED calls''' – check to archive only answered Calls. Failed, Busy and No Answer Calls will be deleted.<br><br />
* '''Archive Calls every day at''' – when archiving process should be started? Call archiving requires a lot of system resources therefore it is advisable to start archiving when call traffic is low.<br><br />
* '''Stop Archiving Calls at''' – when archiving process should be stopped? If is advisable to stop archiving before call traffic is increased. If time is not specified, Call archiving will be stopped when all Calls are archived.<br><br />
* '''Delete Calls instead of Archiving''' - if you don't need Calls older than X days, you can delete them instead of archive.<br><br />
* '''Delete Archived Calls older than''' - this is the number of days. When '''archived''' Call is older than the number you set, it will be deleted.<br><br />
<br />
'''NOTE''': you can check the completion of calls archiving process and other information in Background Tasks.<br />
<br><br><br />
==Archived Calls==<br />
<br />
If calls are stored in another MySQL table ''mor.calls_old'' it can be found at '''STATISTICS –> Calls –> Archived Calls'''.<br> <br />
Here you can see similar table to Last Calls, so you can check calls information at anytime you want. You can find more information about each field in [[Last Calls]]<br><br />
<br />
'''NOTE''' Simple Users cannot see Archived Calls page.<br />
<br><br><br />
==Archived Calls in Files==<br />
<br />
If ''Archive to File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).<br> <br />
'''Calls archivation into file allows to avoid growing database and lets to use archived calls data mor flexible.'''<br />
<br />
Files with calls can be found at '''REPORTS –> Calls –> Archived Calls -> Files'''<br />
<br><br><br />
[[File:m2_old_calls_in_file.png]]<br />
<br><br><br />
'''NOTE''' Files can be reached and managed by '''admin''' only.<br />
<br><br><br />
===Bulk management===<br />
<br />
Files can be deleted one by one with click on [[Image:icon_delete.png]] icon in files list or few at a time by selecting period in [[image:icon_edit.png]]'''Bulk management'''</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Archived_Calls_in_Files&diff=20685Archived Calls in Files2016-02-26T13:31:30Z<p>Aisteb: /* Files */</p>
<hr />
<div>=Description=<br />
<br />
[[Archived calls]] functionality helps to increase system stability, reliability and speed. Calls archivation into file allows to avoid growing database and lets to use archived calls data mor flexible.<br />
<br><br><br />
=Usage=<br />
<br />
==Settings==<br />
<br />
Archiving options can be set in '''SETTINGS -> Setup -> Settings -> Calls''' tab:<br />
<br><br><br />
[[File:archived_calls_settings.png]]<br />
<br><br><br />
If ''Archive to File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).<br />
<br><br><br />
==Files==<br />
<br />
Files with calls can be found at '''STATISTICS –> Calls –> Archived Calls -> Files'''<br />
<br><br><br />
[[File:old_calls_in_file.png]]<br />
<br><br><br />
'''NOTE''' Files can be reached and managed by '''admin''' only.<br />
<br><br><br />
===Bulk management===<br />
<br />
Files can be deleted one by one with click on [[Image:icon_delete.png]] icon in files list or few at a time by selecting period in [[image:icon_edit.png]]'''Bulk management'''<br />
<br><br><br />
[[File:old_calls_in_file_bulk_management.png]]<br />
<br><br><br />
<br />
= See Also =<br />
<br />
* [[Archived calls]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:Old_calls_in_file_bulk_management.png&diff=20684File:Old calls in file bulk management.png2016-02-26T13:30:57Z<p>Aisteb: </p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Archived_Calls_in_Files&diff=20683Archived Calls in Files2016-02-26T13:30:08Z<p>Aisteb: </p>
<hr />
<div>=Description=<br />
<br />
[[Archived calls]] functionality helps to increase system stability, reliability and speed. Calls archivation into file allows to avoid growing database and lets to use archived calls data mor flexible.<br />
<br><br><br />
=Usage=<br />
<br />
==Settings==<br />
<br />
Archiving options can be set in '''SETTINGS -> Setup -> Settings -> Calls''' tab:<br />
<br><br><br />
[[File:archived_calls_settings.png]]<br />
<br><br><br />
If ''Archive to File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).<br />
<br><br><br />
==Files==<br />
<br />
Files with calls can be found '''STATISTICS –> Calls –> Archived Calls -> Files'''<br />
<br><br><br />
[[File:old_calls_in_file.png]]<br />
<br><br><br />
'''NOTE''' Files can be reached and managed by '''admin''' only.<br />
<br><br><br />
===Bulk management===<br />
<br />
Files can be deleted one by one with click on [[Image:icon_delete.png]] icon in files list or few at a time by selecting period in [[image:icon_edit.png]]'''Bulk management'''<br />
<br><br><br />
[[File:old_calls_in_file_bulk_management.png]]<br />
<br><br><br />
= See Also =<br />
<br />
* [[Archived calls]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:Old_calls_in_file.png&diff=20682File:Old calls in file.png2016-02-26T13:18:16Z<p>Aisteb: </p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Archived_Calls_in_Files&diff=20681Archived Calls in Files2016-02-26T13:16:01Z<p>Aisteb: Created page with '=Description= Archived calls functionality helps to increase system stability, reliability and speed. Calls archivation into file allows to avoid growing database and lets t…'</p>
<hr />
<div>=Description=<br />
<br />
[[Archived calls]] functionality helps to increase system stability, reliability and speed. Calls archivation into file allows to avoid growing database and lets to use archived calls data mor flexible.<br />
<br><br><br />
=Usage=<br />
<br />
==Settings==<br />
<br />
Archiving options can be set in '''SETTINGS -> Setup -> Settings -> Calls''' tab:<br />
<br><br><br />
[[File:archived_calls_settings.png]]<br />
<br><br><br />
If ''Archive to File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).<br />
<br><br><br />
==Files==<br />
<br />
Files with calls can be found '''STATISTICS –> Calls –> Archived Calls -> Files'''<br />
<br><br><br />
[[File:old_calls_in_file.png]]<br />
<br><br><br />
'''NOTE''' Files can be reached and managed by '''admin''' only.<br />
<br><br><br />
= See Also =<br />
<br />
* [[Archived calls]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Archived_calls&diff=20680Archived calls2016-02-26T12:56:34Z<p>Aisteb: </p>
<hr />
<div>=Description=<br />
<br />
When there are many old calls that are no longer useful, they can be archived and moved to other place. <br />
<br />
Such house-keeping increases system stability, reliability and speed. <br />
<br><br><br />
=Usage=<br />
<br />
==Settings==<br />
<br />
Archiving options can be set in '''SETTINGS -> Setup -> Settings -> Calls''' tab:<br />
<br><br><br />
[[File:archived_calls_settings.png]]<br />
<br><br><br />
* '''Archive to''' - choose where to store Archived Calls. By default Archived Calls are stored in another MySQL table ''mor.calls_old''. You can also choose to store [[Archived Calls in Files |Archived Calls in compressed CSV files]] by selecting ''File (TGZ)'' option. If ''File (TGZ)'' option is enabled, Calls will be archived to CSV files (max 50000 lines per file), then compressed to TGZ and stored in your Backup storage directory (http://wiki.kolmisoft.com/index.php/Backup_system#Configuration).<br><br />
* '''Archive Calls older than''' – this is the number of days. When Call is older than the number you set, it will be archived and moved to Archived Calls.<br><br />
* '''Archive only ANSWERED calls''' – check to archive only answered Calls. Failed, Busy and No Answer Calls will be deleted.<br><br />
* '''Archive Calls every day at''' – when archiving process should be started? Call archiving requires a lot of system resources therefore it is advisable to start archiving when call traffic is low.<br><br />
* '''Stop Archiving Calls at''' – when archiving process should be stopped? If is advisable to stop archiving before call traffic is increased. If time is not specified, Call archiving will be stopped when all Calls are archived.<br><br />
* '''Delete Calls instead of Archiving''' - if you don't need Calls older than X days, you can delete them instead of archive.<br><br />
* '''Delete Archived Calls older than''' - this is the number of days. When '''archived''' Call is older than the number you set, it will be deleted.<br><br />
<br />
'''NOTE''': you can check the completion of calls archiving process and other information in [[Background_Tasks| Background Tasks]].<br />
<br><br><br />
==Archived Calls==<br />
<br />
If calls are stored in another MySQL table ''mor.calls_old'' it can be found at '''STATISTICS –> Calls –> Archived Calls'''<br />
<br><br><br />
[[File:old-calls.png]]<br />
<br><br><br />
Here you can see similar table to Last Calls, so you can check calls information at anytime you want. You can find more information about each field in [[Last Calls]]<br><br />
<br />
'''NOTE''' Simple Users cannot see Archived Calls page.<br />
<br><br><br />
= See also = <br />
<br />
<!--* Call Rerating--><br />
* [[Background_Tasks| Background Task]]<br />
* [[Archived Calls in Files]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Call_list&diff=20644Call list2016-02-18T08:10:29Z<p>Aisteb: </p>
<hr />
<div>Go to '''SETTINGS –> Users'''<br />
<br><br><br />
[[File:Users path.png]]<br />
<br><br><br />
In window below click on the [[Image:icon_calls.png]] to see [[Last Calls]] of selected User.<br />
<br><br><br />
[[File:Users_path_2.png]]<br />
<br><br><br />
=See also=<br />
<br />
* [[Last Calls]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=M4_Quick_Stats&diff=20632M4 Quick Stats2016-02-17T07:48:40Z<p>Aisteb: </p>
<hr />
<div>Quick Stats lets you follow your incomes statistics of current month, current day and real time (Active Calls).<br />
<br />
These are stats for all Calls made in the system in mentioned periods:<br />
<br><br><br />
[[Image:m2_admin_quick_stats.png]]<br />
<br><br><br />
<!---Admin calls are counted same way as user calls, i.e. profit from then = user price - provider price.---><br />
<br />
Click on the Active Calls value to go to the '''Active Calls''' page for more details.<br><br />
Click on the Calls value to go to the '''Last Calls''' page for more details.<br />
<br><br><br />
=See Also=<br />
<br />
* [[Active Calls]]<br />
* [[Last Calls]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=M4_Quick_Stats&diff=20631M4 Quick Stats2016-02-17T07:46:50Z<p>Aisteb: Created page with 'Quick Stats lets you follow your incomes statistics of current month, current day and real time (Active Calls). These are stats for all Calls made in the system in mentioned per…'</p>
<hr />
<div>Quick Stats lets you follow your incomes statistics of current month, current day and real time (Active Calls).<br />
<br />
These are stats for all Calls made in the system in mentioned periods:<br />
<br><br><br />
[[Image:m2_admin_quick_stats.png]]<br />
<br><br><br />
<!---Admin calls are counted same way as user calls, i.e. profit from then = user price - provider price.---><br />
<br />
Click on the Active Calls value to go to the '''Active Calls''' page for more details.<br><br />
Click on the Calls value to go to the '''Last Calls''' page for more details.<br />
<br><br></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:M2_admin_quick_stats.png&diff=20630File:M2 admin quick stats.png2016-02-17T07:46:34Z<p>Aisteb: </p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=M4_API_quickstats_get&diff=20619M4 API quickstats get2016-02-11T17:26:21Z<p>Aisteb: /* Description */</p>
<hr />
<div>=Description=<br />
<br />
Retrieves today's [[Quick Stats]] and [[Active Calls]] count<br><br><br />
<br />
Data can be retrieved by '''Admin''' only<br />
<br />
<br><br />
<br />
=Usage=<br />
<br />
* '''M2''' call: '''/api/quickstats_get'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters=== <br />
<br />
* [[MOR API hash construction | hash]] - SHA1 hash constructed using API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked). <br />
* u - username for authentication. '''Required'''. <br />
<br><br><br />
===Request===<br />
<br />
If API Secret Key = secret<br />
<br />
You send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/quickstats_get?u=admin&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4<br />
<br />
'''* Note that username (u) is not included in hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success:''' Everything is ok. You get the list of calls if there is any:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<quickstats><br />
<today><br />
<calls> Calls count </calls><br />
<duration> billsec in seconds </duration><br />
<revenue> revenue today</revenue><br />
<self_cost> expenditure today</self_cost><br />
<profit> difference of revenue and expences</profit><br />
</today><br />
<active_calls><br />
<total> Active Calls count </total><br />
<answered_calls> Answered Calls count </answered_calls><br />
</active_calls><br />
</quickstats><br />
</page><br />
<br />
'''Errors:'''<br />
<br />
* <error>API Requests are disabled</error> – '''Allow API globally''' setting is unchecked<br />
* <error>GET Requests are disabled</error> – '''Allow GET API''' setting is unchecked<br />
* <error>Access Denied</error> – user with such username cannot use this method<br />
* <error>Bad login</error> – such username does not exist in the database or it was not specified<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string<br />
* <error>Cannot connect to Elasticsearch</error> – data is not reachable<br />
<br />
Example:<br />
<br />
<status><br />
<error>API Requests are disabled</error><br />
</status><br />
<br><br><br />
=See also=<br />
<br />
* [[M2 API]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=M4_API_quickstats_get&diff=20618M4 API quickstats get2016-02-11T17:25:11Z<p>Aisteb: Created page with '=Description= Retrieves today's Quick Stats and Active Calls count<br><br> Data can be retrieved just by '''Admin''' <br> =Usage= * '''M2''' call: '''/api/quickstats_…'</p>
<hr />
<div>=Description=<br />
<br />
Retrieves today's [[Quick Stats]] and [[Active Calls]] count<br><br><br />
<br />
Data can be retrieved just by '''Admin'''<br />
<br />
<br><br />
=Usage=<br />
<br />
* '''M2''' call: '''/api/quickstats_get'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters=== <br />
<br />
* [[MOR API hash construction | hash]] - SHA1 hash constructed using API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked). <br />
* u - username for authentication. '''Required'''. <br />
<br><br><br />
===Request===<br />
<br />
If API Secret Key = secret<br />
<br />
You send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/quickstats_get?u=admin&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4<br />
<br />
'''* Note that username (u) is not included in hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success:''' Everything is ok. You get the list of calls if there is any:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<quickstats><br />
<today><br />
<calls> Calls count </calls><br />
<duration> billsec in seconds </duration><br />
<revenue> revenue today</revenue><br />
<self_cost> expenditure today</self_cost><br />
<profit> difference of revenue and expences</profit><br />
</today><br />
<active_calls><br />
<total> Active Calls count </total><br />
<answered_calls> Answered Calls count </answered_calls><br />
</active_calls><br />
</quickstats><br />
</page><br />
<br />
'''Errors:'''<br />
<br />
* <error>API Requests are disabled</error> – '''Allow API globally''' setting is unchecked<br />
* <error>GET Requests are disabled</error> – '''Allow GET API''' setting is unchecked<br />
* <error>Access Denied</error> – user with such username cannot use this method<br />
* <error>Bad login</error> – such username does not exist in the database or it was not specified<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string<br />
* <error>Cannot connect to Elasticsearch</error> – data is not reachable<br />
<br />
Example:<br />
<br />
<status><br />
<error>API Requests are disabled</error><br />
</status><br />
<br><br><br />
=See also=<br />
<br />
* [[M2 API]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=M4_API&diff=20617M4 API2016-02-11T17:06:23Z<p>Aisteb: </p>
<hr />
<div>[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Manager - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[M2 API Configuration]] – configuration options for API.<br />
* [[M2 API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[M2 API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[M2 API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[M2 Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
<br />
<br><br />
==Calls==<br />
* [[M2 user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
==Device==<br />
* [[M2 API devices get | devices_get]] (device_list) – users device list<br />
<br />
<br><br />
==Login==<br />
* [[M2 API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[M2 API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Rates==<br />
* [[M2 API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[M2 API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Statistics==<br />
* [[M2 API quickstats_get | quickstats_get]] – gets today's [[Quick Stats]] and [[Active Calls]] count<br />
<br />
<br><br />
==User==<br />
* [[M2 API user_details_get | user_details_get]] (user_details) – gets user details.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[M2 API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=User_Details&diff=20599User Details2016-02-04T15:46:27Z<p>Aisteb: /* General */</p>
<hr />
<div>=Where to find user details?=<br />
<br />
Go to '''SETTINGS –> Users'''<br />
<br><br> <br />
[[File:Users_path.png]] <br />
<br><br> <br />
Here you can see list of all users. In brackets by the Accountant or Reseller you are able to see to which Permissions Group([[Reseller Permissions]] or [[Accountant permissions]]) they belong. <br />
<br><br> <br />
[[File:Users_path_2.png]] <!---From MOR X4 some of cells are empty because reseller/accountant does not make calls anymore---><br />
<br><br> <br />
Select the [[image:icon_edit.png]] icon in window above and you will reach personal user settings page. In this window you will see a lot of options grouped into sections like General, Blocking, Warning Balance Email, Invoices, Payments, Details, Taxes, Registration Address, Recordings and Blacklists.<br />
<br />
<!---This functionality is available from MOR X4---><br />
'''NOTE''' that admin is not shown in Users list. To see your own details go to '''PERSONAL MENU –> Details'''.<br />
<br><br><br />
<br />
= Details update = <br />
Every User can update his own details in '''PERSONAL MENU –> Details'''.<br><br><br />
To disallow users to change their details Admin/Reseller has to check setting "Do not allow users to change their Personal Details" in '''SETTINGS -> Setup -> Settings -> Various'''. After this User Details can only be updated by user's owner.<br><br><br />
'''NOTE''' that even if User is not allowed to update his own details, he still can see it in '''PERSONAL MENU –> Details''' as form with not editable options.<br><br><br />
<br />
= General =<br />
<br />
* Username – username for user to login to MOR GUI.<br />
* Password – password for user to login to MOR GUI. Password must contain at least one numeric value, capital and lowercase symbol.<br />
* [[Users#User_types | User type]] – by default it is "user".<br />
* [[LCR]] – LCR indicating which of the user's devices will be used to dial out.<br />
* [[Tariffs | Tariff]] – prices for the user. <br />
* [[Balance and Credit | Balance]] – the user's balance.<br />
* Daily credit limit – Total credit available for user per day. If User reaches this limit all User's calls will be dropped with hangupcause '211 Low balance for user'. This limit is reset each day at midnight (00:00:00).<br />
* [[Balance and Credit | Credit]] – the user's credit, showing how low the user's balance can go.<br />
* [[Minimum contract billing | Minimal Charge for Calls]] - minimum charge user pays for voice calls.<br />
* [[Minimum contract billing | Minimal Charge for Calls Date]] - date since when the previous option is valid.<br />
* Postpaid/Prepaid – type of user.<br />
* [[Hide Users | Not Hidden/Hidden]] – is this user hidden?<br />
* Primary device – the primary device for this user.<br />
* [[Allow loss calls]] – should loss calls be allowed for this user?<br />
* [[Simultaneous call limitation | Call Limit]] – how many simultaneous calls the user can make?<br />
* Default [[Currencies | Currency]] – currency which will be used to show balance, rates and prices in Users' GUI and exported files. Notice that balance (also other values) will be saved in [[Currencies |default system currency]] in DB and converted on the fly using current exchange rate - e.g. balance can change when [[Currencies#Automatic_Currency_Update |exchange rate changes]]. So your user can be surprised when he does not make calls but balance fluctuates.<br />
* [[GUI_time_zone | Time Zone]] – time zone which will be used to show dates and time in Users' GUI and exported files<br />
* Responsible accountant – dropdown to choose accountant responsible for user's profit. <br />
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. <!-- veikia su x5_functionality_15 --> <br />
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] <!---from x5---><br />
<br><br><br />
<br />
= Blocking =<br />
<br />
Various options for [[User Blocking]].<br />
<br><br><br />
= Warning Balance Email =<br />
<br />
If you want to send an email notification to a user (or take another action) when his balance drops lower than a certain amount, check this setting and enter the desired amount.<br />
<br />
More details: [[Warning balance]]<br />
<br><br><br />
= Invoices =<br />
<br><br><br />
[[Image:user_invoice_details.png]]<br />
<br><br><br />
* Generate Invoice – should we generate an invoice for this user when we choose to generate invoices for a period?<br />
* Invoice, Detailed, By CallerID, By Destinations and PDF/CSV show various types of invoices which should be showed in Users ''PERSONAL MENU –> Details –> Invoices'' and/or sent to the User as an email attachment.<br />
* Show zero Calls – if the call price = 0, should such calls appear in the invoice or not?<br />
<br><br><br />
= Payments =<br />
<br />
* Cyberplat - check this option if you want to allow the user to use this payment gateway.<br />
<br />
<br><br><br />
= Details =<br />
<br />
Self-explanatory.<br />
<br />
If Country of Taxation is in the EU, validation of TAX Registration Number will be checked from this website: http://ec.europa.eu/taxation_customs/vies/<br />
<br><br><br />
= Taxes =<br />
<br />
Here tax parameters are entered for the user.<br />
<br />
The tax system is explained [[Multi-Tax system | here]].<br />
<br><br><br />
= Registration Address =<br />
<br />
Self-explanatory.<br />
<br><br><br />
= Recordings = <br />
<br />
This section is available when the [[Recordings Addon]] is installed in the system.<br />
<br><br><br />
=Blacklists / Whitelists=<br />
<br><br><br />
[[Image:user_blacklists_details.png]]<br />
<br><br><br />
<!---FROM MOR X7---><br />
'''Enable static Source''' - enables static Blacklist or Whitelist<br><br />
* '''No''' - do not use any Blacklist or Whitelist<br />
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from receiving and sending specific Source numbers. If User receives or sends number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''262 - Source number is in blacklist''<br />
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to receive only specific Source numbers. If User receives number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''263 - Source number is not in whitelist''<br />
<br />
<!---FROM MOR X5---><br />
'''Enable static Destination''' - enables static Blacklist or Whitelist<br><br />
* '''No''' - do not use any Blacklist or Whitelist<br />
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from calling specific Destination numbers. If User calls number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''255 - Destination is in blacklist''<br />
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to call only specific Destination numbers. If User calls number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''256 - Destination is not in whitelist''<br />
<br><br><br />
Also you can manage '''[[Dynamic Blacklist Functionality]]''' settings for Single User. You are able to manage:<br />
<br />
'''Enable Dynamic Blacklist''' – enables dynamic Blacklist functionality for this user.<br><br />
'''Blacklist LCR''' – [[LCR]] with Blacklist Providers.<br><br />
'''Routing Threshold''' – sum of SRC, DST and RTP IP limit. If SRC, DST or RTP IP scores sum received during the call is bigger than Defaullt Threshold, call will be routed through selected Blacklist LCR. <br><br />
<br />
Choose option '''Global''' if you want to apply [[ Monitorings_Addon#Monitorings_Settings | global settingas]] for this user.<br />
<br><br><br />
<br />
= Comment = <br />
<br />
Here you are able to write private comment about user.</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:Provider-stats.png&diff=20594File:Provider-stats.png2016-02-03T16:25:37Z<p>Aisteb: uploaded a new version of "File:Provider-stats.png"</p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:Provider-stats.png&diff=20593File:Provider-stats.png2016-02-03T16:21:00Z<p>Aisteb: uploaded a new version of "File:Provider-stats.png"</p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Invoices&diff=20585Invoices2016-02-01T15:29:51Z<p>Aisteb: </p>
<hr />
<div>= Description =<br />
<br />
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.<br />
<br><br><br />
= Configuration =<br />
<br />
You can manage Invoices settings, details, Address information and functionality in the Invoices section of the [[Configuration_from_GUI#Invoices | SETTINGS -> Setup -> Settings]] window.<br><br />
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''<br />
<br><br><br />
<br />
Go to User's edit page to enable or disable types of invoices he can see in his invoices details. And also these selected types will be the ones that are sent to user via email. <br />
<br />
[[File:Invoices_types.png]]<br />
<br />
=Invoices list=<br />
<br />
Invoices can be viewed, generated, recalculated, sent, also <!---...from MOR 9---> 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:<br />
<br><br><br />
[[Image:invoices_list_x6.png]]<br />
<br><br><br />
The icons [[Image:icon_check.png]] and [[Image:icon_cross.png]] show whether this invoice is Paid or Unpaid, Sent or Not Sent. <br />
<br><br />
'''NOTE''' Each Invoice generated in particular Time Zone and on particular Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.<br />
<br><br />
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.<br />
<br><br><br />
'''Example'''<br />
<br><br><br />
Default system Currency is USD<br />
<br><br />
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5<br><br />
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25<br><br />
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75<br><br />
<br><br />
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. <br><br />
<br><br />
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for Invoice A exchange rate will be from that day when Invoice was generated (0.5).<br><br />
<br />
Same calculations with other currencies:<br><br />
If you want to see Total price in USD. For Invoice A, B and C the exchange rates will be set from the day when invoice was generated (EUR - 0.5, DZD - 0.25 and ALL - 0.75).<br><br />
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for Invoice B exchange rate will be from the day when Invoice was generated (0.25).<br><br />
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for Invoice C exchange rate will be from the day when Invoice was generated (0.75).<br><br />
<br><br />
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL<br><br />
<br><br><br />
<br />
=Invoice details=<br />
<br />
Click on the [[Image:icon_details.png]] icon to get details of the Invoice:<br />
<br><br><br />
[[Image:invoice_details_x6.png]]<br />
<br><br><br />
Invoice details are shown in Currency which was used to generate Invoice. <br />
<br><br><br />
==General Details==<br />
<br />
'''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.<br><br />
'''Currecy of Invoice''' - <!---This functionality is available from MOR X6---> Invoices are exported in Invoice currency.<br />
<br />
'''Language of Invoice'''<br />
<br><br />
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).<br />
<br><br><br />
<br />
==User Details==<br />
<br />
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]].<br />
<br><br><br />
==Files to send or download==<br />
<br />
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.<br />
<br />
*'''Invoice XLSX''' xlsx file shows information which are set by you. Check [[Invoices#XLSX_Invoices | XLSX Invoice]]<br />
*'''Invoice''' PDF shows separate services Prices and Total Invoice Prices, CSV shows just Total Invoice Prices.<br />
*'''Invoice detailed''' shows same information like simple Invoice and includes Calls list grouped by Destination.<br />
*'''Invoice by CallerID''' shows Calls list grouped by CallerID.<br />
*'''Invoice Destinations''' shows Calls list grouped by Destination. <br />
<br />
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.<br />
<br><br><br />
=== XLSX Invoices ===<br />
<br />
XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.<br />
Example of template can be downloaded for [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx here].<br />
<br><br><br />
'''Default XLSX template'''<br />
<br />
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'''<br />
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.<br />
* Check '''Group regular Calls by Destinations''' if you want XLSX file us as detailed Invoice.<br />
<br><br />
'''Balance Line settings'''<br />
<br />
''Outstanding balance (Debt)'', ''Outstanding balance (Debt) with TAX'', ''Total amount due'' options are present when ''Show balance line'' ('''SETTINGS -> Setup -> Settings''', Invoices - Postpaid - Settings) setting is enabled.<br />
<br><br><br />
'''Configuration for Dynamic information'''<br />
<br />
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. <br />
<br />
For example "A2", "B15", "AA9"<br />
<br><br><br />
[[File:callc.png]]<br />
<br><br><br />
<br />
'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.<br />
<br />
=== PDF invoices ===<br />
<br />
The layout of PDF invoices is not customizable. <br />
<br />
Logos are not supported in PDF invoices.<br />
<br />
You can print your invoices on paper with a pre-printed logo if you want to send paper invoices.<br />
<br><br><br />
=== CSV invoices ===<br />
<br />
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.<br />
<br><br><br />
<br />
==Comment==<br />
<br><br />
<!---This functionality is available from MOR 9---><br />
Sometimes it is useful to add a comment to the invoice. It can be used in xlsx file also.<br />
<br><br><br />
==Invoice Details==<br />
Click on the Invoice Details icon in the Invoice details page <br />
<br><br><br />
[[Image:Service_details.png]]<br />
<br><br><br />
to get Services Details of the Invoice: <br />
<br><br><br />
[[Image:invoice_services_x6.png]]<br />
<br><br><br />
'''Services:'''<br />
<br><br />
* '''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<br />
* '''DID Owner Cost''' – price for having and using own DID(s)<br />
* '''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<br />
* '''Calls''' – quantity and price of outgoing calls<br />
* '''Calls from Users''' – quantity and price of resellers users calls<br />
* '''Calls to DIDs''' – price for calling to DID(s)<br />
<br><br><br />
<br />
= Invoice generation =<br />
<br />
In the main Invoices window, click [[Image:icon_generate_invoices.png]] '''Generate Invoices''' to generate additional invoices:<br />
<br><br><br />
[[Image:generate_invoices_x6.png]]<br />
<br><br><br />
Select for which users to generate invoices. Prepaid and Postpaid users can have separate details. Also, you can check to generate an invoice for only one particular user. Invoice will be generated if selected User existed at least one day of all Invoice period. When Invoice Generation Task is created, admin can check the progress in [[Background Tasks]]. <br />
<br />
'''NOTE:''' For Prepaid User after every executed Manual Payment will be generated Invoice automatically.<br><br />
<!---This functionality is available from MOR X5---><br />
'''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. <br><br />
'''NOTE:''' When generating invoice, current user details will be used. <br> <br />
<br><br><br />
<br />
= Invoice recalculation =<br />
<br />
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'':<br />
<br><br><br />
[[Image:ivoicesnewnew.png]]<br />
<br><br><br />
===Recalculate a group of Invoices===<br />
<br />
To recalculate invoices in the main Invoices window click [[Image:icon_generate_invoices.png]] '''Recalculate invoices''':<br />
<br><br><br />
[[Image:recalc.png]]<br />
<br><br><br />
Select which type of Invoices or whose Invoices to recalculate.<br />
<br><br><br />
=== Recalculate a single Invoice ===<br />
<br />
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:<br />
<br><br><br />
[[File:Recalculate_single_invoice_x6.png]]<br />
<br><br><br />
= Pay unpaid Invoices =<br />
<br />
In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Pay unpaid Invoices''' will appear.<br />
<br><br><br />
[[File:pay_unpaid_invoices.png]]<br />
<br><br><br />
Click '''Pay unpaid Invoices''' and '''All''' unpaid Invoices will be marked as paid. For each marked Invoice Payment will be created.<br />
<br><br><br />
<br />
= Send invoices by email (manual) =<br />
<br />
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:<br />
<br><br><br />
[[Image:invoices_send_x6.png]]<br />
<br><br><br />
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.<br />
<br><br />
* '''Email sending''' option must be enabled in Email Settings to use this feature<br />
* 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.<br />
<br />
<br />
<br><br><br />
= Generate and send invoices by email (automatically) =<br />
<br />
Use [http://wiki.kolmisoft.com/index.php/Cron_actions#Generate_Invoices_and_send_by_Email Cron Actions] to Generate and send Emails automatically.<br />
<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[Accounting]]<br />
* [[Invoice configuration]]<br />
* [[Pay Invoice with balance deduction]]<br />
* [[Outstanding balance(Debt)]]<br />
* [[Invoice by CallerID]]<br />
* [[MOR API invoices_get]]<br />
* [[Cannot generate Invoice]]<br />
* [[Duplicate value in Cell Address field]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Emails&diff=20584Emails2016-02-01T15:29:20Z<p>Aisteb: /* Where I can find Emails? */</p>
<hr />
<div>=What are Emails?=<br />
<br />
This function is used to send emails to your clients. It can be used to send commercials, notes about service unavailability or anything else – maybe Christmas greetings!<br />
<br><br><br />
<br />
=Where I can find Emails?=<br />
<br />
This function can be found in '''SETTINGS –> Setup –> Emails''':<br />
<br><br><br />
[[File:emails_path.png]]<br />
<br><br><br />
Here you see emails which are templates for emails about various system messages. The 'test' email is created for demo purposes for mass-mailing.<br />
<br><br><br />
* '''registration_confirmation_for_user''' - User will get after he registers new account via [[Online registration]].<br />
* '''registration_confirmation_for_admin''' - Admin will get after new User is registered.<br />
* '''cyberplat_announce''' - will be sent after [[CyberPlat Payment Gateway | CuberPlat payment]] will be made.<br />
* '''invoices''' - customer will get his [[Invoices|Invoice]] files when they are will be sent [[Invoices#Send_invoices_by_email_.28manual.29|manually]].<br />
* '''calling_cards_data_to_paypal''' - will be sent after [[MOR API card from group sell | card_from_group_sell API method]] usege if email address will be given.<br />
* '''warning_balance_email''' - User will get when balance becomes lower than [[Warning balance]].<br />
* '''recording_new''' - will be sent after new recording is created.<br />
* '''recording_delete''' - will be sent after recording is deleted.<br />
* '''block_when_no_balance''' - will be sent after account is blocked due insufficient balance.<br />
* '''payment_notification_integrations''' - will be sent after MOR has received a payment notification from [[PayPal| PayPal Standard]] which requires a confirmation in order to complete the transaction.<br />
* '''payment_notification_regular''' - will be sent after MOR has received a payment notification from [[Payment_Gateway_Addon |Payment Gateway]] which requires a confirmation in order to complete the transaction.<br />
* '''password_reminder''' - will be sent after MOR has received a [[MOR forgot user password|User password reminder]] request.<br />
* '''warning_balance_email_local''' - Admin or/and Accountant gets warning when Users' balance becomes lower than [[Warning balance]].<br />
* '''server_low_free_space''' - will be sent when free space is to low in some of Servers.<br />
* '''device_changes_announcement''' - will be sent after each modification of Device if "Inform when Devices are created or updated" is checked in [[Configuration_from_GUI#Various|Various]] settings tab.<br />
<br><br><br />
Next is how to [[Image:icon_edit.png]] edit email. Creating email and editing it are very similar processes. Here is how to edit:<br />
<br><br><br />
[[Image:email2.png]]<br />
<br><br><br />
The '''Name''' and '''Subject''' fields are simple. The most important field is '''Message text'''. Here you enter message for the user. Also, you can use the following [[Email_variables|variables]] here:<br />
<br />
<%= server_ip %> - Server IP where your users should register their SIP/IAX2 devices.<br />
<%= device_type %> - Used on user registration - shows the device type the user has selected.<br />
<%= device_username %> - Used on user registration - shows the device's username.<br />
<%= device_password %> - Used on user registration - shows device's password.<br />
<%= login_url %> - GUI login url.<br />
<%= login_username %> - User's username to login to GUI.<br />
<%= login_password %> - User's password to login to GUI.<br />
<%= username %> - same as login_username.<br />
<%= first_name %> - First name of the user.<br />
<%= last_name %> - Last name of the user.<br />
<%= full_name %> - First name and last name of the user.<br />
<br />
Click on '''Change''' to save any of these variables.<br />
<br />
'''Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]'''<br />
<br />
<br />
<br />
In the main window ('''SETTINGS –> Setup –> Emails'''), you can press on [[Image:icon_email.png]] icon to select to which recipients to send this email:<br />
<br />
[[Image:email3.png]]<br />
<br />
=Additional Notes=<br />
* [[Configuration_from_GUI#Emails|Emails sending]] must be enabled to use this functionality<br />
* Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Emails&diff=20583Emails2016-02-01T15:29:08Z<p>Aisteb: /* Where I can find Emails? */</p>
<hr />
<div>=What are Emails?=<br />
<br />
This function is used to send emails to your clients. It can be used to send commercials, notes about service unavailability or anything else – maybe Christmas greetings!<br />
<br><br><br />
<br />
=Where I can find Emails?=<br />
<br />
This function can be found in '''SETTINGS –> Setup –> Emails''':<br />
<br><br><br />
[[File:emails_path.png]]<br />
<br><br><br />
Here you see emails which are templates for emails about various system messages. The 'test' email is created for demo purposes for mass-mailing.<br />
<br><br><br />
* '''registration_confirmation_for_user''' - User will get after he registers new account via [[Online registration]].<br />
* '''registration_confirmation_for_admin''' - Admin will get after new User is registered.<br />
* '''cyberplat_announce''' - will be sent after [[CyberPlat Payment Gateway | CuberPlat payment]] will be made.<br />
* '''invoices''' - customer will get his [[Invoices|Invoice]] files when they are will be sent .[[Invoices#Send_invoices_by_email_.28manual.29|manually]].<br />
* '''calling_cards_data_to_paypal''' - will be sent after [[MOR API card from group sell | card_from_group_sell API method]] usege if email address will be given.<br />
* '''warning_balance_email''' - User will get when balance becomes lower than [[Warning balance]].<br />
* '''recording_new''' - will be sent after new recording is created.<br />
* '''recording_delete''' - will be sent after recording is deleted.<br />
* '''block_when_no_balance''' - will be sent after account is blocked due insufficient balance.<br />
* '''payment_notification_integrations''' - will be sent after MOR has received a payment notification from [[PayPal| PayPal Standard]] which requires a confirmation in order to complete the transaction.<br />
* '''payment_notification_regular''' - will be sent after MOR has received a payment notification from [[Payment_Gateway_Addon |Payment Gateway]] which requires a confirmation in order to complete the transaction.<br />
* '''password_reminder''' - will be sent after MOR has received a [[MOR forgot user password|User password reminder]] request.<br />
* '''warning_balance_email_local''' - Admin or/and Accountant gets warning when Users' balance becomes lower than [[Warning balance]].<br />
* '''server_low_free_space''' - will be sent when free space is to low in some of Servers.<br />
* '''device_changes_announcement''' - will be sent after each modification of Device if "Inform when Devices are created or updated" is checked in [[Configuration_from_GUI#Various|Various]] settings tab.<br />
<br><br><br />
Next is how to [[Image:icon_edit.png]] edit email. Creating email and editing it are very similar processes. Here is how to edit:<br />
<br><br><br />
[[Image:email2.png]]<br />
<br><br><br />
The '''Name''' and '''Subject''' fields are simple. The most important field is '''Message text'''. Here you enter message for the user. Also, you can use the following [[Email_variables|variables]] here:<br />
<br />
<%= server_ip %> - Server IP where your users should register their SIP/IAX2 devices.<br />
<%= device_type %> - Used on user registration - shows the device type the user has selected.<br />
<%= device_username %> - Used on user registration - shows the device's username.<br />
<%= device_password %> - Used on user registration - shows device's password.<br />
<%= login_url %> - GUI login url.<br />
<%= login_username %> - User's username to login to GUI.<br />
<%= login_password %> - User's password to login to GUI.<br />
<%= username %> - same as login_username.<br />
<%= first_name %> - First name of the user.<br />
<%= last_name %> - Last name of the user.<br />
<%= full_name %> - First name and last name of the user.<br />
<br />
Click on '''Change''' to save any of these variables.<br />
<br />
'''Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]'''<br />
<br />
<br />
<br />
In the main window ('''SETTINGS –> Setup –> Emails'''), you can press on [[Image:icon_email.png]] icon to select to which recipients to send this email:<br />
<br />
[[Image:email3.png]]<br />
<br />
=Additional Notes=<br />
* [[Configuration_from_GUI#Emails|Emails sending]] must be enabled to use this functionality<br />
* Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Configuration_from_GUI&diff=20582Configuration from GUI2016-02-01T15:28:29Z<p>Aisteb: /* See also */</p>
<hr />
<div>=Where I can find this settings menu?=<br />
<br />
You can find this menu in '''SETTINGS –> Setup –> Settings'''<br />
<br />
[[File:Settings_path.png]]<br />
<br><br><br />
== Global ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> [[Global_Settings | Global]]'''<br />
<br />
* '''Company''' – name of the company.<br />
* '''Company email''' – email address of the company.<br />
* '''Version''' – version number.<br />
* '''Copyright Title''' – copyright title supports html text format.<br />
* '''Browser Title''' – browser title for MOR GUI.<br />
* '''Front Page Text''' – some text to place on front page.<br />
* '''Login Page Text''' – some text to place on login page<br />
<br><br><br />
<br />
== Registration == <br />
<br />
'''SETTINGS –> Setup –> Settings –> Registration'''<br />
<br />
* '''Enabled?''' – do we want to let users [[Online registration | register online]] automatically?<br />
* '''Hide registration link in Login page?''' – tick this option if you do not want users to be able to register online.<br />
* '''Default country'''<br />
* '''Asterisk server IP''' – what IP should user connect his softphone/server to?<br />
* '''Send email to user after registration''' – just yes or no.<br />
* '''Send email to admin after registration''' – just yes or no.<br />
* '''[[ReCAPTCHA]] configuration'''<br />
* '''[[User_Agreement|Terms and conditions]]'''<br />
* '''Allow to create user and device with matching username and password''' – just yes or no. If this setting is not enabled - username and password from MOR GUI will have to be different than device's username and password.<br />
* '''Enable VAT checking for EU companies''' – you can choose whether to check '''TAX Registration Number:''' during the [[Online registration]] or not. Done over [http://ec.europa.eu/taxation_customs/vies/?locale=lt EU page].<br />
* '''Allow blank VAT for EU companies''' – allows to leave blank '''TAX Registration Number:''' field during the [[Online registration]]<br />
<br><br><br />
===See also===<br />
<br />
* [[Default user]]<br />
<br><br><br />
<br />
== Invoices ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Invoices'''<br />
<br />
Invoice configuration is divided into '''Prepaid''' and '''Postpaid'''. <br />
<br><br><br />
=== Settings ===<br />
<br />
* '''Number start''' – how the invoice number should start.<br />
* '''Number length''' – the length in digits AFTER Number Start – e.g. Number Start is not counted into this length. This value is active only for first number type.<br />
* '''Number type''' – select more appropriate number format.<br />
* '''Invoice period start''' – when invoices are issued, default is first day of the month.<br />
* '''Show calls in detailed invoice''' – yes or no.<br />
* '''[[Outstanding balance(Debt) | Show balance line]]''' – shows balance line in Invoice PDF files when Invoice is generated from first day of month till last one. <br />
* '''Round finals to 2 decimals''' – round or not total in Invoices to 2 decimals.<br />
* '''Use short file name'''<br />
* '''Invoice Page Limit:''' – invoice will be generated till this page limit. Additional page is added with an explanation that page limit was reached. <br />
<br><br><br />
<br />
=== Details ===<br />
<br />
* '''Address format''' – changes field positioning in the invoice for the address. You must select it in order to show address in the invoice. <br />
* '''Address line 1-4''' – address info.<br />
* '''Bank details line 1-5''' – bank details info.<br />
* '''Invoice balance line''' – line for balance (e.g. "Your current balance is")<br />
* '''Invoice to pay Line'''<br />
* '''End title''' – a title for the end of your invoice.<br />
<!---This functionality is available from MOR 12---><br />
* '''Add Average rate in detailed invoice''' – adds average rate in detailed invoice.<br />
* '''Show Time in Minute''' – shows time in mm:ss instead of hh:mm:ss, for example, not 02:13:42 but 133:42.<br />
<br><br><br />
<br />
=== Additional ===<br />
<br />
* '''Show additional details on separate page''' – enables additional custom page at the end of the invoice.<br />
* '''Additional details''' – the information to be displayed in a custom page at the end of the invoice.<br />
<br><br><br />
=== Functionality ===<br />
<br />
* '''Invoice allow recalculate after send''' – allows recalculating invoices after being sent.<br />
<br><br><br />
===See also===<br />
<br />
* [[Invoices]]<br />
* [[Invoice configuration]]<br />
<br><br><br />
<br />
== Emails ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Emails'''<br />
<br />
* ''' Sending globally enabled''' – if this is checked, you will be able to use Mass Mailing and the system will send emails upon user registration.<br />
* '''SMTP server''' – hostname of the server.<br />
* '''Port''' – port of SMTP server.<br />
* '''Login''' – username to your SMTP server.<br />
* '''Password''' – password to your SMTP server.<br />
* '''Batch size''' – value for Mass Mailing, or how many emails to send at once.<br />
* '''From''' – email address to put into From: field in email. It is required to fill in(correctly) this field if email sending is enabled.<br />
* '''Test email sending''' – save settings and press this to test email sending. Do not forget to save settings first!<br />
<br />
'''P.S. Remember to set admin's e-mail in admin's personal settings. Without this test email sending will not work!'''<br />
<br />
<br><br><br />
===See also===<br />
<br />
* [[Emails|Mass Emails]]<br />
* [[Email variables]]<br />
<br><br><br />
== Various ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Various'''<br />
<br />
* '''Days for DID to close''' – how long to keep DID closed before making it free.<br />
* '''Agreement number length''' – number length in digits.<br />
* '''Change dahdi''' – Sometimes this is used to change "Zap" to something else in GUI, e.g. to "PSTN", mainly because not everybody knows what Zap stands for. PSTN is more common.<br />
* '''Device PIN length''' – length for automatically generated PIN codes for devices.<br />
* '''Device range MIN''' – from which extension automatic extension assigning starts.<br />
* '''Device range MAX''' – till which extension automatic extension assigning goes.<br />
** For example, from this interval: [Device range MIN, Device range MAX] MOR will select extensions for newly created Devices.<br />
* '''Enable "Allowed addresses" option for Devices:''' – allows [[Device_settings#Allowed_Addresses | Allowed Addresses]] functionality in Devices settings.<br />
* '''Enable "Allowed addresses" option for Providers:''' – allows Allowed Addresses functionality in Providers settings.<br />
* '''User wholesale tariff enabled''' – enables user wholesale tariffs.<br />
* '''Play IVR for unauthenticated call'''<br />
* '''Banned CLIs default IVR''' – default IVR to route banned numbers.<br />
* '''Do not allow duplicate device user names'''<br />
* '''Do not allow users to change their email addresses'''<br />
* '''Allow short passwords in devices'''<br />
* '''Logout link''' – a user will be redirected to this link after pressing "Logout"<br />
* '''Change ANSWER to FAILED if HGC not equal to 16 for Users''' – changes the Hangupcause for users in call reports from Answered to Failed if Hangupcause is not 16.<br />
* '''Inform when Devices are created or updated''' – check to get email about every newly created or updated Device. <br />
* '''Show Usernames on PDF/CSV Export Files in Last Calls''' – if checked, when particular User in Last Calls page search is selected, Last Calls PDF/CSV file name will be composed also from Name of selected User. If you are looking for All Users, no User Name will be used. (Name of User will be shown in Name of CSV/PDF file).<br />
* '''Do not allow PREPAID User balance drop below zero (block them instead)'''<br />
<!---from X5---><br />
* '''Do not block POSTPAID User when balance goes bellow zero on subscription count'''<br />
* '''Allow identical email addresses to different Users''' – allows to create Users or Register users with identical email addresses. After checking this setting you will be not able to check '''Show forgot password''', because this functionality require unique email in all system. Setting can be unchecked if all emails are unique in system. <br />
* '''Allow same IP and Port combinations in multiple Devices''' – allows to create Devices with the same IP and Port combination.<br />
* '''Server free space limit''' – indicator when system should inform admin about low [[Multi_Server_support|server]] space. By default 20%. Notice will appear in [[Integrity Check]] and every hour will be send an email "Server low free space" template which can be found and edited in [[Emails]] page. Default email template for low disk space: "Some of your Servers exceeded free space limit, please investigate."<br />
<br><br><br />
<br />
== Tax ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Tax'''<br />
<br />
Settings are explained here: [[Multi-Tax system]]<br />
<br><br><br />
== Backups ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Backups'''<br />
<br />
Configuration is explained here: [[Backup system]]<br />
<br><br><br />
== API ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> API'''<br />
<br />
* '''Allow API''' – enable/disable API.<br />
* '''Allow GET API''' – enable/disable GET in API - use only for testing!<br />
* '''API Secret Key''' – secret key for API. This will be used as a password for signing queries to MOR API, check [[MOR_API | MOR API documentation]] for more information<br />
* '''XML API Extension''' – .NET does not follow standards (surprise!); enable this setting if you are using it to get XML starting with HTTP tags.<br />
* '''Allow API Login Redirect''' – enable/disable<br />
* '''API allow registration''' – enable/disable registration through API<br />
* '''API allow Payments''' – enable/disable payments through API<br />
* '''API Payment confirmation''' – enable/disable payments confirmation through API<br />
* '''[[Balance_in_phone|Allow devices to check balance over HTTP]]''' – enable/disable device balance checking<br />
* '''[[MOR_API_rate_get|Allow devices to check rate over HTTP]]''' – enable/disable device rate checking<br />
* '''Disable hash checking''' – lets you skip hash parameter using API<br />
* '''Uniquehash''' – shows your uniquehash <br />
<br><br><br />
===See also===<br />
<br />
[[MOR API]]<br />
<br><br><br />
<br />
== Functionality ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Functionality'''<br />
<br><br><br />
===FAX===<br />
<br />
* '''Fax device enabled''' – enable/disable Fax device in MOR. When admin enables FAX, Functionality tab appears in Reseller's GUI configuration. He can then enable or disabled fax for his own users himself. <br />
* '''Fax2Email From Sender''' – there is a field "From:" in an email form. When MOR sends Fax to Email, "Fax2Email From Sender" value is displayed in "From:" field.<br />
<br><br><br />
<br />
===CSV===<br />
<br />
* '''CSV Column Separator''' – how columns are separated in imported/exported CSV files.<br />
* '''CSV Decimal Separator''' – how decimal parts in numbers are separated in imported/exported CSV files.<br />
* ''' Archive CSV file when size reaches''' – if CSV file reaches a certain size, the system will archive it to save time to download it (0 means to archive always)<br />
<br><br><br />
===Active Calls===<br />
<br />
* '''How many maximum [[Active_Calls|Active Calls]] to show in GUI''' – how many [[Active_Calls| Active Calls]] to show in GUI<br />
* '''[[Active_Calls| Active Calls]] refresh interval''' – [[Active_Calls|Active Calls]] refresh interval in seconds<br />
* '''Show [[Active_Calls|Active Calls]] for Users''' – tick if you want to allow users to see [[Active_Calls|Active Calls]]<br />
* '''Show Servers in [[Active_Calls|Active Calls]]'''<br />
* '''Show DIDs in [[Active_Calls|Active Calls]]'''<br />
<br><br><br />
<br />
===Tariffs/Rates===<br />
<br />
* '''Show rates for users''' – allows users to see rates<br />
* '''Show rates without Tax''' – shows rates without TAX<br />
* '''Show [[Advanced_Rates|Advanced Rates]] for users''' – allows users to see [[Advanced_Rates|Advanced Rates]]<br />
* '''Show zero rates in LCR tariff export:''' – shows zero rates in LCR tariff exported file.<br />
NOTE: if [[Custom Rates]] and/or Tariff Rates are set for the user, only the custom rates will be shown in the details of destination rates. <br />
<br><br><br />
<br />
==Privacy==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Privacy'''<br />
<br />
Settings are explained here: [[Privacy_to_hide_Destination_ends|Privacy to hide Destination ends]]<br />
<br><br><br />
== Visual ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Visual'''<br />
<br />
* '''Items per page''' – the number of items to display per one page<br />
* '''[[Global_date_format| Default date format]]''' – System default date format<br />
* '''Default Time Format''' – System default time format<br />
* '''Number digits''' – how many digits to display after a comma<br />
* '''Hide Quick Stats in Start page''' – hide Quick stats from start page<br />
* '''Hide device passwords for users''' – do not display device passwords for users<br />
* '''Hide HELP banner''' – hide HELP banner in GUI<br />
* '''Hide "I want to" help links'''<br />
* '''[[Remove_Manual_link_from_admin_GUI|Hide "Manual" link]]''' – hides "Manual" link<br />
* '''Show logo on first page''' - untick to hide logo on the start page<br />
* '''Show Full Source (CallerID Name and Number)'''<br />
* '''Hide payment options for postpaid users''' - will hide the payment option for all postpaid users (including Resellers if they are postpaid).<br />
* '''Hide non-completed payments for user''' – hides non-completed payments (the ones which are started in MOR, but are not completed in a payment gateway website)<br />
* '''Show only main page''' – this is a very advanced feature for those who want to hide default MOR menu tree on the left so that they could build their own menu using advanced techniques without modifying MOR GUI sources.<br />
* '''Show forgot password''' – turns on '''[[MOR_forgot_user_password | Forgot password]]''' functionality.<br />
* '''Hide Recordings for all users''' – hides recordings for all system users from menu and device settings.<br />
* '''Show recordings with zero billsec''' – shows recordings with zero billsec<br />
* '''[[Last_Calls#Faster_Page_Loading|Count Last Calls total values only after click]]''' – select to load Total Values lines separately in order to dramatically improve Last calls and Old calls loading time. <br />
* '''Default Number Decimal''' – with this option you can set default number decimal for all GUI<br />
* '''Show user_billsec for Users instead of billsec''' – shows user_billsec instead of billsec in Users invoices and last calls. Notice that Billsec shows real Call duration, user_billsec shows Call duration after minimal time or increment applied. For example, if user tariff has 60 sec minimal time and user made a Call for 20 sec, then billsec will show 20 sec and user_billsec will show 60 sec (minimal time is applied).<br />
<!--- from X5---><br />
* '''Show Calls statistics to User for last''' – number of Calls statistics to show in days. For example, if you enter 5 days, users will only see 5 days old calls, they will not be able to check older calls. <br />
* '''Show Device and it's CallerID in Last Calls''' – shows additional column in [[Last Calls]] page with Device and its CallerID information. Click to reach that Device settings page. <br />
<br><br><br />
<br />
== Server load ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Server load'''<br />
<br><br><br />
Settings for GUI Server and Database Server<br />
<br />
* '''HDD utilisation higher than''' – Percentage of CPU time during which I/O requests were issued to the device (bandwidth utilization for the device).<br />
* '''CPU General Load higher than''' – CPU General load higher than – Percentage of the CPU for user processes.<br />
* '''CPU Load Stats 1 higher than''' – average load per one minute on the system<br />
* '''CPU MySQL process higher than''' – Percentage of the CPU for MySQL process<br />
* '''CPU Ruby process higher than''' – Percentage of the CPU for Ruby process<br />
* '''CPU Asterisk process (if present) higher than''' – Percentage of the CPU for Asterisk process<br />
<br><br />
* '''Delete Server Load Stats older than''' – deletes internal servers load statistics older than defined number of days.<br />
<br><br />
<br />
== Calls ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Calls'''<br />
<br><br><br />
[[Archived calls]]<br />
<br><br />
<br />
=See also=<br />
<br />
* [[Server is overloaded]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Emails&diff=20581Emails2016-02-01T15:28:12Z<p>Aisteb: </p>
<hr />
<div>=What are Emails?=<br />
<br />
This function is used to send emails to your clients. It can be used to send commercials, notes about service unavailability or anything else – maybe Christmas greetings!<br />
<br><br><br />
<br />
=Where I can find Emails?=<br />
<br />
This function can be found in '''SETTINGS –> Setup –> Emails''':<br />
<br><br><br />
[[File:emails_path.png]]<br />
<br><br><br />
Here you see emails which are templates for emails about various system messages. The 'test' email is created for demo purposes for mass-mailing.<br />
<br><br><br />
* '''registration_confirmation_for_user''' - User will get after he registers new account via [[Online registration]].<br />
* '''registration_confirmation_for_admin''' - Admin will get after new User is registered.<br />
* '''cyberplat_announce''' - will be sent after [[CyberPlat Payment Gateway | CuberPlat payment]] will be made.<br />
* '''invoices''' - customer will get his [[Invoices|Invoice]] files when they are will be sent .[[Invoices_(MOR_X6)#Send_invoices_by_email_.28manual.29|manually]].<br />
* '''calling_cards_data_to_paypal''' - will be sent after [[MOR API card from group sell | card_from_group_sell API method]] usege if email address will be given.<br />
* '''warning_balance_email''' - User will get when balance becomes lower than [[Warning balance]].<br />
* '''recording_new''' - will be sent after new recording is created.<br />
* '''recording_delete''' - will be sent after recording is deleted.<br />
* '''block_when_no_balance''' - will be sent after account is blocked due insufficient balance.<br />
* '''payment_notification_integrations''' - will be sent after MOR has received a payment notification from [[PayPal| PayPal Standard]] which requires a confirmation in order to complete the transaction.<br />
* '''payment_notification_regular''' - will be sent after MOR has received a payment notification from [[Payment_Gateway_Addon |Payment Gateway]] which requires a confirmation in order to complete the transaction.<br />
* '''password_reminder''' - will be sent after MOR has received a [[MOR forgot user password|User password reminder]] request.<br />
* '''warning_balance_email_local''' - Admin or/and Accountant gets warning when Users' balance becomes lower than [[Warning balance]].<br />
* '''server_low_free_space''' - will be sent when free space is to low in some of Servers.<br />
* '''device_changes_announcement''' - will be sent after each modification of Device if "Inform when Devices are created or updated" is checked in [[Configuration_from_GUI#Various|Various]] settings tab.<br />
<br><br><br />
Next is how to [[Image:icon_edit.png]] edit email. Creating email and editing it are very similar processes. Here is how to edit:<br />
<br><br><br />
[[Image:email2.png]]<br />
<br><br><br />
The '''Name''' and '''Subject''' fields are simple. The most important field is '''Message text'''. Here you enter message for the user. Also, you can use the following [[Email_variables|variables]] here:<br />
<br />
<%= server_ip %> - Server IP where your users should register their SIP/IAX2 devices.<br />
<%= device_type %> - Used on user registration - shows the device type the user has selected.<br />
<%= device_username %> - Used on user registration - shows the device's username.<br />
<%= device_password %> - Used on user registration - shows device's password.<br />
<%= login_url %> - GUI login url.<br />
<%= login_username %> - User's username to login to GUI.<br />
<%= login_password %> - User's password to login to GUI.<br />
<%= username %> - same as login_username.<br />
<%= first_name %> - First name of the user.<br />
<%= last_name %> - Last name of the user.<br />
<%= full_name %> - First name and last name of the user.<br />
<br />
Click on '''Change''' to save any of these variables.<br />
<br />
'''Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]'''<br />
<br />
<br />
<br />
In the main window ('''SETTINGS –> Setup –> Emails'''), you can press on [[Image:icon_email.png]] icon to select to which recipients to send this email:<br />
<br />
[[Image:email3.png]]<br />
<br />
=Additional Notes=<br />
* [[Configuration_from_GUI#Emails|Emails sending]] must be enabled to use this functionality<br />
* Full list of MOR supported [[Email_variables|email variables]] can be found [[Email_variables|HERE]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Cron_actions&diff=20580Cron actions2016-02-01T15:27:32Z<p>Aisteb: /* Generate Invoices and send by Email */</p>
<hr />
<div>=Descriptions=<br />
Cron actions is MOR functionality which allows you to do some tasks at a specified time. Currently supported actions are these:<br />
<br />
* Change tariff (for Users and/or LCRs) <br />
<br />
* Change LCR (for Users) <br />
<br />
* Change provider tariff (for Providers)<br />
<br />
* <!---This functionality is available from MOR X5---> Generate Invoice (for Users) <br />
<br><br><br />
'''NOTE''' that currently only System Admin is allowed yo use this functionality.<br />
<br><br><br />
<br />
=Important notes on billing=<br />
<br />
MOR takes the call price before the call and uses it to calculate the final price after the call is finished.<br />
<br />
Example: User starts a call at 9:58 PM and is talking for 5 minutes, you have an action which changes tariff at 10:00 PM. When call will be finished MOR will bill user using older tariff. If user starts a call after tariff change - he will be charged using the new tariff assigned for him.<br />
<br><br><br />
=Usage=<br />
<br />
Go to '''SETTINGS –> Setup –> Settings –> Cron actions''':<br />
<br><br><br />
[[File:Cron_actions_path.png]]<br />
<br><br><br />
Here you will find list of all Cron Actions<br />
<br><br><br />
[[File:Cron_settings_list.png]]<br />
<br><br><br />
Click [[Image:icon_add.png]]'''Add new Cron Action''' to create new Cron Action.<br />
<br><br><br />
==Change tariff==<br />
<br />
''Here is an example with an action '''Change tariff''' (applied for Users)''<br />
<br><br><br />
[[File:Cron_actions_settings.png]]<br />
<br><br><br />
'''Name''' – enter here something that will help you to remember what this settings is about<br />
<br />
'''Action''' – what to do. To change Tariff for User, choose '''Change tariff'''<br />
<br />
'''For User''' – for which User/Users action has to be applied<br />
<br />
'''Where current Tariff is''' – for All Users and Location Rules where selected Tariff/Tariffs assigned.<br />
<br />
'''Change to Tariff''' – which tariff to set<br />
<br />
'''Periodic type''' – how often to perform the task<br />
<br />
'''Repeat forever''' – makes action never stop<br />
<br />
'''From''' – when to start doing the action<br />
<br />
'''Till''' – when to stop doing the action<br />
<br />
'''Description''' – you can use this field for your notes<br />
<br><br><br />
<br />
==Generate Invoices and send by Email ==<br />
<!---Functionality will be available only from MOR x6---><br />
<br />
''Here is an example with an action '''Generate Invoice''' (applied for Users)''<br />
<br><br><br />
[[File:Cron_actions_settings2.png]]<br />
<br><br><br />
<br />
'''General'''<br />
<br />
* '''Name''' – enter here something that will help you to remember what this settings is about<br />
<br />
* '''Action''' – what to do. To generate Invoice for User, choose '''Generate Invoice'''<br />
<br />
'''Details''' – Invoice Details<br />
<br />
* '''User''' – for which User/Users action has to be applied<br />
<br />
* '''Currency''' – currency which will be used for Invoice generation<br />
<br />
* '''From''' – day of the month which should be used as '''start of Invoice period'''<br />
<br />
* '''Till''' – day of the month which should be '''end of Invoice period'''<br />
<br />
* '''Send after Invoice is generated?''' – if email sending is enabled, you can choose to send Invoices after it is generated. <br />
<br />
'''Repeat''' – Cron Action repetition<br />
<br />
* '''Periodic type''' – how often to perform the task<br />
<br />
* '''Repeat forever''' – makes action never stop<br />
<br />
* '''From''' – when to start doing the action<br />
<br />
* '''Till''' – when to stop doing the action<br />
<br />
'''Description''' – you can use this field for your notes<br />
<br><br><br />
[[Background Tasks|Background task]] for [[Invoices#Invoice_generation|Invoice generation]] will be created 2 days after each end of selected Invoice period. Repetition period determines when tasks have to be created. <br />
<br />
For example, we want to generate Invoices every month for full month from 2015 October 1 until 2016 January 1. <br />
<br />
* In '''Details''' section we select '''From''' - 1 and '''Till''' - 31<br />
* In '''Reapeat''' section we select '''Periodic type''' - monthly, '''From''' 2015 October 1 00 '''Till''' 2016 January 1 00<br />
* When '''Create''' button is pressed at 2015 October 2 we will find Invoices of September<br />
<br />
'''NOTE''' If Repetition start date and time is over 48 hours after nearest end of selected Invoice period, first group of Incvoices will be generated more than after one month.<br />
<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[Users]]<br />
* [[LCR]]<br />
* [[Providers]]<br />
* [[Tariffs]]<br />
* [[Invoices]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=MOR_X6&diff=20579MOR X62016-02-01T15:26:21Z<p>Aisteb: /* INVOICES */</p>
<hr />
<div>[[File:mor_x6.png|right|700px|alt="MOR X6"|link=]]<br />
'''MOR X6''' was released in 2015 March 3rd.<br />
<mkmeta>MOR Class 5 version X6 new functionality</mkmeta><br />
<br />
<br><br />
=MULTI-LEVEL RESELLER=<br />
<br />
Added additional level of Resellers - Partners. Which allows more control over your business model.<br />
<br />
<br><br />
=MULTI-TENANT PBX=<br />
<br />
Reworked internal structure to support multi-tenant PBX functionality which allows to isolate users on the same server by providing them separate spaces for their PBX extensions (PBX Pools).<br><br />
Now many companies can use the same server and have the same Extensions for their PBX needs.<br />
<br />
<br><br />
=[[Invoices | INVOICES]]=<br />
<br />
<b>SPEED -</b> Completely reworked invoice generation in the MOR. Now invoices are generated in the background by C code, which runs <u>thousands</u> times faster compared to previous GUI generation.<br />
<br />
<b>CONVENIENCE - </b> Now invoices are generated into XLSX format with your custom template. You can create your own <u>custom-looking invoice template</u> with logos and so on and apply it to all invoices.<br><br />
Invoices are <u>generated only once</u> and stored on local HDD for fast retrieval later, no more waiting each time to generate it again.<br />
<br />
<br><br />
<br />
=RATES=<br />
<br />
<b>CONVENIENCE - </b> Rate internal storage reworked. Now it is possible to import rates from Suppliers with different Destination Names for the same Prefix and manage them independently. <br />
<br />
<b>SPEED -</b> Approximately 20% speed increase achieved in routing algorithm by simplified retrieval logic.<br />
<br />
<br><br />
=VARIOUS IMPROVEMENTS=<br />
<br />
=== PROVIDERS ===<br />
<br />
* Improved menu options for Providers<br />
* Added ordering for Providers Calls page<br />
* Provider price rerating greatly improved<br />
<br />
=== RESELLERS ===<br />
<br />
* Option to delete many [[Recordings Addon | recordings]] for Resellers<br />
* Menu rearrangement for Resellers<br />
* "Login page text" functionality added<br />
<br />
=== OTHER ===<br />
<br />
* New report [[Calls per Hour]]<br />
* [[User Permissions]]<br />
* [http://wiki.kolmisoft.com/index.php/User_Details#Blacklists_.2F_Whitelists Static Blacklisting/Whitelisting]<br />
* Last Calls page speed improved to handle large sets of data<br />
* [[Accountant permissions | Accountants now can manage]] Localizations, LCRs, Providers and Terminators<br />
* Active Calls now shows as Connected/Total<br />
* Calling Cards - Added 2 new [http://wiki.kolmisoft.com/index.php/End_IVR_Type#End_IVR_.238 End IVRs: 8 and 9]<br />
* Callshop - improved rate search presentation and general layout<br />
* Alerts writes log to the Actions now<br />
* Privacy option in the SIP packet for anonymous call are now handled properly<br />
* Improved archiving calls performance<br />
* Changes to AMI to support some rare cases when sync is lost<br />
* Currency handling improved for Paypal <br />
* Email TLS sending support improved<br />
* Interpret as Failed option now also changes HGC for better routing logic<br />
* Added option to order by Owner in DIDs page<br />
* Added Effective Date to exported rate files<br />
* Voicemail has new Skip Intro option for custom greetings<br />
* Server type now also available as 'Other' for better proxy support<br />
* Option to allow same email for various Users<br />
* New option [[Mor.conf | billsec_round_function]] to select different rounding method for billsec in the core <br />
* New option [http://wiki.kolmisoft.com/index.php/Device_settings#Codecs Enforce same codec as on Leg A] to avoid transcoding by forcing LegA codec into LegB<br />
* Old slow rerating in the GUI removed (changed to fast C background rerating)<br />
<br><br />
* AND MANY MANY OTHER SMALL IMPROVEMENTS AND FIXES FOR CONVENIENCE AND SPEED<br />
<br />
<br><br />
<br />
=API=<br />
<br />
===New API methods===<br />
<br />
* SERVICES<br />
** [[MOR_API_Service_create | service_create]]<br />
** [[MOR_API_Service_delete | service_delete]]<br />
** [[MOR_API_Services_get | services_get]]<br />
** [[MOR_API_Service_update | service_update]]<br />
* SUBSCRIPTIONS<br />
** [[MOR_API_subscription_create | subscription_create]]<br />
** [[MOR_API_subscription_delete | subscription_delete]]<br />
** [[MOR_API_Subscriptions_get | subscriptions_get]]<br />
** [[MOR_API_subscription_update | subscription_update]]<br />
* OTHER<br />
** [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] - allows to subscribe User to the SMS service<br />
** [[MOR_API_voucher_use | voucher_use ]] - allows to use Voucher<br />
** [[MOR_API_phonebook_record_delete | phonebook_record_delete ]] - deletes record from the Phonebook<br />
** [[MOR_API_did_details_update | did_details_update ]] - allows to set DID Call Limit<br />
<br />
===Improvements/changes===<br />
<br />
** [[MOR_API_user_details_update | user_details_update]] added option for reseller to inherit the QuickForwardDID rules from Admin<br />
** [[MOR_API_user_details_get | user_details_get]] returns call_limit for user now<br />
** [[MOR_API_user_register | user_register ]] greatly increased user registration API speed<br />
** [[MOR_API_device_update | device_update]] added option for reseller to inherit the localization rules from Admin<br />
** [[MOR_API_device_create | device_create]] added option to create special extension<br />
** [[MOR_API_conflines_update | conflines_update]] added new optional parameters: default_device_location_id and default_User_tariff_id<br />
** [[MOR_API_callback_init | callback_init]] added option to send Card PIN to initiate Callback to Calling Card without entering PIN (pinless)<br />
<br />
= REMOVED FROM X6 =<br />
<br />
* Types of Destination Groups(SubCodes).<br />
* Direction column from Wholesale and Provider type Tariff Rates lists<br />
* Settings to update Destination Groups and Directions for Destinations based on Country Code via [[Rate import from CSV|Tariff Import]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Invoices_(MOR_X6)&diff=20578Invoices (MOR X6)2016-02-01T15:25:49Z<p>Aisteb: moved Invoices (MOR X6) to Invoices</p>
<hr />
<div>#REDIRECT [[Invoices]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Invoices&diff=20577Invoices2016-02-01T15:25:49Z<p>Aisteb: moved Invoices (MOR X6) to Invoices</p>
<hr />
<div>= Description =<br />
<br />
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.<br />
<br><br><br />
= Configuration =<br />
<br />
You can manage Invoices settings, details, Address information and functionality in the Invoices section of the [[Configuration_from_GUI#Invoices | SETTINGS -> Setup -> Settings]] window.<br><br />
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''<br />
<br><br><br />
<br />
Go to User's edit page to enable or disable types of invoices he can see in his invoices details. And also these selected types will be the ones that are sent to user via email. <br />
<br />
[[File:Invoices_types.png]]<br />
<br />
=Invoices list=<br />
<br />
Invoices can be viewed, generated, recalculated, sent, also <!---...from MOR 9---> 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:<br />
<br><br><br />
[[Image:invoices_list_x6.png]]<br />
<br><br><br />
The icons [[Image:icon_check.png]] and [[Image:icon_cross.png]] show whether this invoice is Paid or Unpaid, Sent or Not Sent. <br />
<br><br />
'''NOTE''' Each Invoice generated in particular Time Zone and on particular Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.<br />
<br><br />
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.<br />
<br><br><br />
'''Example'''<br />
<br><br><br />
Default system Currency is USD<br />
<br><br />
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5<br><br />
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25<br><br />
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75<br><br />
<br><br />
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. <br><br />
<br><br />
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for Invoice A exchange rate will be from that day when Invoice was generated (0.5).<br><br />
<br />
Same calculations with other currencies:<br><br />
If you want to see Total price in USD. For Invoice A, B and C the exchange rates will be set from the day when invoice was generated (EUR - 0.5, DZD - 0.25 and ALL - 0.75).<br><br />
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for Invoice B exchange rate will be from the day when Invoice was generated (0.25).<br><br />
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for Invoice C exchange rate will be from the day when Invoice was generated (0.75).<br><br />
<br><br />
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL<br><br />
<br><br><br />
<br />
=Invoice details=<br />
<br />
Click on the [[Image:icon_details.png]] icon to get details of the Invoice:<br />
<br><br><br />
[[Image:invoice_details_x6.png]]<br />
<br><br><br />
Invoice details are shown in Currency which was used to generate Invoice. <br />
<br><br><br />
==General Details==<br />
<br />
'''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.<br><br />
'''Currecy of Invoice''' - <!---This functionality is available from MOR X6---> Invoices are exported in Invoice currency.<br />
<br />
'''Language of Invoice'''<br />
<br><br />
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).<br />
<br><br><br />
<br />
==User Details==<br />
<br />
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]].<br />
<br><br><br />
==Files to send or download==<br />
<br />
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.<br />
<br />
*'''Invoice XLSX''' xlsx file shows information which are set by you. Check [[Invoices_(MOR_X6)#XLSX_Invoices | XLSX Invoice]]<br />
*'''Invoice''' PDF shows separate services Prices and Total Invoice Prices, CSV shows just Total Invoice Prices.<br />
*'''Invoice detailed''' shows same information like simple Invoice and includes Calls list grouped by Destination.<br />
*'''Invoice by CallerID''' shows Calls list grouped by CallerID.<br />
*'''Invoice Destinations''' shows Calls list grouped by Destination. <br />
<br />
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.<br />
<br><br><br />
=== XLSX Invoices ===<br />
<br />
XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.<br />
Example of template can be downloaded for [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx here].<br />
<br><br><br />
'''Default XLSX template'''<br />
<br />
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'''<br />
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.<br />
* Check '''Group regular Calls by Destinations''' if you want XLSX file us as detailed Invoice.<br />
<br><br />
'''Balance Line settings'''<br />
<br />
''Outstanding balance (Debt)'', ''Outstanding balance (Debt) with TAX'', ''Total amount due'' options are present when ''Show balance line'' ('''SETTINGS -> Setup -> Settings''', Invoices - Postpaid - Settings) setting is enabled.<br />
<br><br><br />
'''Configuration for Dynamic information'''<br />
<br />
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. <br />
<br />
For example "A2", "B15", "AA9"<br />
<br><br><br />
[[File:callc.png]]<br />
<br><br><br />
<br />
'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.<br />
<br />
=== PDF invoices ===<br />
<br />
The layout of PDF invoices is not customizable. <br />
<br />
Logos are not supported in PDF invoices.<br />
<br />
You can print your invoices on paper with a pre-printed logo if you want to send paper invoices.<br />
<br><br><br />
=== CSV invoices ===<br />
<br />
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.<br />
<br><br><br />
<br />
==Comment==<br />
<br><br />
<!---This functionality is available from MOR 9---><br />
Sometimes it is useful to add a comment to the invoice. It can be used in xlsx file also.<br />
<br><br><br />
==Invoice Details==<br />
Click on the Invoice Details icon in the Invoice details page <br />
<br><br><br />
[[Image:Service_details.png]]<br />
<br><br><br />
to get Services Details of the Invoice: <br />
<br><br><br />
[[Image:invoice_services_x6.png]]<br />
<br><br><br />
'''Services:'''<br />
<br><br />
* '''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<br />
* '''DID Owner Cost''' – price for having and using own DID(s)<br />
* '''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<br />
* '''Calls''' – quantity and price of outgoing calls<br />
* '''Calls from Users''' – quantity and price of resellers users calls<br />
* '''Calls to DIDs''' – price for calling to DID(s)<br />
<br><br><br />
<br />
= Invoice generation =<br />
<br />
In the main Invoices window, click [[Image:icon_generate_invoices.png]] '''Generate Invoices''' to generate additional invoices:<br />
<br><br><br />
[[Image:generate_invoices_x6.png]]<br />
<br><br><br />
Select for which users to generate invoices. Prepaid and Postpaid users can have separate details. Also, you can check to generate an invoice for only one particular user. Invoice will be generated if selected User existed at least one day of all Invoice period. When Invoice Generation Task is created, admin can check the progress in [[Background Tasks]]. <br />
<br />
'''NOTE:''' For Prepaid User after every executed Manual Payment will be generated Invoice automatically.<br><br />
<!---This functionality is available from MOR X5---><br />
'''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. <br><br />
'''NOTE:''' When generating invoice, current user details will be used. <br> <br />
<br><br><br />
<br />
= Invoice recalculation =<br />
<br />
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'':<br />
<br><br><br />
[[Image:ivoicesnewnew.png]]<br />
<br><br><br />
===Recalculate a group of Invoices===<br />
<br />
To recalculate invoices in the main Invoices window click [[Image:icon_generate_invoices.png]] '''Recalculate invoices''':<br />
<br><br><br />
[[Image:recalc.png]]<br />
<br><br><br />
Select which type of Invoices or whose Invoices to recalculate.<br />
<br><br><br />
=== Recalculate a single Invoice ===<br />
<br />
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:<br />
<br><br><br />
[[File:Recalculate_single_invoice_x6.png]]<br />
<br><br><br />
= Pay unpaid Invoices =<br />
<br />
In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Pay unpaid Invoices''' will appear.<br />
<br><br><br />
[[File:pay_unpaid_invoices.png]]<br />
<br><br><br />
Click '''Pay unpaid Invoices''' and '''All''' unpaid Invoices will be marked as paid. For each marked Invoice Payment will be created.<br />
<br><br><br />
<br />
= Send invoices by email (manual) =<br />
<br />
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:<br />
<br><br><br />
[[Image:invoices_send_x6.png]]<br />
<br><br><br />
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.<br />
<br><br />
* '''Email sending''' option must be enabled in Email Settings to use this feature<br />
* 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.<br />
<br />
<br />
<br><br><br />
= Generate and send invoices by email (automatically) =<br />
<br />
Use [http://wiki.kolmisoft.com/index.php/Cron_actions#Generate_Invoices_and_send_by_Email Cron Actions] to Generate and send Emails automatically.<br />
<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[Accounting]]<br />
* [[Invoice configuration]]<br />
* [[Pay Invoice with balance deduction]]<br />
* [[Outstanding balance(Debt)]]<br />
* [[Invoice by CallerID]]<br />
* [[MOR API invoices_get]]<br />
* [[Cannot generate Invoice]]<br />
* [[Duplicate value in Cell Address field]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Duplicate_value_in_Cell_Address_field&diff=20576Duplicate value in Cell Address field2016-02-01T15:25:14Z<p>Aisteb: /* See also */</p>
<hr />
<div>If you see error '''Duplicate value in Cell Address field''' when editing any settings at ''SETTINGS -> Setup -> Settings'', it means that you have duplicate values at ''SETTINGS -> Setup -> Settings -> Invoices -> XLSX''.<br />
<br><br><br />
To solve the issue, please go to ''SETTINGS -> Setup -> Settings -> Invoices -> XLSX'' and check for duplicate values, as shown in the picture below.<br />
[[File:Duplicate lines.png]]<br />
<br><br><br />
Please change the fields, so no duplicated would be present.<br />
<br />
=See also=<br />
<br />
* [[Invoices]]<br />
* [[Invoice configuration]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=MOR_API_user_register&diff=20557MOR API user register2016-01-25T11:00:14Z<p>Aisteb: /* Returns */</p>
<hr />
<div>=Description=<br />
<br />
<!---This functionality is available from MOR 10---><br />
[[MOR API]] Create new user from params. <br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/user_register<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* '''email''' - New user email. '''Required'''.<br />
* '''id''' - User UNIQUEHASH in MOR database. '''Required'''. <u>If uniquehash is not used, user will end up at admin account</u>.<br />
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:<br />
http://SERVERIP/billing/callc/login/kljsdfg54kl where kljsdfg54kl is the uniquehash.<br />
* '''device_type''' - Device type [SIP, IAX2]. '''Required'''.<br />
* '''username''' - New user username. '''Required'''.<br />
* '''first_name''' - New user first name. '''Required'''.<br />
* '''last_name''' - New user last name. '''Required'''.<br />
* '''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).<br />
* '''state'''<br />
* '''device_location_id'''<br />
* '''lcr_id'''<br />
'''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'''<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[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'''.<br><br />
* '''password''' - New user password. '''Required'''.<br />
* '''password2''' - New user password confirmation. '''Required'''.<br />
* '''country_id''' - New user country (please check table below). '''Required'''.<br />
* '''mob_phone''' - Mobile phone number.<br />
* '''phone - Phone number. <br />
* '''fax''' - Fax. <br />
* '''client_id''' - Company/Personal ID.<br />
* '''vat_number''' - TAX Registration Number.<br />
* '''county'''<br />
* '''city'''<br />
* '''postcode''' - Postcode/ZIP.<br />
* '''address'''<br />
* '''usertype'''<br />
* '''permission_group''' - Reseller or Accountant Permission Group (depending what usertype is sended)<br />
* '''accounting_number''' - Accounting Number<br />
* '''call_limit''' - Call limit (how many simultaneous Calls the new User can make by default?)<br />
* '''credit_limit''' - Credit limit<br />
* '''tariff''' - Tariff ID from database. <br />
* '''currency_id''' - Currency ID from database.<br />
<br><br><br />
<br />
===Request===<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/user_register?id=kljsdfg54kl&username=username&password=pass&password2=pass&first_name=first<br />
&last_name=last&country_id=10&email=email@email.com&device_type=SIP&hash=sd5g16sd1g6s<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<success>Registration successful</success><br />
</status><br />
<user_device_settings><br />
<email>Registration email</email> - If email sending enabled.<br />
<user_id> user id</user_id> <!---This functionality is available from MOR 12---><br />
<device_type> device type [SIP|IAX2]</device_type><br />
<device_id> device id </device_id> <!---This functionality is available from MOR 12---><br />
<username> device username </username><br />
<password> device password </password><br />
<pin> device pin </pin><br />
<server_ip> Asterisk Server IP </server_ip><br />
<registration_notice> Registration notice which is set in Settings </registration_notice><br />
</user_device_settings><br />
</page><br />
<br><br><br />
----<br />
'''Errors'''<br />
<br />
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
* <error>Registration over API is disabled</error> - Setting: Settings->API->API allow Registration, is off. Turn on API allow Registration.<br />
* <error>Access Denied</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.<br />
* <error>Please enter username</error> - Params username is not send. Enter correct username.<br />
* <error>Enter device type</error> - device_type is not send. Enter correct device_type.<br />
* <error>Such username is already taken</error> - Duplicate of username. Change username.<br />
* <error>Passwords do not match</error> - Enter correct passwords.<br />
* <error>Password must be longer than (...) characters</error> - Enter correct password.<br />
* <error>Please enter first name</error> - Enter first_name.<br />
* <error>Please enter last name</error> - Enter last_name.<br />
* <error>Please select country</error> - Enter country_id.<br />
* <error>Please enter email</error> - Email address is not valid or not send. Enter correct email.<br />
* <error>This email address is already in use</error> - Change email address.<br />
* <error>User with mobile phone already exists</error> - Change mobile phone.<br />
* <error>User with phone already exists</error> - Change phone.<br />
* <error>User with fax already exists</error> - Change fax.<br />
* <error>Default user is not present</error> - [[Default_user | Default User's]] settings are not saved in database. <br />
* <error>LCR was not found</error> - LCR id incorrect or does not exist<br />
* <error>Location was not found</error> - Location id incorrect or does not exist<br />
* <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<br />
* <error>Password must contain at least one numeric value, capital and lowercase symbol - Use more secure password with at least one numeric value, capital and lowercase symbol<br />
<br><br><br />
<br />
=== List of Country IDs ===<br />
<br />
1 - Afghanistan<br />
<br />
2 - Albania<br />
<br />
3 - Algeria<br />
<br />
4 - American Samoa<br />
<br />
5 - Andorra<br />
<br />
6 - Angola <br />
<br />
7 - Anguilla <br />
<br />
8 - Antarctica <br />
<br />
9 - Antigua And Barbuda<br />
<br />
10 - Argentina<br />
<br />
11 - Armenia<br />
<br />
12 - Aruba<br />
<br />
13 - Australia<br />
<br />
14 - Austria<br />
<br />
15 - Azerbaijan <br />
<br />
16 - Bahamas<br />
<br />
17 - Bahrain<br />
<br />
18 - Bangladesh <br />
<br />
19 - Barbados <br />
<br />
20 - Belarus<br />
<br />
21 - Belgium<br />
<br />
22 - Belize <br />
<br />
23 - Benin<br />
<br />
24 - Bermuda<br />
<br />
25 - Bhutan <br />
<br />
26 - Bolivia<br />
<br />
27 - Bosnia And Herzegovina <br />
<br />
28 - Botswana <br />
<br />
30 - Brazil <br />
<br />
32 - Brunei Darussalam<br />
<br />
33 - Bulgaria <br />
<br />
34 - Burkina Faso <br />
<br />
35 - Burundi<br />
<br />
36 - Cambodia <br />
<br />
37 - Cameroon <br />
<br />
38 - Canada <br />
<br />
39 - Cape Verde <br />
<br />
40 - Cayman Islands <br />
<br />
41 - Central African Republic <br />
<br />
42 - Chad <br />
<br />
43 - Chile<br />
<br />
44 - China<br />
<br />
45 - Christmas Island <br />
<br />
46 - Cocos (Keeling) Islands<br />
<br />
47 - Colombia <br />
<br />
48 - Comoros<br />
<br />
49 - Congo<br />
<br />
50 - Congo, The Democratic Republic Of The<br />
<br />
51 - Cook Islands <br />
<br />
52 - Costa Rica <br />
<br />
53 - Ivory Cost <br />
<br />
54 - Croatia<br />
<br />
55 - Cuba <br />
<br />
56 - Cyprus <br />
<br />
57 - Czech Republic <br />
<br />
58 - Denmark<br />
<br />
59 - Djibouti <br />
<br />
60 - Dominica <br />
<br />
61 - Dominican Republic <br />
<br />
62 - Ecuador<br />
<br />
63 - Egypt<br />
<br />
64 - El Salvador<br />
<br />
65 - Equatorial Guinea<br />
<br />
66 - Eritrea<br />
<br />
67 - Estonia<br />
<br />
68 - Ethiopia <br />
<br />
69 - Falkland Islands (Malvinas)<br />
<br />
70 - Faroe Islands<br />
<br />
71 - Fiji <br />
<br />
72 - Finland<br />
<br />
73 - France <br />
<br />
74 - French Guiana<br />
<br />
75 - French Polynesia <br />
<br />
77 - Gabon<br />
<br />
78 - Gambia <br />
<br />
79 - Georgia<br />
<br />
80 - Germany<br />
<br />
81 - Ghana<br />
<br />
82 - Gibraltar<br />
<br />
83 - Greece <br />
<br />
84 - Greenland<br />
<br />
85 - Grenada<br />
<br />
86 - Guadeloupe <br />
<br />
87 - Guam <br />
<br />
88 - Guatemala<br />
<br />
89 - Guinea <br />
<br />
90 - Guinea-Bissau<br />
<br />
91 - Guyana <br />
<br />
92 - Haiti<br />
<br />
94 - Vatican City <br />
<br />
95 - Honduras <br />
<br />
96 - Hong Kong<br />
<br />
97 - Hungary<br />
<br />
98 - Iceland<br />
<br />
99 - India<br />
<br />
100 - Indonesia<br />
<br />
101 - Iran <br />
<br />
102 - Iraq <br />
<br />
103 - Ireland<br />
<br />
104 - Israel <br />
<br />
105 - Italy<br />
<br />
106 - Jamaica<br />
<br />
107 - Japan<br />
<br />
108 - Jordan <br />
<br />
109 - Kazakhstan <br />
<br />
110 - Kenya<br />
<br />
111 - Kiribati <br />
<br />
112 - Korea, Democratic People's Republic Of <br />
<br />
113 - Korea, Republic of <br />
<br />
114 - Kuwait <br />
<br />
115 - Kyrgyzstan <br />
<br />
116 - Laos <br />
<br />
117 - Latvia <br />
<br />
118 - Lebanon<br />
<br />
119 - Lesotho<br />
<br />
120 - Liberia<br />
<br />
121 - Libyan Arab Jamahiriya <br />
<br />
122 - Liechtenstein<br />
<br />
123 - Lithuania<br />
<br />
124 - Luxembourg <br />
<br />
125 - Macao<br />
<br />
126 - Macedonia<br />
<br />
127 - Madagascar <br />
<br />
128 - Malawi <br />
<br />
129 - Malaysia <br />
<br />
130 - Maldives <br />
<br />
131 - Mali <br />
<br />
132 - Malta<br />
<br />
133 - Marshall islands <br />
<br />
134 - Martinique <br />
<br />
135 - Mauritania <br />
<br />
136 - Mauritius<br />
<br />
137 - Mayotte<br />
<br />
138 - Mexico <br />
<br />
139 - Micronesia <br />
<br />
140 - Moldova<br />
<br />
141 - Monaco <br />
<br />
142 - Mongolia <br />
<br />
143 - Montserrat <br />
<br />
144 - Morocco<br />
<br />
145 - Mozambique <br />
<br />
146 - Myanmar<br />
<br />
147 - Namibia<br />
<br />
148 - Nauru<br />
<br />
149 - Nepal<br />
<br />
150 - Netherlands<br />
<br />
151 - Netherlands Antilles <br />
<br />
152 - New Caledonia<br />
<br />
153 - New Zealand<br />
<br />
154 - Nicaragua<br />
<br />
155 - Niger<br />
<br />
156 - Nigeria<br />
<br />
157 - Niue <br />
<br />
158 - Norfolk Island <br />
<br />
159 - Northern Mariana Islands <br />
<br />
160 - Norway <br />
<br />
161 - Oman <br />
<br />
162 - Pakistan <br />
<br />
163 - Palau<br />
<br />
164 - Palestine<br />
<br />
165 - Panama <br />
<br />
166 - Papua New Guinea <br />
<br />
167 - Paraguay <br />
<br />
168 - Peru <br />
<br />
169 - Philippines<br />
<br />
171 - Poland <br />
<br />
172 - Portugal <br />
<br />
173 - Puerto Rico<br />
<br />
174 - Qatar<br />
<br />
175 - Reunion<br />
<br />
176 - Romania<br />
<br />
177 - Russian Federation <br />
<br />
178 - Rwanda <br />
<br />
179 - Saint Helena <br />
<br />
180 - Saint Kitts And Nevis<br />
<br />
181 - Saint Lucia<br />
<br />
182 - Saint Pierre And Miquelon<br />
<br />
183 - Saint Vincent And The Grenadines <br />
<br />
184 - Samoa<br />
<br />
185 - San Marino <br />
<br />
186 - Sao Tome And Principe<br />
<br />
187 - Saudi Arabia <br />
<br />
188 - Senegal<br />
<br />
189 - Seychelles <br />
<br />
190 - Sierra Leone <br />
<br />
191 - Singapore<br />
<br />
192 - Slovakia <br />
<br />
193 - Slovenia <br />
<br />
194 - Solomon Islands<br />
<br />
195 - Somalia<br />
<br />
196 - South Africa <br />
<br />
198 - Spain<br />
<br />
199 - Sri Lanka<br />
<br />
200 - Sudan<br />
<br />
201 - Suriname <br />
<br />
203 - Swaziland<br />
<br />
204 - Sweden <br />
<br />
205 - Switzerland<br />
<br />
206 - Syrian Arab Republic <br />
<br />
207 - Taiwan <br />
<br />
208 - Tajikistan <br />
<br />
209 - Tanzania <br />
<br />
210 - Thailand <br />
<br />
212 - Togo <br />
<br />
213 - Tokelau<br />
<br />
214 - Tonga<br />
<br />
215 - Trinidad And Tobago<br />
<br />
216 - Tunisia<br />
<br />
217 - Turkey <br />
<br />
218 - Turkmenistan <br />
<br />
219 - Turks And Caicos Islands <br />
<br />
220 - Tuvalu <br />
<br />
221 - Uganda <br />
<br />
222 - Ukraine<br />
<br />
223 - United Arab Emirates <br />
<br />
224 - United Kingdom <br />
<br />
225 - United States<br />
<br />
227 - Uruguay<br />
<br />
228 - Uzbekistan <br />
<br />
229 - Vanuatu<br />
<br />
230 - Venezuela<br />
<br />
231 - Vietnam<br />
<br />
232 - Virgin Islands, British<br />
<br />
233 - Virgin Islands, U.S. <br />
<br />
234 - Wallis And Futuna<br />
<br />
236 - Yemen<br />
<br />
238 - Zambia <br />
<br />
239 - Zimbabwe <br />
<br />
240 - Ascension Island <br />
<br />
241 - Diego Garcia <br />
<br />
242 - Inmarsat <br />
<br />
243 - East Timor <br />
<br />
246 - Iridium<br />
<br />
247 - Serbia and Montenegro<br />
<br />
250 - Emsat<br />
<br />
251 - Ellipso-3<br />
<br />
252 - Globalstar <br />
<br />
253 - Montenegro <br />
<br />
254 - Kosovo<br />
<br />
255 - South Sudan<br />
<br />
256 - Thuraya<br />
<br />
If you added new Direction you can find its ID in SETTINGS -> Billing -> Directions page '''Directions edit''' or '''Destinations list''' URL end:<br />
<br><br><br />
[[File:directions_id.png]]<br />
<br><br><br />
=See also=<br />
<br />
* [[MOR API]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=MOR_API_user_details_get&diff=20544MOR API user details get2016-01-19T08:59:54Z<p>Aisteb: /* Returns */</p>
<hr />
<div>=Description=<br />
<br />
[[MOR API]] user details<br />
<br />
'''Admin''' – can get any user details<br><br />
'''Reseller''' – can get his and his users details.<br><br />
'''User''' – can get his own details.<br><br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X4''' call: '''/api/user_details_get'''<br />
* For Backwards-compatibility old name 'user_details' is also usable. Call: '''/api/user_details'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parametres===<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* '''user_id''' - Users ID in MOR database. '''Required if username is not used'''. Type: INTEGER<br />
* '''username''' - Users Username in MOR database. '''Required if user_id is not used'''.<br />
<br />
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'''<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
* '''[[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'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
<br />
===Request===<br />
<br />
We have user_id = 123, API Secret Key = 456789<br />
<br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing/api/user_details_get?u=username&user_id=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441<br />
<br />
<br />
<br />
We have username = username, API Secret Key = 456789<br />
<br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing/api/user_details_get?u=username&username=username&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441<br />
<br />
<br />
<br />
We have user_id = 123, username = username, API Secret Key = 456789<br />
<br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing/api/user_details_get?u=username&user_id=123&username=username&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441<br />
<br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<pagename>Personal_details</pagename><br />
<language>en</language><br />
<userid> user id </userid><br />
<details><br />
<main_detail><br />
<account>Postpaid/Prepaid</account><br />
<balance> balance and currency </balance><br />
<balance_number> balance </balance_number> <br />
<balance_currency> currency </balance_currency><br />
<credit> credit </credit><br />
<pbx_pool_id> id </pbx_pool_id><br />
<hide_non_answered_calls> 0 - off/1 - on </hide_non_answered_calls><br />
</main_detail><br />
<other_details><br />
<username> username </username><br />
<first_name> first name </first_name><br />
<surname> last name </surname><br />
<personalid></personalid><br />
<agreement_number> </agreement_number><br />
<agreement_date> </agreement_date><br />
<taxation_country> </taxation_country><br />
<vat_reg_number> </vat_reg_number><br />
<vat_percent> </vat_percent><br />
<call_limit> </call_limit><br />
</other_details><br />
<registration><br />
<reg_address></reg_address><br />
<reg_postcode></reg_postcode><br />
<reg_city></reg_city><br />
<reg_country></reg_country><br />
<reg_state></reg_state><br />
<reg_direction></reg_direction><br />
<reg_phone></reg_phone><br />
<reg_mobile></reg_mobile><br />
<reg_fax></reg_fax><br />
<reg_email></reg_email><br />
</registration><br />
</details><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>User was not found</error> - User was not found using user_id and/or username. Use correct user_id and/or username.<br />
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=SMS_Addon_Mass_SMS&diff=20542SMS Addon Mass SMS2016-01-14T17:56:34Z<p>Aisteb: /* Campaigns */</p>
<hr />
<div><!-- Funkcionalumas nuo x4-->=Description=<br />
<br />
Mass SMS addon lets you send one or more sms to an array of [[SMS_Addon_Mass_SMS#Numbers | numbers]] automatically. <br />
This functionality can be used in telemarketing.<br />
<br><br><br />
== Who can configure and use Mass SMS? ==<br />
<br />
* Only end users can create Mass SMS campaigns, actions, edit, delete them and import numbers. <br />
<br />
* Admin and reseller can check their users' campaigns and view actions, but cannot edit them.<br />
<br />
<br><br><br />
=Configuration=<br />
<br />
For user to be able to use Mass SMS, he first has to be subscribed to [[SMS Addon]]. <br />
<br />
After you prepare [[SMS_Addon_-_Providers | Providers]] go to '''ADDONS –> SMS''':<br />
<br><br><br />
[[File:sms_user_subscription_pash.png]]<br />
<br><br><br />
You will reach list of subscribed to SMS service Users:<br />
<br><br><br />
[[File:sms_subscribed_users_list.png]]<br />
<br><br><br />
Here have to subscribe User to SMS Service, just select user from dropdown and press Subscribe. If you want unsubscribe user from SMS Service click [[image:icon_delete.png]] icon. Click on [[image:icon_edit.png]] icon to change Users LCR or Tariff for SMS Service.<br />
<br><br><br />
[[File:sms_user_edit.png]]<br />
<br><br><br />
[http://wiki.kolmisoft.com/index.php/Reseller_Permissions Reseller] also has to have SMS Addon and SMS permission enabled.<br />
<br />
=Usage=<br />
<br />
==From Admin/Reseller==<br />
<br />
Go to '''ADDONS -> SMS -> Mass SMS''': <br />
<br><br><br />
[[Image:Admin-menu-sms-mass.png]]<br />
<br><br><br />
Here you can see the list of campaigns created by the end users. You can see the number of phone numbers imported, actions created, campaign status, profit from campaign and other information. <br />
<br><br><br />
[[Image:mass_sms_main_admin.png]]<br />
<br><br><br />
You can also check actions by clicking on the action [[Image:Icon_actions.png]] icon and sms being sent by selected campaign. <br />
<br><br><br />
[[Image:admin-view-actions.png]]<br />
<br><br><br />
<br />
==From User==<br />
<br />
Go to '''PERSONAL MENU -> SMS -> Mass SMS''': <br />
<br><br><br />
[[Image:End user menu.png]]<br />
<br><br><br />
The main window shows the user's campaigns. Here is more information and available settings that admin/reseller has:<br />
<br><br><br />
[[Image:user-main-mass-sms.png]]<br />
<br><br><br />
The user can Activate or Stop the Campaign by clicking the [[Image:icon_play.png]] or [[Image:icon_stop.png]] button near the Campaign's status.<br />
<br />
A Campaign can only be '''Activated''' if it has free numbers AND some Actions. <br />
<br />
So please, before activating a Campaign, import some Numbers and create Actions.<br />
<br><br><br />
===Campaigns===<br />
<br />
[[Image:icon_add.png]] '''Add campaign''' allows you to add a new campaign:<br />
<br><br><br />
[[Image:Mass-sms-add.png]]<br />
<br><br><br />
The important fields here are:<br />
<br />
* '''Start/Stop Times''' – time when sms will be sent.<br />
* '''Device''' – each Campaign should be assigned to a Device in order for MOR to bill the call.<br />
* '''CallerID''' – what CallerID to put on SMS. If CallerID is not set, CallerID from SMS Provider settings will be taken in its place. If SMPP Provider will be used and CallerID is not set, CallerID from User Primary Device will be taken.<br />
<br><br><br />
<br />
=== Numbers ===<br />
<br />
Click on [[Image:icon_list.png]] in the '''Numbers''' column to check numbers which will be dialed on campaign:<br />
<br><br><br />
[[Image:User-main-mass-sms-import-numbers.png]]<br />
<br><br><br />
The user can import phone numbers from a CSV file. Numbers should be in correct dialing format and not duplicated.<br />
<br />
Example of numbers file:<br />
<br />
442012345678<br />
442087654321<br />
442054987123<br />
<br />
In a new Campaign there are no numbers, so click on [[Image:icon_csv.png]] '''Import numbers from file''' and select the file to upload:<br />
<br><br><br />
[[Image:autodialer3.png]]<br />
<br><br><br />
After uploading the file, you will see status of imported numbers:<br />
<br><br><br />
[[Image:autodialer4.png]]<br />
<br><br><br />
You can delete all numbers by clicking [[Image:icon_cross.png]] '''Delete all numbers'''. Also you can export details by clicking [[Image:excel.png]] '''Export IVR/poll results to CSV'''<br />
<br />
<br />
If a number is Completed, it is possible to reactivate it (tell the system to call it again) by clicking the [[Image:icon_reactivate.png]] icon near the number.<br />
<br><br><br />
<br />
=== Actions ===<br />
<br />
Click [[Image:icon_actions.png]] in the Actions column to access the Campaign's actions:<br />
<br><br><br />
[[Image:User-mass-sms-actions.png]]<br />
<br><br><br />
Here user can choose actions for the campaign.<br />
There is currently one type of action for Mass SMS: <br />
* '''SEND SMS''' – the specified sms will be sent to all numbers in the campaign. <br />
<br><br><br />
<br />
===Resend all failed SMS===<br />
<!---This functionality is available from MOR 9---><br />
You can resend all failed SMS:<br />
<br><br><br />
[[File:Resend.png]]<br />
<br><br><br />
<!--==From Admin==<br />
<br />
When Auto-Dialer (AD) is installed, Admin can find it under the '''ADDONS –> Auto Dialer''' menu. Here he can get a view of all users' campaigns:<br />
<br><br><br />
[[Image:autodialer6.png]]<br />
<br><br><br />
The important information for each Campaign is:<br />
<br />
* Status – is the Campaign Active or Stopped?<br />
* Run time – tells when calls will be made.<br />
<br />
All other fields are self-explanatory.<br />
<br />
It is possible for admin to see the Actions for users' Campaigns. Just click on the [[Image:icon_actions.png]] '''Actions''' button. However he cannot make any changes to the user's campaign. <br />
<br><br><br />
=Workflow=<br />
<br />
Each 5 minutes, "cron job" is activated to check whether any campaigns are activated.<br />
<br />
If there are some active campaigns, the script creates call files for the future. <br />
<br />
It puts calls in Time Period in equal time periods, to balance the workload for Asterisk.<br />
<br />
For example, if you have 10 calls to make, the script will execute them in 6s intervals to start all calls in 1 min time.<br />
<br />
Variables in '''/var/lib/asterisk/agi-bin/mor.conf''':<br />
<br />
'''calls_one_time''' - how many calls to distribute per one minute. (PLEASE NOTE, this value is not for simultaneous calls! It has a very different meaning, which is explained below).<br />
<br />
'''cron_interval''' - the interval of time (in minutes) in which we should 'put' calls. Do not set value higher than "4" as it would cause overlapping of Autodialer sessions.<br />
<br />
Example #1:<br />
<br />
calls_one_time = 10.<br />
cron_interval = 1.<br />
<br />
That means that in 1 minute the script will put 10 calls. So each call will be executed at a 6s interval:<br />
<br />
1st call: 0s<br />
2nd call: 6s<br />
3rd call: 12s<br />
....<br />
9th call: 54s<br />
10th call: 60s<br />
<br />
Example #2:<br />
<br />
calls_one_time = 5.<br />
cron_interval = 2.<br />
<br />
That means that in 1 minute the script will put 5 calls and it will do so for 2 minutes. So each call will be executed at a 12s interval:<br />
<br />
1st call: 0s<br />
2nd call: 12s<br />
3rd call: 24s<br />
4rd call: 36s<br />
5th call: 48s<br />
6th call: 60s<br />
7th call: 72s<br />
8th call: 84s<br />
9th call: 96s<br />
10th call: 108s<br />
<br><br><br />
=Limitations=<br />
<br />
Currently MOR does not support such functionality as to issue the Auto Dialer campaign only in that Asterisk <br />
<br />
server to which the device belongs (if you have multiple Asterisk servers). Now MOR just issues the campaign on both servers, if you want it to <br />
<br />
run only on one server you need to just disable the cron job on one of the servers. <br />
Cron can be found in <br />
/etc/cron.d/mor_ad<br />
<br><br><br />
=Logs=<br />
<br />
Autodialer log can be found here:<br />
/var/log/mor/mor_ad_cron.log<br />
<br><br><br />
= Problems =<br />
<br />
* [[MOR Server Speedup]] (to get more calls by AD)<br />
* [[I have a problem with Auto Dialer]]<br />
<br><br>--><br />
<br />
=See also=<br />
<br />
* [[SMS Addon]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=User_Details&diff=20541User Details2016-01-14T17:29:05Z<p>Aisteb: /* General */</p>
<hr />
<div>=Where to find user details?=<br />
<br />
Go to '''SETTINGS –> Users'''<br />
<br><br> <br />
[[File:Users_path.png]] <br />
<br><br> <br />
Here you can see list of all users. In brackets by the Accountant or Reseller you are able to see to which Permissions Group([[Reseller Permissions]] or [[Accountant permissions]]) they belong. <br />
<br><br> <br />
[[File:Users_list.png]] <!---From MOR X4 some of cells are empty because reseller/accountant does not make calls anymore---><br />
<br><br> <br />
Select the [[image:icon_edit.png]] icon in window above and you will reach personal user settings page. In this window you will see a lot of options grouped into sections like General, Blocking, Warning Balance Email, Invoices, Payments, Details, Taxes, Registration Address, Recordings and Blacklists.<br />
<br />
<!---This functionality is available from MOR X4---><br />
'''NOTE''' that admin is not shown in Users list. To see your own details go to '''PERSONAL MENU –> Details'''.<br />
<br><br><br />
<br />
= Details update = <br />
Every User can update his own details in '''PERSONAL MENU –> Details'''.<br><br><br />
To disallow users to change their details Admin/Reseller has to check setting "Do not allow users to change their Personal Details" in '''SETTINGS -> Setup -> Settings -> Various'''. After this User Details can only be updated by user's owner.<br><br><br />
'''NOTE''' that even if User is not allowed to update his own details, he still can see it in '''PERSONAL MENU –> Details''' as form with not editable options.<br><br><br />
<br />
= General =<br />
<br />
* Username – username for user to login to MOR GUI.<br />
* Password – password for user to login to MOR GUI. Password must contain at least one numeric value, capital and lowercase symbol.<br />
* [[Users#User_types | User type]] – by default it is "user".<br />
* [[LCR]] – LCR indicating which of the user's devices will be used to dial out.<br />
* [[Tariffs | Tariff]] – prices for the user. <br />
* [[Balance and Credit | Balance]] – the user's balance.<br />
* Daily credit limit – Total credit available for user per day. If User reaches this limit all User's calls will be dropped with hangupcause '211 Low balance for user'. This limit is reset each day at midnight (00:00:00).<br />
* [[Balance and Credit | Credit]] – the user's credit, showing how low the user's balance can go.<br />
* [[Minimum contract billing | Minimal Charge for Calls]] - minimum charge user pays for voice calls.<br />
* [[Minimum contract billing | Minimal Charge for Calls Date]] - date since when the previous option is valid.<br />
* Postpaid/Prepaid – type of user.<br />
* [[Hide Users | Not Hidden/Hidden]] – is this user hidden?<br />
* Primary device – the primary device for this user.<br />
* [[Allow loss calls]] – should loss calls be allowed for this user?<br />
* [[Simultaneous call limitation | Call Limit]] - how many simultaneous calls the user can make?<br />
* Responsible accountant – dropdown to choose accountant responsible for user's profit. <br />
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. <!-- veikia su x5_functionality_15 --> <br />
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] <!---from x5---><br />
<br><br><br />
<br />
= Blocking =<br />
<br />
Various options for [[User Blocking]].<br />
<br><br><br />
= Warning Balance Email =<br />
<br />
If you want to send an email notification to a user (or take another action) when his balance drops lower than a certain amount, check this setting and enter the desired amount.<br />
<br />
More details: [[Warning balance]]<br />
<br><br><br />
= Invoices =<br />
<br><br><br />
[[Image:user_invoice_details.png]]<br />
<br><br><br />
* Generate Invoice – should we generate an invoice for this user when we choose to generate invoices for a period?<br />
* Invoice, Detailed, By CallerID, By Destinations and PDF/CSV show various types of invoices which should be showed in Users ''PERSONAL MENU –> Details –> Invoices'' and/or sent to the User as an email attachment.<br />
* Show zero Calls – if the call price = 0, should such calls appear in the invoice or not?<br />
<br><br><br />
= Payments =<br />
<br />
* Cyberplat - check this option if you want to allow the user to use this payment gateway.<br />
<br />
<br><br><br />
= Details =<br />
<br />
Self-explanatory.<br />
<br />
If Country of Taxation is in the EU, validation of TAX Registration Number will be checked from this website: http://ec.europa.eu/taxation_customs/vies/<br />
<br><br><br />
= Taxes =<br />
<br />
Here tax parameters are entered for the user.<br />
<br />
The tax system is explained [[Multi-Tax system | here]].<br />
<br><br><br />
= Registration Address =<br />
<br />
Self-explanatory.<br />
<br><br><br />
= Recordings = <br />
<br />
This section is available when the [[Recordings Addon]] is installed in the system.<br />
<br><br><br />
=Blacklists / Whitelists=<br />
<br><br><br />
[[Image:user_blacklists_details.png]]<br />
<br><br><br />
<!---FROM MOR X7---><br />
'''Enable static Source''' - enables static Blacklist or Whitelist<br><br />
* '''No''' - do not use any Blacklist or Whitelist<br />
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from receiving and sending specific Source numbers. If User receives or sends number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''262 - Source number is in blacklist''<br />
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to receive only specific Source numbers. If User receives number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''263 - Source number is not in whitelist''<br />
<br />
<!---FROM MOR X5---><br />
'''Enable static Destination''' - enables static Blacklist or Whitelist<br><br />
* '''No''' - do not use any Blacklist or Whitelist<br />
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from calling specific Destination numbers. If User calls number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''255 - Destination is in blacklist''<br />
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to call only specific Destination numbers. If User calls number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''256 - Destination is not in whitelist''<br />
<br><br><br />
Also you can manage '''[[Dynamic Blacklist Functionality]]''' settings for Single User. You are able to manage:<br />
<br />
'''Enable Dynamic Blacklist''' – enables dynamic Blacklist functionality for this user.<br><br />
'''Blacklist LCR''' – [[LCR]] with Blacklist Providers.<br><br />
'''Routing Threshold''' – sum of SRC, DST and RTP IP limit. If SRC, DST or RTP IP scores sum received during the call is bigger than Defaullt Threshold, call will be routed through selected Blacklist LCR. <br><br />
<br />
Choose option '''Global''' if you want to apply [[ Monitorings_Addon#Monitorings_Settings | global settingas]] for this user.<br />
<br><br><br />
<br />
= Comment = <br />
<br />
Here you are able to write private comment about user.</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=MOR_API_did_details_update&diff=20540MOR API did details update2016-01-14T17:06:50Z<p>Aisteb: </p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] DID details update<br />
<br />
Please note that only admin, accountant(with device management) with permission and reseller can use this API. <br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/did_details_update<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parametres===<br />
<br />
Parameter which is '''included''' into hash:<br />
<br />
* '''did_id''' – this is id of DID which have to be updated. '''Required'''.<br />
<br />
'''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'''<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''did_id''' and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
* '''u''' – username to login. '''Required'''.<br />
* '''call_limit''' – call limit of did which will be updated. '''Optional'''<br />
* <!--FROM MOR X6--->'''did_user_id''' – User ID from database whom DID should be assigned. '''Just free DID can be assigned to User.''' DID can be assigned to Reseller or simple User. Set -1 to make DID free. '''Optional'''<br />
<br><br><br />
===Request===<br />
<br />
We have API Secret Key = secret, did_id = 6511 <br><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing/api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46<br />
<br />
'''* Note that username is not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<success>DID details successfully updated</success><br />
</status><br />
</page><br />
<br />
'''After successfully updating DID action log record is added.'''<br />
<br><br><br />
----<br />
'''Errors'''<br />
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
* <error>Call limit is incorrect format</error> – Specified call limit has to be 0 or positive number.<br />
* <error>DID is already assigned</error> – DID is already assign to other User, Reseller or Dial Plan.<br />
* <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=Configuration_from_GUI&diff=20537Configuration from GUI2016-01-13T14:49:50Z<p>Aisteb: /* Visual */</p>
<hr />
<div>=Where I can find this settings menu?=<br />
<br />
You can find this menu in '''SETTINGS –> Setup –> Settings'''<br />
<br />
[[File:Settings_path.png]]<br />
<br><br><br />
== Global ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> [[Global_Settings | Global]]'''<br />
<br />
* '''Company''' – name of the company.<br />
* '''Company email''' – email address of the company.<br />
* '''Version''' – version number.<br />
* '''Copyright Title''' – copyright title supports html text format.<br />
* '''Browser Title''' – browser title for MOR GUI.<br />
* '''Front Page Text''' – some text to place on front page.<br />
* '''Login Page Text''' – some text to place on login page<br />
<br><br><br />
<br />
== Registration == <br />
<br />
'''SETTINGS –> Setup –> Settings –> Registration'''<br />
<br />
* '''Enabled?''' – do we want to let users [[Online registration | register online]] automatically?<br />
* '''Hide registration link in Login page?''' – tick this option if you do not want users to be able to register online.<br />
* '''Default country'''<br />
* '''Asterisk server IP''' – what IP should user connect his softphone/server to?<br />
* '''Send email to user after registration''' – just yes or no.<br />
* '''Send email to admin after registration''' – just yes or no.<br />
* '''[[ReCAPTCHA]] configuration'''<br />
* '''[[User_Agreement|Terms and conditions]]'''<br />
* '''Allow to create user and device with matching username and password''' – just yes or no. If this setting is not enabled - username and password from MOR GUI will have to be different than device's username and password.<br />
* '''Enable VAT checking for EU companies''' – you can choose whether to check '''TAX Registration Number:''' during the [[Online registration]] or not. Done over [http://ec.europa.eu/taxation_customs/vies/?locale=lt EU page].<br />
* '''Allow blank VAT for EU companies''' – allows to leave blank '''TAX Registration Number:''' field during the [[Online registration]]<br />
<br><br><br />
===See also===<br />
<br />
* [[Default user]]<br />
<br><br><br />
<br />
== Invoices ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Invoices'''<br />
<br />
Invoice configuration is divided into '''Prepaid''' and '''Postpaid'''. <br />
<br><br><br />
=== Settings ===<br />
<br />
* '''Number start''' – how the invoice number should start.<br />
* '''Number length''' – the length in digits AFTER Number Start – e.g. Number Start is not counted into this length. This value is active only for first number type.<br />
* '''Number type''' – select more appropriate number format.<br />
* '''Invoice period start''' – when invoices are issued, default is first day of the month.<br />
* '''Show calls in detailed invoice''' – yes or no.<br />
* '''[[Outstanding balance(Debt) | Show balance line]]''' – shows balance line in Invoice PDF files when Invoice is generated from first day of month till last one. <br />
* '''Round finals to 2 decimals''' – round or not total in Invoices to 2 decimals.<br />
* '''Use short file name'''<br />
* '''Invoice Page Limit:''' – invoice will be generated till this page limit. Additional page is added with an explanation that page limit was reached. <br />
<br><br><br />
<br />
=== Details ===<br />
<br />
* '''Address format''' – changes field positioning in the invoice for the address. You must select it in order to show address in the invoice. <br />
* '''Address line 1-4''' – address info.<br />
* '''Bank details line 1-5''' – bank details info.<br />
* '''Invoice balance line''' – line for balance (e.g. "Your current balance is")<br />
* '''Invoice to pay Line'''<br />
* '''End title''' – a title for the end of your invoice.<br />
<!---This functionality is available from MOR 12---><br />
* '''Add Average rate in detailed invoice''' – adds average rate in detailed invoice.<br />
* '''Show Time in Minute''' – shows time in mm:ss instead of hh:mm:ss, for example, not 02:13:42 but 133:42.<br />
<br><br><br />
<br />
=== Additional ===<br />
<br />
* '''Show additional details on separate page''' – enables additional custom page at the end of the invoice.<br />
* '''Additional details''' – the information to be displayed in a custom page at the end of the invoice.<br />
<br><br><br />
=== Functionality ===<br />
<br />
* '''Invoice allow recalculate after send''' – allows recalculating invoices after being sent.<br />
<br><br><br />
===See also===<br />
<br />
* [[Invoices]]<br />
* [[Invoice configuration]]<br />
* [[Invoices (MOR X6)]]<br />
<br><br><br />
<br />
== Emails ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Emails'''<br />
<br />
* ''' Sending globally enabled''' – if this is checked, you will be able to use Mass Mailing and the system will send emails upon user registration.<br />
* '''SMTP server''' – hostname of the server.<br />
* '''Port''' – port of SMTP server.<br />
* '''Login''' – username to your SMTP server.<br />
* '''Password''' – password to your SMTP server.<br />
* '''Batch size''' – value for Mass Mailing, or how many emails to send at once.<br />
* '''From''' – email address to put into From: field in email. It is required to fill in(correctly) this field if email sending is enabled.<br />
* '''Test email sending''' – save settings and press this to test email sending. Do not forget to save settings first!<br />
<br />
'''P.S. Remember to set admin's e-mail in admin's personal settings. Without this test email sending will not work!'''<br />
<br />
<br><br><br />
===See also===<br />
<br />
* [[Emails|Mass Emails]]<br />
* [[Email variables]]<br />
<br><br><br />
== Various ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Various'''<br />
<br />
* '''Days for DID to close''' – how long to keep DID closed before making it free.<br />
* '''Agreement number length''' – number length in digits.<br />
* '''Change dahdi''' – Sometimes this is used to change "Zap" to something else in GUI, e.g. to "PSTN", mainly because not everybody knows what Zap stands for. PSTN is more common.<br />
* '''Device PIN length''' – length for automatically generated PIN codes for devices.<br />
* '''Device range MIN''' – from which extension automatic extension assigning starts.<br />
* '''Device range MAX''' – till which extension automatic extension assigning goes.<br />
** For example, from this interval: [Device range MIN, Device range MAX] MOR will select extensions for newly created Devices.<br />
* '''Enable "Allowed addresses" option for Devices:''' – allows [[Device_settings#Allowed_Addresses | Allowed Addresses]] functionality in Devices settings.<br />
* '''Enable "Allowed addresses" option for Providers:''' – allows Allowed Addresses functionality in Providers settings.<br />
* '''User wholesale tariff enabled''' – enables user wholesale tariffs.<br />
* '''Play IVR for unauthenticated call'''<br />
* '''Banned CLIs default IVR''' – default IVR to route banned numbers.<br />
* '''Do not allow duplicate device user names'''<br />
* '''Do not allow users to change their email addresses'''<br />
* '''Allow short passwords in devices'''<br />
* '''Logout link''' – a user will be redirected to this link after pressing "Logout"<br />
* '''Change ANSWER to FAILED if HGC not equal to 16 for Users''' – changes the Hangupcause for users in call reports from Answered to Failed if Hangupcause is not 16.<br />
* '''Inform when Devices are created or updated''' – check to get email about every newly created or updated Device. <br />
* '''Show Usernames on PDF/CSV Export Files in Last Calls''' – if checked, when particular User in Last Calls page search is selected, Last Calls PDF/CSV file name will be composed also from Name of selected User. If you are looking for All Users, no User Name will be used. (Name of User will be shown in Name of CSV/PDF file).<br />
* '''Do not allow PREPAID User balance drop below zero (block them instead)'''<br />
<!---from X5---><br />
* '''Do not block POSTPAID User when balance goes bellow zero on subscription count'''<br />
* '''Allow identical email addresses to different Users''' – allows to create Users or Register users with identical email addresses. After checking this setting you will be not able to check '''Show forgot password''', because this functionality require unique email in all system. Setting can be unchecked if all emails are unique in system. <br />
* '''Allow same IP and Port combinations in multiple Devices''' – allows to create Devices with the same IP and Port combination.<br />
* '''Server free space limit''' – indicator when system should inform admin about low [[Multi_Server_support|server]] space. By default 20%. Notice will appear in [[Integrity Check]] and every hour will be send an email "Server low free space" template which can be found and edited in [[Emails]] page. Default email template for low disk space: "Some of your Servers exceeded free space limit, please investigate."<br />
<br><br><br />
<br />
== Tax ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Tax'''<br />
<br />
Settings are explained here: [[Multi-Tax system]]<br />
<br><br><br />
== Backups ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Backups'''<br />
<br />
Configuration is explained here: [[Backup system]]<br />
<br><br><br />
== API ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> API'''<br />
<br />
* '''Allow API''' – enable/disable API.<br />
* '''Allow GET API''' – enable/disable GET in API - use only for testing!<br />
* '''API Secret Key''' – secret key for API. This will be used as a password for signing queries to MOR API, check [[MOR_API | MOR API documentation]] for more information<br />
* '''XML API Extension''' – .NET does not follow standards (surprise!); enable this setting if you are using it to get XML starting with HTTP tags.<br />
* '''Allow API Login Redirect''' – enable/disable<br />
* '''API allow registration''' – enable/disable registration through API<br />
* '''API allow Payments''' – enable/disable payments through API<br />
* '''API Payment confirmation''' – enable/disable payments confirmation through API<br />
* '''[[Balance_in_phone|Allow devices to check balance over HTTP]]''' – enable/disable device balance checking<br />
* '''[[MOR_API_rate_get|Allow devices to check rate over HTTP]]''' – enable/disable device rate checking<br />
* '''Disable hash checking''' – lets you skip hash parameter using API<br />
* '''Uniquehash''' – shows your uniquehash <br />
<br><br><br />
===See also===<br />
<br />
[[MOR API]]<br />
<br><br><br />
<br />
== Functionality ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Functionality'''<br />
<br><br><br />
===FAX===<br />
<br />
* '''Fax device enabled''' – enable/disable Fax device in MOR. When admin enables FAX, Functionality tab appears in Reseller's GUI configuration. He can then enable or disabled fax for his own users himself. <br />
* '''Fax2Email From Sender''' – there is a field "From:" in an email form. When MOR sends Fax to Email, "Fax2Email From Sender" value is displayed in "From:" field.<br />
<br><br><br />
<br />
===CSV===<br />
<br />
* '''CSV Column Separator''' – how columns are separated in imported/exported CSV files.<br />
* '''CSV Decimal Separator''' – how decimal parts in numbers are separated in imported/exported CSV files.<br />
* ''' Archive CSV file when size reaches''' – if CSV file reaches a certain size, the system will archive it to save time to download it (0 means to archive always)<br />
<br><br><br />
===Active Calls===<br />
<br />
* '''How many maximum [[Active_Calls|Active Calls]] to show in GUI''' – how many [[Active_Calls| Active Calls]] to show in GUI<br />
* '''[[Active_Calls| Active Calls]] refresh interval''' – [[Active_Calls|Active Calls]] refresh interval in seconds<br />
* '''Show [[Active_Calls|Active Calls]] for Users''' – tick if you want to allow users to see [[Active_Calls|Active Calls]]<br />
* '''Show Servers in [[Active_Calls|Active Calls]]'''<br />
* '''Show DIDs in [[Active_Calls|Active Calls]]'''<br />
<br><br><br />
<br />
===Tariffs/Rates===<br />
<br />
* '''Show rates for users''' – allows users to see rates<br />
* '''Show rates without Tax''' – shows rates without TAX<br />
* '''Show [[Advanced_Rates|Advanced Rates]] for users''' – allows users to see [[Advanced_Rates|Advanced Rates]]<br />
* '''Show zero rates in LCR tariff export:''' – shows zero rates in LCR tariff exported file.<br />
NOTE: if [[Custom Rates]] and/or Tariff Rates are set for the user, only the custom rates will be shown in the details of destination rates. <br />
<br><br><br />
<br />
==Privacy==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Privacy'''<br />
<br />
Settings are explained here: [[Privacy_to_hide_Destination_ends|Privacy to hide Destination ends]]<br />
<br><br><br />
== Visual ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Visual'''<br />
<br />
* '''Items per page''' – the number of items to display per one page<br />
* '''[[Global_date_format| Default date format]]''' – System default date format<br />
* '''Default Time Format''' – System default time format<br />
* '''Number digits''' – how many digits to display after a comma<br />
* '''Hide Quick Stats in Start page''' – hide Quick stats from start page<br />
* '''Hide device passwords for users''' – do not display device passwords for users<br />
* '''Hide HELP banner''' – hide HELP banner in GUI<br />
* '''Hide "I want to" help links'''<br />
* '''[[Remove_Manual_link_from_admin_GUI|Hide "Manual" link]]''' – hides "Manual" link<br />
* '''Show logo on first page''' - untick to hide logo on the start page<br />
* '''Show Full Source (CallerID Name and Number)'''<br />
* '''Hide payment options for postpaid users''' - will hide the payment option for all postpaid users (including Resellers if they are postpaid).<br />
* '''Hide non-completed payments for user''' – hides non-completed payments (the ones which are started in MOR, but are not completed in a payment gateway website)<br />
* '''Show only main page''' – this is a very advanced feature for those who want to hide default MOR menu tree on the left so that they could build their own menu using advanced techniques without modifying MOR GUI sources.<br />
* '''Show forgot password''' – turns on '''[[MOR_forgot_user_password | Forgot password]]''' functionality.<br />
* '''Hide Recordings for all users''' – hides recordings for all system users from menu and device settings.<br />
* '''Show recordings with zero billsec''' – shows recordings with zero billsec<br />
* '''[[Last_Calls#Faster_Page_Loading|Count Last Calls total values only after click]]''' – select to load Total Values lines separately in order to dramatically improve Last calls and Old calls loading time. <br />
* '''Default Number Decimal''' – with this option you can set default number decimal for all GUI<br />
* '''Show user_billsec for Users instead of billsec''' – shows user_billsec instead of billsec in Users invoices and last calls. Notice that Billsec shows real Call duration, user_billsec shows Call duration after minimal time or increment applied. For example, if user tariff has 60 sec minimal time and user made a Call for 20 sec, then billsec will show 20 sec and user_billsec will show 60 sec (minimal time is applied).<br />
<!--- from X5---><br />
* '''Show Calls statistics to User for last''' – number of Calls statistics to show in days. For example, if you enter 5 days, users will only see 5 days old calls, they will not be able to check older calls. <br />
* '''Show Device and it's CallerID in Last Calls''' – shows additional column in [[Last Calls]] page with Device and its CallerID information. Click to reach that Device settings page. <br />
<br><br><br />
<br />
== Server load ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Server load'''<br />
<br><br><br />
Settings for GUI Server and Database Server<br />
<br />
* '''HDD utilisation higher than''' – Percentage of CPU time during which I/O requests were issued to the device (bandwidth utilization for the device).<br />
* '''CPU General Load higher than''' – CPU General load higher than – Percentage of the CPU for user processes.<br />
* '''CPU Load Stats 1 higher than''' – average load per one minute on the system<br />
* '''CPU MySQL process higher than''' – Percentage of the CPU for MySQL process<br />
* '''CPU Ruby process higher than''' – Percentage of the CPU for Ruby process<br />
* '''CPU Asterisk process (if present) higher than''' – Percentage of the CPU for Asterisk process<br />
<br><br />
* '''Delete Server Load Stats older than''' – deletes internal servers load statistics older than defined number of days.<br />
<br><br />
<br />
== Calls ==<br />
<br />
'''SETTINGS –> Setup –> Settings –> Calls'''<br />
<br><br><br />
[[Archived calls]]<br />
<br><br />
<br />
=See also=<br />
<br />
* [[Server is overloaded]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=LCR&diff=20504LCR2016-01-07T10:54:48Z<p>Aisteb: /* Additional Configuration */</p>
<hr />
<div>=Description=<br />
<br />
LCR (Least Cost Routing) is a set of Providers that should be used to send a call when trying to dial any destination - for example, by the cheapest rate. <br />
<br />
The correct name for such a function is a Routing Table, because the function supports other ways of routing, not just finding the cheapest route.<br />
<br />
By default LCR supports fail-over. That is, if one provider fails, the next one is dialed. This is completely invisible for the caller and lets you increase the chances of the user reaching his destination. If one Provider is not capable of delivering a call, the system will try to use the remaining [[How_to_add_Provider_to_LCR | Providers]].<br />
<br><br><br />
==Fail-over explanation==<br />
<br />
With such configuration:<br />
<br><br><br />
[[image:lcr_fo_case1.png]]<br />
<br><br><br />
System will do following:<br />
<br />
* system tries to use "Kolmisoft PREMIUM";<br />
<br />
* if above fails, system tries to use "Kolmisoft STANDARD";<br />
<br />
* end.<br />
<br><br><br />
With such configuration:<br />
<br><br><br />
[[image:lcr_fo_case2.png]]<br />
<br><br><br />
System will do following:<br />
* system tries to use "Kolmisoft PREMIUM";<br />
<br />
* end.<br />
<br><br><br />
With such configuration:<br />
<br><br><br />
[[image:lcr_fo_case3.png]]<br />
<br><br><br />
System will do following:<br />
* system tries to use "Kolmisoft PREMIUM";<br />
<br />
* if above fails, system tries to use "Kolmisoft STANDARD";<br />
<br />
* if above fails, system tries to use provider "112" even if its rate is higher than User rate;<br />
<br />
* end.<br />
<br><br><br />
=Usage=<br />
<br />
Go to '''SETTINGS –> Billing –> LCR'''<br />
<br><br><br />
[[File:lcr_path.png]]<br />
<br><br><br />
Here you can see the list off all LCRs<br />
<br><br><br />
[[File:lcr_main.png]]<br />
<br><br><br />
* Name – name of LCR.<br />
* Order – type of routing mode.<br />
* Providers – quantity of providers in LCR. Click on it to [[How_to_add_Provider_to_LCR | Add Providers to LCR]]<br />
* [[Call_routing_per_destination_basis | By destination]]<br />
* Usage Details – the list of Users and Card Groups where this LCR is used.<br />
* [[LCR make tariff | Make Tariff from LCR Providers to CSV]] – feature that gets you a CSV with the MIN/MAX prices selected from the list of Providers in LCR. Click on the [[Image:excel.png]] icon and the download should start automatically. (De-activated provider will be taken into CSV. "by Destination" will not be taken into CSV)<br />
* LCR copy – press on icon to make LCR copy.<br />
<br><br><br />
==Supported routing modes==<br />
<br />
* [[Call Routing by price|By Price]] - cheapest first (Least Cost Routing).<br />
* [[Call Routing by priority (Manual LCR) | By priority]].<br />
* [[Routing by Percent| By percent]] or Weight-based routing.<br />
<br />
The user has one base LCR, so that all his calls are routed by some preset rule.<br />
<br />
It is possible to route different destinations for a User using [[Call routing per destination basis]].<br />
<br><br><br />
==Creation==<br />
Press [[Image:icon_add.png]]'''New LCR''' to create LCR.<br />
<br><br><br />
=== VIDEO: How to create LCR ===<br />
<br />
<html><br />
<iframe width="640" height="360" src="http://www.youtube.com/embed/7sCaBH35hXc" frameborder="0"></iframe> <br />
</html><br />
<br />
<br><br><br />
==Additional Configuration==<br />
<br />
Go to LCRs list and press [[image:icon_edit.png]] icon. <br />
<br><br><br />
[[File:lcr_time_periods.png]]<br />
<br><br><br />
'''First Providers percent limit''' - visable when order by Price is selected. If following Providers will have higher price by this percent compared to first Provider, these Providers will be skipped. 0 value disables use of this setting.<br><br />
'''Minimal Rate Margin Percent''' - use only those Providers which generate profit (per minute) equal or higher than defined percentage value in this field. For example, if you pay to your Provider 1 EUR/min and your Minimal Rate Margin Percent is set to 50%, then only calls with user rate equal or higher than 1.5 EUR/min are allowed to call. After 1 min of call, you will pay 1 EUR to you provider and user will pay you 1.5 EUR. Your profit will be 0.5 EUR which is 50% more of what you paid to your Provider. If you Minimal Rate Margin is -30%, then you allow some losses in your calls. If you pay 1 EUR to your Provider after 1 minute of call, then user should pay you 0.7 EUR or more. You will pay 1 EUR and you will get 0.7 EUR which is 30% less of what you paid.<br />
<br><br><br />
===LCR Time Periods===<br />
<!---This functionality is available from MOR X4---><br />
Sometimes there is such demand to change LCR for some time period. This functionality gives you an ability to do that. In LCR edit page time periods can be set. <br />
<br />
Time period defines the exact time period LCR will be active. There is a limit of five periods in one LCR. Rest of the time will be used main LCR.<br />
<br><br><br />
'''Examples'''<br />
<br />
# Select '''Date''' from 1 of January to 28 of February and choose '''Hour : Minute''' from 09:00 to 18:59. Selected LCR will be used from 1 of January till 28 of February at time from 09:00 till 18:59.<br />
# Select just '''Hour : Minute''' from 19:00 to 08:59 and selected LCR will be used every day at time from 19:00 till 08:59.<br />
# Select '''Weekday''' from Monday to Friday and choose '''Hour : Minute''' from 13:00 to 15:59. Selected LCR will be used every week from Monday till Friday at time from 13:00 till 15:59.<br />
<br><br><br />
<br />
==Copying LCRs between resellers==<br />
<!---This functionality is available from MOR 12---><br />
Sometimes you need to make a LCR which takes quite a long time to make. If you have made a similar one before you can just copy it and change appropriate details. <br />
<br />
Go to '''SETTINGS''' -> '''Billing''' -> '''LCR''' -> '''Copy LCR'''<br />
<br><br><br />
[[File:lcr_copy_path.png]]<br />
<br><br><br />
You will see this window:<br />
<br><br><br />
[[File:lcr_copy.png]]<br />
<br><br><br />
Choose ''Original LCR reseller'' and ''Cloned LCR reseller'' and click ''Clone'' button.<br />
<br />
Please note that LCR will not be allowed to copy if reseller B is not allowed to use Providers which are used by Reseller A.<br />
<br><br><br />
=See also=<br />
<br />
* [[LCR Logic]]<br />
* [[How to add Provider to LCR]]<br />
* [[Call Routing by price]]<br />
* [[Call Routing by priority (Manual LCR) | Call Routing by priority ]]<br />
* [[Routing by Percent | Call Routing by percent]] or Weight-based routing<br />
* [[Call routing per destination basis]]<br />
* [[LCR/Tariff change based on call prefix]]<br />
* [[Why call was not routed through other provider/trunk?|Why was a call not routed through another provider/trunk?]]<br />
* [[LCR_make_tariff|Make Tariff from LCR Providers to CSV]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=LCR&diff=20503LCR2016-01-07T10:54:31Z<p>Aisteb: /* Additional Configuration */</p>
<hr />
<div>=Description=<br />
<br />
LCR (Least Cost Routing) is a set of Providers that should be used to send a call when trying to dial any destination - for example, by the cheapest rate. <br />
<br />
The correct name for such a function is a Routing Table, because the function supports other ways of routing, not just finding the cheapest route.<br />
<br />
By default LCR supports fail-over. That is, if one provider fails, the next one is dialed. This is completely invisible for the caller and lets you increase the chances of the user reaching his destination. If one Provider is not capable of delivering a call, the system will try to use the remaining [[How_to_add_Provider_to_LCR | Providers]].<br />
<br><br><br />
==Fail-over explanation==<br />
<br />
With such configuration:<br />
<br><br><br />
[[image:lcr_fo_case1.png]]<br />
<br><br><br />
System will do following:<br />
<br />
* system tries to use "Kolmisoft PREMIUM";<br />
<br />
* if above fails, system tries to use "Kolmisoft STANDARD";<br />
<br />
* end.<br />
<br><br><br />
With such configuration:<br />
<br><br><br />
[[image:lcr_fo_case2.png]]<br />
<br><br><br />
System will do following:<br />
* system tries to use "Kolmisoft PREMIUM";<br />
<br />
* end.<br />
<br><br><br />
With such configuration:<br />
<br><br><br />
[[image:lcr_fo_case3.png]]<br />
<br><br><br />
System will do following:<br />
* system tries to use "Kolmisoft PREMIUM";<br />
<br />
* if above fails, system tries to use "Kolmisoft STANDARD";<br />
<br />
* if above fails, system tries to use provider "112" even if its rate is higher than User rate;<br />
<br />
* end.<br />
<br><br><br />
=Usage=<br />
<br />
Go to '''SETTINGS –> Billing –> LCR'''<br />
<br><br><br />
[[File:lcr_path.png]]<br />
<br><br><br />
Here you can see the list off all LCRs<br />
<br><br><br />
[[File:lcr_main.png]]<br />
<br><br><br />
* Name – name of LCR.<br />
* Order – type of routing mode.<br />
* Providers – quantity of providers in LCR. Click on it to [[How_to_add_Provider_to_LCR | Add Providers to LCR]]<br />
* [[Call_routing_per_destination_basis | By destination]]<br />
* Usage Details – the list of Users and Card Groups where this LCR is used.<br />
* [[LCR make tariff | Make Tariff from LCR Providers to CSV]] – feature that gets you a CSV with the MIN/MAX prices selected from the list of Providers in LCR. Click on the [[Image:excel.png]] icon and the download should start automatically. (De-activated provider will be taken into CSV. "by Destination" will not be taken into CSV)<br />
* LCR copy – press on icon to make LCR copy.<br />
<br><br><br />
==Supported routing modes==<br />
<br />
* [[Call Routing by price|By Price]] - cheapest first (Least Cost Routing).<br />
* [[Call Routing by priority (Manual LCR) | By priority]].<br />
* [[Routing by Percent| By percent]] or Weight-based routing.<br />
<br />
The user has one base LCR, so that all his calls are routed by some preset rule.<br />
<br />
It is possible to route different destinations for a User using [[Call routing per destination basis]].<br />
<br><br><br />
==Creation==<br />
Press [[Image:icon_add.png]]'''New LCR''' to create LCR.<br />
<br><br><br />
=== VIDEO: How to create LCR ===<br />
<br />
<html><br />
<iframe width="640" height="360" src="http://www.youtube.com/embed/7sCaBH35hXc" frameborder="0"></iframe> <br />
</html><br />
<br />
<br><br><br />
==Additional Configuration==<br />
<br />
Go to LCRs list and press [[image:icon_edit.png]] icon. <br />
<br><br><br />
[[File:lcr_time_periods.png]]<br />
<br><br><br />
'''First Providers percent limit''' - visable when order by Price is selected. If following Providers will have higher price by this percent compared to first Provider, these Providers will be skipped. 0 value disables use of this setting. ', WIDTH, -600, TITLE, 'First Providers percent limit.<br><br />
'''Minimal Rate Margin Percent''' - use only those Providers which generate profit (per minute) equal or higher than defined percentage value in this field. For example, if you pay to your Provider 1 EUR/min and your Minimal Rate Margin Percent is set to 50%, then only calls with user rate equal or higher than 1.5 EUR/min are allowed to call. After 1 min of call, you will pay 1 EUR to you provider and user will pay you 1.5 EUR. Your profit will be 0.5 EUR which is 50% more of what you paid to your Provider. If you Minimal Rate Margin is -30%, then you allow some losses in your calls. If you pay 1 EUR to your Provider after 1 minute of call, then user should pay you 0.7 EUR or more. You will pay 1 EUR and you will get 0.7 EUR which is 30% less of what you paid.<br />
<br><br><br />
===LCR Time Periods===<br />
<!---This functionality is available from MOR X4---><br />
Sometimes there is such demand to change LCR for some time period. This functionality gives you an ability to do that. In LCR edit page time periods can be set. <br />
<br />
Time period defines the exact time period LCR will be active. There is a limit of five periods in one LCR. Rest of the time will be used main LCR.<br />
<br><br><br />
'''Examples'''<br />
<br />
# Select '''Date''' from 1 of January to 28 of February and choose '''Hour : Minute''' from 09:00 to 18:59. Selected LCR will be used from 1 of January till 28 of February at time from 09:00 till 18:59.<br />
# Select just '''Hour : Minute''' from 19:00 to 08:59 and selected LCR will be used every day at time from 19:00 till 08:59.<br />
# Select '''Weekday''' from Monday to Friday and choose '''Hour : Minute''' from 13:00 to 15:59. Selected LCR will be used every week from Monday till Friday at time from 13:00 till 15:59.<br />
<br><br><br />
<br />
==Copying LCRs between resellers==<br />
<!---This functionality is available from MOR 12---><br />
Sometimes you need to make a LCR which takes quite a long time to make. If you have made a similar one before you can just copy it and change appropriate details. <br />
<br />
Go to '''SETTINGS''' -> '''Billing''' -> '''LCR''' -> '''Copy LCR'''<br />
<br><br><br />
[[File:lcr_copy_path.png]]<br />
<br><br><br />
You will see this window:<br />
<br><br><br />
[[File:lcr_copy.png]]<br />
<br><br><br />
Choose ''Original LCR reseller'' and ''Cloned LCR reseller'' and click ''Clone'' button.<br />
<br />
Please note that LCR will not be allowed to copy if reseller B is not allowed to use Providers which are used by Reseller A.<br />
<br><br><br />
=See also=<br />
<br />
* [[LCR Logic]]<br />
* [[How to add Provider to LCR]]<br />
* [[Call Routing by price]]<br />
* [[Call Routing by priority (Manual LCR) | Call Routing by priority ]]<br />
* [[Routing by Percent | Call Routing by percent]] or Weight-based routing<br />
* [[Call routing per destination basis]]<br />
* [[LCR/Tariff change based on call prefix]]<br />
* [[Why call was not routed through other provider/trunk?|Why was a call not routed through another provider/trunk?]]<br />
* [[LCR_make_tariff|Make Tariff from LCR Providers to CSV]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=LCR&diff=20502LCR2016-01-07T10:54:18Z<p>Aisteb: </p>
<hr />
<div>=Description=<br />
<br />
LCR (Least Cost Routing) is a set of Providers that should be used to send a call when trying to dial any destination - for example, by the cheapest rate. <br />
<br />
The correct name for such a function is a Routing Table, because the function supports other ways of routing, not just finding the cheapest route.<br />
<br />
By default LCR supports fail-over. That is, if one provider fails, the next one is dialed. This is completely invisible for the caller and lets you increase the chances of the user reaching his destination. If one Provider is not capable of delivering a call, the system will try to use the remaining [[How_to_add_Provider_to_LCR | Providers]].<br />
<br><br><br />
==Fail-over explanation==<br />
<br />
With such configuration:<br />
<br><br><br />
[[image:lcr_fo_case1.png]]<br />
<br><br><br />
System will do following:<br />
<br />
* system tries to use "Kolmisoft PREMIUM";<br />
<br />
* if above fails, system tries to use "Kolmisoft STANDARD";<br />
<br />
* end.<br />
<br><br><br />
With such configuration:<br />
<br><br><br />
[[image:lcr_fo_case2.png]]<br />
<br><br><br />
System will do following:<br />
* system tries to use "Kolmisoft PREMIUM";<br />
<br />
* end.<br />
<br><br><br />
With such configuration:<br />
<br><br><br />
[[image:lcr_fo_case3.png]]<br />
<br><br><br />
System will do following:<br />
* system tries to use "Kolmisoft PREMIUM";<br />
<br />
* if above fails, system tries to use "Kolmisoft STANDARD";<br />
<br />
* if above fails, system tries to use provider "112" even if its rate is higher than User rate;<br />
<br />
* end.<br />
<br><br><br />
=Usage=<br />
<br />
Go to '''SETTINGS –> Billing –> LCR'''<br />
<br><br><br />
[[File:lcr_path.png]]<br />
<br><br><br />
Here you can see the list off all LCRs<br />
<br><br><br />
[[File:lcr_main.png]]<br />
<br><br><br />
* Name – name of LCR.<br />
* Order – type of routing mode.<br />
* Providers – quantity of providers in LCR. Click on it to [[How_to_add_Provider_to_LCR | Add Providers to LCR]]<br />
* [[Call_routing_per_destination_basis | By destination]]<br />
* Usage Details – the list of Users and Card Groups where this LCR is used.<br />
* [[LCR make tariff | Make Tariff from LCR Providers to CSV]] – feature that gets you a CSV with the MIN/MAX prices selected from the list of Providers in LCR. Click on the [[Image:excel.png]] icon and the download should start automatically. (De-activated provider will be taken into CSV. "by Destination" will not be taken into CSV)<br />
* LCR copy – press on icon to make LCR copy.<br />
<br><br><br />
==Supported routing modes==<br />
<br />
* [[Call Routing by price|By Price]] - cheapest first (Least Cost Routing).<br />
* [[Call Routing by priority (Manual LCR) | By priority]].<br />
* [[Routing by Percent| By percent]] or Weight-based routing.<br />
<br />
The user has one base LCR, so that all his calls are routed by some preset rule.<br />
<br />
It is possible to route different destinations for a User using [[Call routing per destination basis]].<br />
<br><br><br />
==Creation==<br />
Press [[Image:icon_add.png]]'''New LCR''' to create LCR.<br />
<br><br><br />
=== VIDEO: How to create LCR ===<br />
<br />
<html><br />
<iframe width="640" height="360" src="http://www.youtube.com/embed/7sCaBH35hXc" frameborder="0"></iframe> <br />
</html><br />
<br />
<br><br><br />
==Additional Configuration==<br />
<br />
Go to LCRs list and press [[image:icon_edit.png]] icon. <br />
<br><br><br />
[[File:lcr_time_periods.png]]<br />
<br><br><br />
'''First Providers percent limit''' - visable when order by Price is selected. If following Providers will have higher price by this percent compared to first Provider, these Providers will be skipped. 0 value disables use of this setting. ', WIDTH, -600, TITLE, 'First Providers percent limit.<br />
'''Minimal Rate Margin Percent''' - use only those Providers which generate profit (per minute) equal or higher than defined percentage value in this field. For example, if you pay to your Provider 1 EUR/min and your Minimal Rate Margin Percent is set to 50%, then only calls with user rate equal or higher than 1.5 EUR/min are allowed to call. After 1 min of call, you will pay 1 EUR to you provider and user will pay you 1.5 EUR. Your profit will be 0.5 EUR which is 50% more of what you paid to your Provider. If you Minimal Rate Margin is -30%, then you allow some losses in your calls. If you pay 1 EUR to your Provider after 1 minute of call, then user should pay you 0.7 EUR or more. You will pay 1 EUR and you will get 0.7 EUR which is 30% less of what you paid.<br />
<br><br><br />
===LCR Time Periods===<br />
<!---This functionality is available from MOR X4---><br />
Sometimes there is such demand to change LCR for some time period. This functionality gives you an ability to do that. In LCR edit page time periods can be set. <br />
<br />
Time period defines the exact time period LCR will be active. There is a limit of five periods in one LCR. Rest of the time will be used main LCR.<br />
<br><br><br />
'''Examples'''<br />
<br />
# Select '''Date''' from 1 of January to 28 of February and choose '''Hour : Minute''' from 09:00 to 18:59. Selected LCR will be used from 1 of January till 28 of February at time from 09:00 till 18:59.<br />
# Select just '''Hour : Minute''' from 19:00 to 08:59 and selected LCR will be used every day at time from 19:00 till 08:59.<br />
# Select '''Weekday''' from Monday to Friday and choose '''Hour : Minute''' from 13:00 to 15:59. Selected LCR will be used every week from Monday till Friday at time from 13:00 till 15:59.<br />
<br><br><br />
==Copying LCRs between resellers==<br />
<!---This functionality is available from MOR 12---><br />
Sometimes you need to make a LCR which takes quite a long time to make. If you have made a similar one before you can just copy it and change appropriate details. <br />
<br />
Go to '''SETTINGS''' -> '''Billing''' -> '''LCR''' -> '''Copy LCR'''<br />
<br><br><br />
[[File:lcr_copy_path.png]]<br />
<br><br><br />
You will see this window:<br />
<br><br><br />
[[File:lcr_copy.png]]<br />
<br><br><br />
Choose ''Original LCR reseller'' and ''Cloned LCR reseller'' and click ''Clone'' button.<br />
<br />
Please note that LCR will not be allowed to copy if reseller B is not allowed to use Providers which are used by Reseller A.<br />
<br><br><br />
=See also=<br />
<br />
* [[LCR Logic]]<br />
* [[How to add Provider to LCR]]<br />
* [[Call Routing by price]]<br />
* [[Call Routing by priority (Manual LCR) | Call Routing by priority ]]<br />
* [[Routing by Percent | Call Routing by percent]] or Weight-based routing<br />
* [[Call routing per destination basis]]<br />
* [[LCR/Tariff change based on call prefix]]<br />
* [[Why call was not routed through other provider/trunk?|Why was a call not routed through another provider/trunk?]]<br />
* [[LCR_make_tariff|Make Tariff from LCR Providers to CSV]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:Lcr_fo_case3.png&diff=20501File:Lcr fo case3.png2016-01-07T10:42:29Z<p>Aisteb: uploaded a new version of "File:Lcr fo case3.png"</p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:Lcr_fo_case2.png&diff=20500File:Lcr fo case2.png2016-01-07T10:42:15Z<p>Aisteb: uploaded a new version of "File:Lcr fo case2.png"</p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:Lcr_fo_case1.png&diff=20499File:Lcr fo case1.png2016-01-07T10:41:54Z<p>Aisteb: uploaded a new version of "File:Lcr fo case1.png"</p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=File:Lcr_time_periods.png&diff=20498File:Lcr time periods.png2016-01-07T10:31:29Z<p>Aisteb: uploaded a new version of "File:Lcr time periods.png"</p>
<hr />
<div></div>Aistebhttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20341MOR API2015-12-01T15:58:51Z<p>Aisteb: /* Device */</p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[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.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.<br />
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.<br />
* [[MOR_API_Calling_Cards_get| calling_cards_get]] - get Calling Cards.<br />
* [[MOR_API_Card_Group_create| cc_group_create]] – create Card Group.<br />
* [[MOR_API_Card_Group_update| cc_group_update]] – update Card Group.<br />
* [[MOR API Card Groups get| cc_groups_get]] – show Calling Cards Group info.<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
<br><br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
<br><br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20340MOR API2015-12-01T15:57:57Z<p>Aisteb: /* Device */</p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[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.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.<br />
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.<br />
* [[MOR_API_Calling_Cards_get| calling_cards_get]] - get Calling Cards.<br />
* [[MOR_API_Card_Group_create| cc_group_create]] – create Card Group.<br />
* [[MOR_API_Card_Group_update| cc_group_update]] – update Card Group.<br />
* [[MOR API Card Groups get| cc_groups_get]] – show Calling Cards Group info.<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
<br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Aistebhttps://wiki.kolmisoft.com/index.php?title=M4_Users&diff=20331M4 Users2015-11-17T11:51:29Z<p>Aisteb: /* General */</p>
<hr />
<div>=Where to find user details?=<br />
<br />
Go to '''SETTINGS –> Users'''<br />
<br />
Here you can see list of all users. <br />
<br />
Select the [[image:icon_edit.png]] icon in window above and you will reach personal User settings page. In this window you will see a lot of options grouped into sections.<br />
<br />
<!---This functionality is available from MOR X4---><br />
'''NOTE''' that admin is not shown in Users list. To see your own details go to '''PERSONAL MENU –> Details'''.<br />
<br><br><br />
<br />
= Details update = <br />
<br />
Every User can update his own details in '''PERSONAL MENU –> Details'''.<br><br><br />
To disallow users to change their details Admin/Reseller has to check setting "Do not allow users to change their Personal Details" in '''SETTINGS -> Setup -> Settings -> Various'''. After this User Details can only be updated by user's owner.<br><br><br />
'''NOTE''' that even if User is not allowed to update his own details, he still can see it in '''PERSONAL MENU –> Details''' as form with not editable options.<br />
<br><br><br />
= General =<br />
<br />
* '''Username''' – username for user to login to MOR GUI.<br />
* '''Password''' – password for user to login to MOR GUI.<br />
* '''[[Balance and Credit | Balance]]''' – the user's balance.<br />
* '''Balance range''' – minimal and maximal balance which User will be able to have.<br />
* '''[[Minimum contract billing | Minimal Charge for Calls]]''' – minimum charge user pays for voice calls.<br />
* '''[[Minimum contract billing | Minimal Charge for Calls Date]]''' – date since when the previous option is valid.<br />
* '''[[Hide Users | Not Hidden/Hidden]]''' – is this user hidden?<br />
* '''[[Simultaneous call limitation | Call Limit]]''' – how many simultaneous calls the user can make?<br />
* '''Default Currency''' – User's default Currency<br />
* '''Time Zone''' – User's native Time Zone<br />
* '''Responsible accountant''' – dropdown to choose accountant responsible for User's Profit. <br />
* '''PBX Pool''' – PBX pool assigned to User<br />
* '''Hide Non-Answered calls''' – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. <!-- veikia su x5_functionality_15 --> <br />
* '''Ignore Global Alerts''' – check and User will be ignored on checking for [[M2_Alerts | Alerts]]<br />
<br><br><br />
<br />
= Blocking =<br />
<br />
Various options for [[User Blocking]].<br />
<br><br><br />
= Warning Balance Email =<br />
<br />
If you want to get and email notification or send it to a User and Accountant (or take another action) when his balance drops lower than a certain amount, check this setting and enter the desired amount.<br />
<br />
More details: [[M2 Warning Balance | Warning Balance]]<br />
<br><br><br />
<br />
= Invoices =<br />
<br />
* '''Generate Invoice''' – should we generate Invoices for this User?<br />
* '''Billing Period''' – select period for which Invoice should be generated.<br />
* '''Grace Period''' – select period for which Invoice should be paid by User. For example, if you generate Invoice for January 1-31, and you set Grace Period 15 days, then User will see Due Date February 15 (15 days after Invoice period end).<br />
<br><br><br />
<br />
= Details =<br />
<br />
Self-explanatory.<br />
<br />
If Country of Taxation is in the EU, validation of TAX Registration Number will be checked from this website: http://ec.europa.eu/taxation_customs/vies/<br />
<br><br><br />
= Company Emails =<br />
<br />
Self-explanatory:<br />
<br />
* '''Main email'''<br />
* '''NOC email'''<br />
* '''Billing email'''<br />
* '''Rates email'''<br />
<br><br><br />
= Taxes =<br />
<br />
Here tax parameters are entered for the user.<br />
<br />
The tax system is explained [[Multi-Tax system | here]].<br />
<br><br><br />
= Registration Address =<br />
<br />
Self-explanatory.<br />
<br><br><br />
=Blacklists / Whitelists=<br />
<br />
'''Enable static Source''' - enables static Blacklist or Whitelist<br><br />
* '''No''' - do not use any Blacklist or Whitelist<br />
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from receiving specific Source numbers. If User receives number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''334 - Source number is in blacklist''<br />
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to receive only specific Source numbers. If User receives number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''335 - Source number is not in whitelist''<br />
<br />
'''Enable static Destination''' - enables static Blacklist or Whitelist<br><br />
* '''No''' - do not use any Blacklist or Whitelist<br />
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from calling specific Destination numbers. If User calls number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''325 - Destination is in blacklist''<br />
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to call only specific Destination numbers. If User calls number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''326 - Destination is not in whitelist''<br />
<br><br></div>Aisteb