Kolmisoft Wiki - User contributions [en]

Providers

2018-10-16T16:02:09Z

Robert: /* SIP Specific */

= Description =

In the old PSTN world, Providers were called Trunks. Providers are your route out of your VoIP network to the outside world.

Providers can be one of several types: ZAP, SIP, IAX2, and H323. The type determines which technology is used to connect to the Provider.

At the very start, you need to create a Provider through which you will dial out to PSTN or other VoIP networks.

Every Provider will charge you for calling a destination through his service (although the rate might be zero). The rate to every destination is different. Because of this, we need to have a Tariff (or Price List) for each Provider. This Tariff will tell our billing what price we will pay to a destination when using this Provider's services. In other words, this will be our Selfcost.
 
=Usage=

Go to '''SETTINGS –> Billing –> Providers'''.
 
[[File:providers_path.png]]
 
Here you can see a list of all Providers:
 
[[File:providers_list.png]]
 
* Click [[image:add.png]] '''New Provider''' to create new Provider, enter the Name for a new Provider, select its Technology, Tariff, Asterisk server which should be used for this provider and click Create.
* Click [[image:icon_edit.png]] icon to change settings for old Provider.

* Click [[Image:icon_check.png]] icon to disable Provider and it will not be used while it is cross in Active column. It affects only outgoing calls. Incoming calls from this provider will be accepted.
* Click [[Image:icon_cross.png]] icon to enable Provider if you want to use it again.
* Click [[Image:icon_vcard.png]] icon to access [[Provider Contact Info]].
NOTE:
* You can't create a new Provider if there are no Tariffs available for Providers.
* A Provider is also able to send calls, not just receive them. More info [[Configure Provider which can make calls | here]]. In case you want to sell services to a provider you have to create such a provider.
 
== Settings ==

=== General ===
 
[[File:Prov addon.png]]
 
* '''Name''' – a name for the provider, for informational purposes.
* '''Technology''' – out of SIP/IAX2/ZAP/H323, choose which technology your provider uses - that is, the way you connect to the provider.
* '''Tariff''' – the list of rates the provider charges you.
* '''DTMF Mode''' – the available options are inband, info, RFC2833, and auto. Choose the one used by your provider.
* '''Location''' – which Localization rules are set to apply to INCOMING calls COMING FROM this provider.
* '''Automatic Number Identification''' - used in a special case explained here: [[Provider with ANI]]
* '''Ringing Timeout''' – this setting lets you set for how long this provider should be dialed before giving up. The default value is 60 seconds, and the minimum value is 30 seconds.
* '''Call Timeout''' – this setting lets you set the duration of the whole call: ringing and the period after connection.
* '''Device ID''' – informational data.
* '''Call limit''' – explained here: [[Simultaneous call limitation]].
* '''Hidden?''' – [[Hide_provider|hide/unhide provider]]

* '''Balance''' – provider balance. Provider balance increases when calls are made via that provider. Currently it is not available to decrease provider's balance. You can read more about [[Provider Billing Addon|Provider Billing Addon here]].

* '''Balance limit''' – this is the limit of balance that can be reached by the provider. After he reaches the specified balance, calls aren't sent through this provider anymore. Balance limit value of zero means that balance is unlimited.
* '''Responsible Accountant''' – dropdown to choose Provider's responsible accountant.
 

=== Authentication ===

==== For ZAP providers ====

* '''Channel''' – which channel (or channel group) to use on a PRI/BRI/PSTN card. Channels and groups should be configured in zapata.conf.
 
==== For SIP/IAX2 providers ====

* '''Login''' – username if your provider asks for it.
* '''Password''' – password used for authentication by your provider (characters '''@ : /''' are not allowed when Register option is enabled)
* '''Authenticate by IP''' – just check the checkbox (Login/Password can be left empty).
** Make sure you put the correct Hostname/[[IP address]]!
* '''Register''' – should we register the provider? (option is not visible when '''Dynamic''' is selected in '''Network related''' section)
* '''Register extension''' – if the provider asks to use an extension for registration (usually they don't), enter it here.
 

=== Provider CallerID ===

'''CallerID''' – consists of two parts: Name and Number. The "Number" part is transferred by default on all technologies (GSM, PSTN, SIP etc), but the "Name" part only on some. The number you see on your mobile phone when someone is calling you is the "Number" part.
 
[[File:provider_callerid.png]]
 
* '''Name''' – the "Name" part of CallerID.
* '''Number''' – the "Number" part of CallerID.
* '''Random Number from Number Pool''' – the "Number" part of CallerID selected from [[Number Pool]]
.
'''NOTE:''' If you have this configured all incoming call from this provider will have that CallerID.
If you leave these fields empty, calls coming from this provider will have CallerID set by the Provider. It should almost always be this way.
 

=== Network related ===

* '''Hostname''' – hostname of the provider.
* '''Server IP''' – the provider's IP. The value can be "dynamic", which means that provider can change its IP. To discover this value, do ping to the provider's hostname. Use command "''dig +short''". Example ''dig +short google.com''.
* '''Port''' – port used to connect to the provider (default: 5060 for SIP, 4569 for IAX2, 1720 for H323).
 
====H323 specific network settings====

* '''Fast Start''' – an option specific to H323; it is either on or off.
* '''h245 Tunneling''' – an option specific to H323; it is either on or of
 
====SIP specific network settings====

* '''Media control''' – canreinvite/transfer. Do you want your server to stay in the media path between your clients and your provider? Disable if you have a lot of 1-second answered calls.
* '''NAT''' – the available options are: yes, no, never, and route. For a detailed explanation of these settings, refer to [http://www.voip-info.org/wiki-Asterisk+sip+nat here].
 
====IAX2 specific network settings====

* '''IAX2 Trunking Mode''' – enable/disable trunking mode, which allows multiple voice streams to share a single "trunk" to another server, reducing overhead created by IP packets. More details [http://wiki.kolmisoft.com/index.php/Trunks here]
 
====SIP and IAX2 specific network settings====

* '''Qualify''' – how often to "ask" the provider about availability. More details [http://www.voip-info.org/wiki/view/Asterisk+sip+qualify here] for SIP providers and [http://www.voip-info.org/wiki/view/Asterisk+iax+qualify here] for IAX2 providers.
 

=== Blacklist/Whitelist ===
 
[[File:MOR_provider_blacklist_whitelist.png]]
 
Enable static Source - enables a static Blacklist or a Whitelist.
* '''No''' - use neither a Blacklist nor a Whitelist.
* '''Blacklist''' - set a [[Number Pool]] which is used to block a Provider from receiving specific Source Numbers. When a Source Number (RPID and PAI headers included) is found within a selected [[Number Pool]] this Provider is skipped with a Hangupcause Code ''272''.
* '''Whitelist''' - set a [[Number Pool]] which is used to allow a Provider to receive only specific Source numbers. When a Source Number (RPID and PAI headers included) is NOT found within a selected [[Number Pool]] this Provider is skipped with a Hangupcause Code ''273''.
 

=== Servers ===
Allows to select on which Asterisk servers this provider should be used.
 
=== Codecs ===

Choose the codecs your provider uses.

NOTE: When no fields are checked, all codecs are available. ([[Image:asterisk_icon.png]] For example, settings in sip.conf or iax.conf are effective).

* '''Enforce same codec as on Leg A''' - this option takes effect only when Device/Provider is used as Terminator. When this option is enabled, system checks what codec is used on Leg A. Then if Leg A codec matches one of codec enabled on Codecs list, system enforces callee to use that codec, by offering only that single codec in SDP data.
 
=== Advanced ===

* '''Grace time''' – if call duration is less than Grace Time, it will not be accounted.
* Progressinband:
**yes – when "RING" event is requested, always send 180 Ringing (if it hasn't been sent yet) followed by 183 Session Progress and in-band audio.
**no – send 180 Ringing if 183 has not yet been sent, establishing an audio path. If the audio path is established already (with 183), then send in-band ringing (this is the way Asterisk historically behaved because of buggy phones like Polycom's).
**never – whenever ringing occurs, send "180 ringing" as long as "200 OK" has not yet been sent. This is the default behavior of Asterisk.
* '''Video support''' – does your provider support Video over IP? More info [http://www.voip-info.org/wiki/view/Asterisk+video here].
* '''[[Duplicate call prevention | Allow duplicate calls]]''' – the default setting is "no".
* '''Interpret NO ANSWER as FAILED''' – default option is no (This will change the provider in LCR like it is failed, in last calls you will see
the real hangupcause – no answer)
* '''Interpret BUSY as FAILED''' – default option is no (This will change the provider in LCR like it is failed, in last calls you will see
the real hangupcause – busy)
* '''Fake Ring''' – should system generate Fake Ring or not? Use only if your Device/Provider has bad protocol implementation and does not send RING signal properly.
* '''Common Use''' – Provider can be used by Resellers which are able to create their own Providers. Reseller will be billed using this Provider. If provider is marked as common use and is used in one of reseller's LCR or is in Terminators list - admin is not allowed to delete this provider or remove common use option.
* '''Anti-resale (Auto-answer)''' – when option is set to YES, MOR answers the call before sending it to provider in order to generate FAS. Work only when provider is the originator of the call. This option does not affect the billing.
* '''Transport''' – lets you choose protocol <nowiki>[tcp, udp]</nowiki> for data transfer. Appears only if Provider is SIP and when Asterisk 1.8 is enabled. Default value: ''udp''. If TCP is used, it has to be [[How_to_enable_TCP_for_Asterisk |enabled in Asterisk]].
* '''Time limit per day''' - Total time available for provider per day. When limit is reached another provider in LCR is used (total time is calculated after rounding rules and minimal time adjustment, so if your provider tariff has increment higher than 1 or minimal time set, then total provider time may be different than actual call time).
* '''Limit up to X, during Y seconds''' – you can set limit how many calls (X) can be done in some interval of seconds (Y). [[Last Calls]] will show '''FAILED([[Hangupcause Codes |243]])'''.
* '''Execute AGI script''' - Execute custom AGI script. More info [http://wiki.kolmisoft.com/index.php/Provider_AGI_script here].
 

=== SIP Specific ===

* '''Fromuser''' – [http://www.voip-info.org/wiki/index.php?page=Asterisk+sip+fromuser more details]
* '''Fromdomain''' – [http://www.voip-info.org/wiki/index.php?page=Asterisk+sip+fromuser more details]
* '''Trustrpid''' – This defines whether or not Remote-Party-ID is trusted. It's defined in http://tools.ietf.org/id/draft-ietf-sip-privacy-04.txt
* '''Sendrpid''' – defines whether a Remote-Party-ID SIP header should be sent. It defaults to "No". This field is often used by wholesale VoIP providers to provide calling party identity regardless of the privacy settings (the From SIP header).
* '''Insecure''' – [http://www.voip-info.org/wiki/index.php?page=Asterisk+sip+insecure more details]
* '''T.38 Support''' – should we support T.38 pass-through?
* '''SIP Session Timers''' - SIP Session Timers provide an end-to-end keep-alive mechanism for active SIP sessions (more info [http://doxygen.asterisk.org/trunk/sip_session_timers.html here]). Possible values are "accept", "originate", "refuse":
** '''originate''' - request and run session-timers always.
** '''accept''' - run session-timers only when requested by other UA.
** '''refuse''' - do not run session timers in any case.
* '''SIP Session Refresher''' - The session refresher (uac|uas). Defaults to 'uas'.
** '''uac''' - default to the caller initially refreshing when possible.
** '''uas''' - default to the callee initially refreshing when possible.
* '''SIP Session Expires''' - maximum session refresh interval in seconds. Defaults to 1800 secs.
* '''SIP Min Session''' - minimum session refresh interval in seconds. Defaults to 90 secs.
* '''[[SIP 302 Reinvite Support]]''' – turns this SIP feature on or off.
* '''P-Asserted-Identity usage''' – The P-Asserted-Identity header field can be used to convey the proven identity of the originator of a request within a trusted network. If pass_pai =0 in [http://wiki.kolmisoft.com/index.php/Mor.conf Mor.conf] and PAI usage in provider settings =1, then core will add PAI header.
* '''Periodic check''' - if enabled, periodic SIP OPTIONS requests will be sent to Provider to check if it is reachable. If Periodic Check is enabled and Provider does not respond to OPTIONS request then Provider will be marked as unreachable and will be skipped when making Calls. Once Provider starts to respond to OPTIONS request it will be marked as reachable and Calls will be routed through this Provider. Providers are checked every 5 minutes. Options packets are sent from IP address defined in /etc/asterisk/sip.conf
* '''[http://wiki.kolmisoft.com/index.php/Mobile_Number_Portability_Addon#MNP_tags_in_SIP_INVITE Enable MNP tags]''' - adds MNP tags in SIP INVITE requests (if MNP is configured).
* '''Custom SIP Header''' - adds custom header to SIP request. Format is '''header: value''' (for example '''x-My-Custom-Header: my value''')
* '''Custom Destination Header''' - allows to read Destination number from specific SIP header (for example x-DID: 123) instead of SIP URI.
* '''Privacy CallerID''' - allows to change CallerID (From: <sip:'''xxxxxx'''@yyyyyyy>) when originator sends '''Privacy: id''' or '''Privacy: header'''. If originator does not send '''Privacy: id''' or '''Privacy: header''' or '''Privacy CallerID''' is empty, then SIP From header will not be modified.
* '''Privacy From Domain''' - allows to change Domain (From: <sip:xxxxxx@'''yyyyyyy'''>) when originator sends '''Privacy: id''' or '''Privacy: header'''. If originator does not send '''Privacy: id''' or '''Privacy: header''' or '''Privacy From Domain''' is empty, then SIP From header will not be modified.
* '''Playback before dial''' - allows to play selected sound file to originator before dialing to Provider. Select 'none' to disable this feature.
* '''Playback before dial mode''' - controls how '''Playback before dial''' handles media.
** '''Early media''' - uses '''183 Session Progress''' to send audio to originator. This is preferred way of sending media to originator since it does not require legA call to be answered. One drawback is that not all providers resend SIP 183 early media correctly. In those cases originator will hear silence.
** '''Answer and play''' - if this mode is selected, then '''MOR will answer legA''' and play media to originator. This way originator should always hear media but there are various drawbacks since legA is already answered. One of drawbacks is that MOR will generate false answer if Provider rejects call. Use this mode only if you know what you are doing.
 

== VIDEO: How to create Provider ==

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

 

=See also=

* [[H323 Provider settings]]
* [[Quick Providers changes]]
* [[Providers Statistics]]
* [[NO ANSWER/BUSY interpretation for providers]]
* [[I have a problem with Provider]]

File:MakeRetailTariff.png

2018-04-17T17:20:33Z

Robert: uploaded a new version of "File:MakeRetailTariff.png"

File:Recalculate single invoice x6.png

2017-10-20T09:42:51Z

Robert: uploaded a new version of "File:Recalculate single invoice x6.png"

File:Service details.png

2017-10-20T09:41:12Z

Robert: uploaded a new version of "File:Service details.png"

MOR API user details get

2017-10-02T08:37:07Z

Robert: /* Returns */

=Description=

[[MOR API]] user details

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

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

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

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

You are able to use these parameter one by one or both at a time. If you use them both at a time '''note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using '''parameters''' which are listed above. You are able to use these parameter one by one or both at a time. If you use them both at a time note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.

===Request===

We have user_id = 123, API Secret Key = 456789

We send:

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

We have username = username, API Secret Key = 456789

We send:

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

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

We send:

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

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

===Returns===

'''Success'''

<page>
<pagename>Personal_details</pagename>
<language>en</language>
<userid> user id </userid>
<details>
<main_detail>
<account>Postpaid/Prepaid</account>
<balance> balance and currency </balance>
<balance_number> balance </balance_number>
<balance_currency> currency </balance_currency>
<credit> credit </credit>
<pbx_pool_id> id </pbx_pool_id>
<responsible_accountant_id>1</responsible_accountant_id>
<hide_non_answered_calls> 0 - off/1 - on </hide_non_answered_calls>
</main_detail>
<other_details>
<username> username </username>
<first_name> first name </first_name>
<surname> last name </surname>
<personalid></personalid>
<agreement_number> </agreement_number>
<agreement_date> </agreement_date>
<taxation_country> </taxation_country>
<vat_reg_number> </vat_reg_number>
<vat_percent> </vat_percent>
<call_limit> </call_limit>
</other_details>
<registration>
<reg_address></reg_address>
<reg_postcode></reg_postcode>
<reg_city></reg_city>
<reg_country></reg_country>
<reg_state></reg_state>
<reg_direction></reg_direction>
<reg_phone></reg_phone>
<reg_mobile></reg_mobile>
<reg_fax></reg_fax>
<reg_email></reg_email>
</registration>
<invoices>
<generate_invoices>1</generate_invoices>
<invoice_xlsx>0</invoice_xlsx>
<simplified_pdf>1</simplified_pdf>
<simplified_csv>0</simplified_csv>
<detailed_pdf>0</detailed_pdf>
<detailed_csv>0</detailed_csv>
<by_callerid_pdf>0</by_callerid_pdf>
<by_callerid_csv>1</by_callerid_csv>
<by_destinations>0</by_destinations>
<calls>0</calls>
<show_zero_calls>1</show_zero_calls>
</invoices>
<warning_balance>
<active>1</active>
<send_email_when_balance_drops_lower_than>
<user>0.0</user>
<admin>0.0</admin>
<responsible_accountant>5.0</responsible_accountant>
</send_email_when_balance_drops_lower_than>
<warning_email_hour>0</warning_email_hour>
</warning_balance>
</details>
</page>
 
----

'''Errors'''

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

=See also=

* [[MOR API]]

File:Mor accountant permissions.png

2017-10-02T08:27:27Z

Robert: uploaded a new version of "File:Mor accountant permissions.png"

MOR API invoice update

2017-10-02T08:08:28Z

Robert: /* Description */

=Description=

[[MOR API]] for invoice update. 
If a user has 'accountant' rights and can see only assigned users, he will be able to update only for assigned users invoices.
 

=Usage=

* From '''MOR X11''' call: '''/api/invoice_update'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

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

* id - Inovice ID in MOR database, which we want to change. '''Required'''.

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

Parameters which are '''not included''' into hash:
* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username to login. '''Required'''.
* address - User Details address
* city - User Details city
* postcode - User Details postcode
* state - User Details state
* country_id - User Details Country ([[Directions_and_Destinations#Directions|Direction]] id)
* phone - User Details phone
* tax_reg_number - User Details TAX Registration Number
* comment - Comment
* name - User Details name
* invoice_sent_manually - Invoice sent manually setting. (to change status, the value must be 1)
* pay - paid status setting. (to change status, the value must be 1)

 

===Request===
If API Secret Key = secret

You send:

HTML POST: http://<SERVER IP>/billing/api/invoice_update?u=admin&id=2&hash=38282ca5e65e63746498ef5b39a2fe71c6448df4

'''* Note that username (u) is not included in the hash'''
 

===Returns===

'''Success'''
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Invoice successfully updated</success>
</status>
</page>
 
----

'''Errors'''

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

<?xml version="1.0" encoding="UTF-8"?>
<status>
<error>Incorrect hash</error>
</status>

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Access denied</error>
</status>
</page>

=See also=

* [[MOR API]]
* [[Invoices#Invoice_details | Inoice Details]]

MOR API invoices get

2017-10-02T08:00:34Z

Robert: /* Description */

=Description=
[[MOR API]] Retrieves a list of invoices in the selected time period.

If a user has 'admin' rights, he will get '''ALL''' invoices from the selected period. If a user has 'accountant' rights and can see only assigned users, he will get only assigned users invoices from the selected period. If user has 'user' rights, he will get only '''HIS''' invoices from the selected period.
 

=Usage=

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

* u - username username of user which can view invoices. '''Required'''.
* from/till - time period for invoices in [http://en.wikipedia.org/wiki/Unix_time Unix Epoch Time] format. Invoice's '''period start''' should be >= '''from''' and '''period end''' <= '''till'''.
** http://www.epochconverter.com/ can help to convert time for testing.
* lang - choose the language in which you want to get invoice details (mainly 'Calls').
 
===Request===

HTML POST: http://<SERVER IP>/billing/api/invoices_get?u=username&from=1188604800&till=1191196799&lang=en
 
===Returns===

'''Success'''

<Invoices till="2015-08-22" from="2005-04-21">
<Invoice clientid="" number="INV0706221" agreementnumber="" user_id="0">
<paid>0</paid>
<Product>
<Name>Calls</Name>
<Quantity>2</Quantity>
<Price>5.0000</Price>
<Date_added></Date_added>
<Issue_date>2012-06-22</Issue_date>
</Product>
</Invoice>
<Invoice clientid="" number="INV0706222" agreementnumber="" user_id="2">
<paid>1</paid>
<Product>
<Name>Calls</Name>
<Quantity>4</Quantity>
<Price>20.0000</Price>
<Date_added></Date_added>
<Issue_date>2012-06-22</Issue_date>
</Product>
<Product>
<Name>Test_periodic_service - Test_preriodic_service_memo</Name>
<Quantity>1</Quantity>
<Price>390.5591</Price>
<Date_added></Date_added>
<Issue_date>2012-06-22</Issue_date>
</Product>
</Invoice>
<Invoice clientid="" number="INV0706223" agreementnumber="0000000001" user_id="3">
<paid>1</paid>
<Product>
<Name>Calls</Name>
<Quantity>2</Quantity>
<Price>11.0000</Price>
<Date_added></Date_added>
<Issue_date>2012-06-22</Issue_date>
</Product>
<Product>
<Name>Calls from Users</Name>
<Quantity>7</Quantity>
<Price>52.0000</Price>
<Date_added></Date_added>
<Issue_date>2012-06-22</Issue_date>
</Product>
</Invoice>
</Invoices>
 
----

'''Errors'''

<?xml version="1.0" encoding="UTF-8"?>
<status>
<error>Incorrect hash</error>
</status>

<Error>user not found</Error>

<Error>no invoices found</Error>
 

=See also=

* [[MOR API]]

MOR API invoice update

2017-09-19T17:30:17Z

Robert: /* Description */

=Description=

[[MOR API]] for invoice update, only for admin and reseller.
 

=Usage=

* From '''MOR X11''' call: '''/api/invoice_update'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

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

* id - Inovice ID in MOR database, which we want to change. '''Required'''.

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

Parameters which are '''not included''' into hash:
* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username to login. '''Required'''.
* address - User Details address
* city - User Details city
* postcode - User Details postcode
* state - User Details state
* country_id - User Details Country ([[Directions_and_Destinations#Directions|Direction]] id)
* phone - User Details phone
* tax_reg_number - User Details TAX Registration Number
* comment - Comment
* name - User Details name
* invoice_sent_manually - Invoice sent manually setting. (to change status, the value must be 1)
* pay - paid status setting. (to change status, the value must be 1)

 

===Request===
If API Secret Key = secret

You send:

HTML POST: http://<SERVER IP>/billing/api/invoice_update?u=admin&id=2&hash=38282ca5e65e63746498ef5b39a2fe71c6448df4

'''* Note that username (u) is not included in the hash'''
 

===Returns===

'''Success'''
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Invoice successfully updated</success>
</status>
</page>
 
----

'''Errors'''

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

<?xml version="1.0" encoding="UTF-8"?>
<status>
<error>Incorrect hash</error>
</status>

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Access denied</error>
</status>
</page>

=See also=

* [[MOR API]]
* [[Invoices#Invoice_details | Inoice Details]]

MOR API invoice update

2017-09-19T17:10:19Z

Robert: /* Parametres */

=Description=

[[MOR API]] for invoice update.
 
=Usage=

* From '''MOR X11''' call: '''/api/invoice_update'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

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

* id - Inovice ID in MOR database, which we want to change. '''Required'''.

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

Parameters which are '''not included''' into hash:
* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username to login. '''Required'''.
* address - User Details address
* city - User Details city
* postcode - User Details postcode
* state - User Details state
* country_id - User Details Country ([[Directions_and_Destinations#Directions|Direction]] id)
* phone - User Details phone
* tax_reg_number - User Details TAX Registration Number
* comment - Comment
* name - User Details name
* invoice_sent_manually - Invoice sent manually setting. (to change status, the value must be 1)
* pay - paid status setting. (to change status, the value must be 1)

 

===Request===
If API Secret Key = secret

You send:

HTML POST: http://<SERVER IP>/billing/api/invoice_update?u=admin&id=2&hash=38282ca5e65e63746498ef5b39a2fe71c6448df4

'''* Note that username (u) is not included in the hash'''
 

===Returns===

'''Success'''
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Invoice successfully updated</success>
</status>
</page>
 
----

'''Errors'''

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

<?xml version="1.0" encoding="UTF-8"?>
<status>
<error>Incorrect hash</error>
</status>

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Access denied</error>
</status>
</page>

=See also=

* [[MOR API]]
* [[Invoices#Invoice_details | Inoice Details]]

MOR API

2017-09-19T13:53:28Z

Robert: /* Invoices */

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

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

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

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

 

=Functions=

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

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

 

==Callback==
NOTE: Callback addon is needed. Does not work on limited version.
* [[MOR API callback init|callback_init]] (callback) – initiates callback.

 

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

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

 

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

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

 
==Currencies==
* [[MOR_API_Exchange_rate_update|exchange_rate_update]] - Currency Exchange rate update.

 
==Device==

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

==DID==

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

 

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

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

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

 

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

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

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

 
==PBX Pool==
* [[MOR API pbx_pool_create| pbx_pool_create]] – PBX Pool create.

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

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

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

 
==Recordings==
* [[MOR API recordings get| recordings_get]] – get MOR recordings.

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

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

 

==SMS==
NOTE: SMS addon is need to have these APIs
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.
* [[MOR_API_user_sms_get | user_sms_get ]] – Retrieves a list of SMS in a selected time period for a user/device.

 

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

 

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

==User==

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

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

 

==Vouchers==
* [[MOR API voucher use| voucher_use]] – use selected voucher.

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

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

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

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

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

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

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

MOR API invoice update

2017-09-19T13:51:37Z

Robert: /* Request */

=Description=

[[MOR API]] for invoice update.
 
=Usage=

* From '''MOR X11''' call: '''/api/invoice_update'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

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

* id - Inovice ID in MOR database, which we want to change. '''Required'''.

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

Parameters which are '''not included''' into hash:
* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username to login. '''Required'''.
* address - User Details address
* city - User Details city
* postcode - User Details postcode
* state - User Details state
* country_id - User Details Country ([[Directions_and_Destinations#Directions|Direction]] id)
* phone - User Details phone
* tax_reg_number - User Details TAX Registration Number
* comment - Comment
* name - User Details name
* invoice_sent_manually - Invoice sent manually setting.
* pay - paid status setting.

 

===Request===
If API Secret Key = secret

You send:

HTML POST: http://<SERVER IP>/billing/api/invoice_update?u=admin&id=2&hash=38282ca5e65e63746498ef5b39a2fe71c6448df4

'''* Note that username (u) is not included in the hash'''
 

===Returns===

'''Success'''
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Invoice successfully updated</success>
</status>
</page>
 
----

'''Errors'''

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

<?xml version="1.0" encoding="UTF-8"?>
<status>
<error>Incorrect hash</error>
</status>

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Access denied</error>
</status>
</page>

=See also=

* [[MOR API]]
* [[Invoices#Invoice_details | Inoice Details]]

File:Cph search.png

2017-09-19T11:54:51Z

Robert: uploaded a new version of "File:Cph search.png"

M4 Calls per Hour

2017-09-19T11:53:23Z

Robert: Created page with '= Description = This page shows statistics of calls grouped first by days, then users, then hours and then by prefixes. == Who can access the page? == Admin and Manager. =…'

= Description =

This page shows statistics of calls grouped first by days, then users, then hours and then by prefixes.

== Who can access the page? ==

Admin and Manager.

= Usage =

Go to '''Reports –> Calls Per Hour''' 
 
[[File:Cph menu.png]]
 
You can Refine the search results by providing an intended time period, a Originator, Terminator and Prefix 
 
[[File:Cph search.png]]
 
Besides Calls date, number of Attempted Calls, Answered Calls, Duration of calls made during the specific day/user/hour/prefix, Average Retries, you can also check and [http://wiki.kolmisoft.com/index.php/ASR/ACD ASR/ACD] information.
 
[[File:Cph table.png]]
 
You will not see days here that has no calls.

File:Cph table.png

2017-09-19T11:52:39Z

Robert:

File:Cph search.png

2017-09-19T11:49:00Z

Robert:

File:Cph menu.png

2017-09-19T11:45:33Z

Robert:

User Details

2017-09-19T08:46:54Z

Robert: /* General */

=Where to find user details?=

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


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

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

= General =

* Username – username for user to login to MOR GUI.
* Password – password for user to login to MOR GUI. Password must contain at least one numeric value, capital and lowercase symbol. '''Note''': To use simple passwords turn off setting in various section called '''Use strong passwords for users'''
* [[Users#User_types | User type]] – by default it is "user".
* [[LCR]] – LCR indicating which of the user's devices will be used to dial out.
* [[Tariffs | Tariff]] – prices for the user.
* [[Balance and Credit | Balance]] – the user's balance.
* Daily Balance limit – Total balance available for user per day. If User reaches this limit all User's calls will be dropped with hangupcause '211 Low balance for user'. This limit is reset each day at midnight (00:00:00).
* [[Balance and Credit | Credit]] – the user's credit, showing how low the user's balance can go.
* [[Minimum contract billing | Minimal Charge for Calls]] - minimum charge user pays for voice calls.
* [[Minimum contract billing | Minimal Charge for Calls Date]] - date since when the previous option is valid.
* Postpaid/Prepaid – type of user.
* [[Hide Users | Not Hidden/Hidden]] – is this user hidden?
* Primary device – the primary device for this user.
* [[Allow loss calls]] – should loss calls be allowed for this user?
* [[Simultaneous call limitation | Call Limit]] – how many simultaneous calls the user can make?
* Max Call rate - set maximum allowed rate (price per min) when making calls (0 - unlimited)
* Default [[Currencies | Currency]] – currency which will be used to show balance, rates and prices in Users' GUI and exported files. Notice that balance (also other values) will be saved in [[Currencies |default system currency]] in DB and converted on the fly using current exchange rate - e.g. balance can change when [[Currencies#Automatic_Currency_Update |exchange rate changes]]. So your user can be surprised when he does not make calls but balance fluctuates.
* [[GUI_time_zone | Time Zone]] – time zone which will be used to show dates and time in Users' GUI and exported files
* Responsible accountant – dropdown to choose accountant responsible for user's profit. (only Admin can set Responsible accountant)
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. 
* Allow to change CallerID – with this option enabled simple user can change his devices custom CallerID.
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] 
* Show Stats from User perspective – hide intermediate Call attempts for User in Last Calls. For example, if LCR contains two Providers and first one is unreachable, then MOR tries to call second Provider. If this setting is checked, User will see only single Call attempt (through second Provider). If settings is unchecked, User will see both attempts in his Last Calls.
* Show only own traffic in Last Calls - show only own traffic for reseller in last calls. If setting on, Reseller will not see calls which made by his user with calling card that belongs to another reseller. (setting available only if User Type - reseller)
 

= Blocking =

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

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

More details: [[Warning balance]]
 
= Invoices =

[[Image:user_invoice_details.png]]
 

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

= Payments =

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

 
= Details =

Self-explanatory.

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

Here tax parameters are entered for the user.

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

Self-explanatory.
 

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

= Recordings =

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

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


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

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

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

= Comment =

Here you are able to write private comment about user.

User Details

2017-09-19T08:41:12Z

Robert: /* General */

=Where to find user details?=

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


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

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

= General =

* Username – username for user to login to MOR GUI.
* Password – password for user to login to MOR GUI. Password must contain at least one numeric value, capital and lowercase symbol. '''Note''': To use simple passwords turn off setting in various section called '''Use strong passwords for users'''
* [[Users#User_types | User type]] – by default it is "user".
* [[LCR]] – LCR indicating which of the user's devices will be used to dial out.
* [[Tariffs | Tariff]] – prices for the user.
* [[Balance and Credit | Balance]] – the user's balance.
* Daily Balance limit – Total balance available for user per day. If User reaches this limit all User's calls will be dropped with hangupcause '211 Low balance for user'. This limit is reset each day at midnight (00:00:00).
* [[Balance and Credit | Credit]] – the user's credit, showing how low the user's balance can go.
* [[Minimum contract billing | Minimal Charge for Calls]] - minimum charge user pays for voice calls.
* [[Minimum contract billing | Minimal Charge for Calls Date]] - date since when the previous option is valid.
* Postpaid/Prepaid – type of user.
* [[Hide Users | Not Hidden/Hidden]] – is this user hidden?
* Primary device – the primary device for this user.
* [[Allow loss calls]] – should loss calls be allowed for this user?
* [[Simultaneous call limitation | Call Limit]] – how many simultaneous calls the user can make?
* Max Call rate - set maximum allowed rate (price per min) when making calls (0 - unlimited)
* Default [[Currencies | Currency]] – currency which will be used to show balance, rates and prices in Users' GUI and exported files. Notice that balance (also other values) will be saved in [[Currencies |default system currency]] in DB and converted on the fly using current exchange rate - e.g. balance can change when [[Currencies#Automatic_Currency_Update |exchange rate changes]]. So your user can be surprised when he does not make calls but balance fluctuates.
* [[GUI_time_zone | Time Zone]] – time zone which will be used to show dates and time in Users' GUI and exported files
* Responsible accountant – dropdown to choose accountant responsible for user's profit. (only Admin can set Responsible accountant)
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. 
* Allow to change CallerID – with this option enabled simple user can change his devices custom CallerID.
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] 
* Show Stats from User perspective – hide intermediate Call attempts for User in Last Calls. For example, if LCR contains two Providers and first one is unreachable, then MOR tries to call second Provider. If this setting is checked, User will see only single Call attempt (through second Provider). If settings is unchecked, User will see both attempts in his Last Calls.
* Show only own traffic in Last Calls - show only own traffic for reseller in last calls for example: if setting on, Reseller will not see calls which made by his user with other reseller calling card. (setting available only if User Type - reseller)
 

= Blocking =

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

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

More details: [[Warning balance]]
 
= Invoices =

[[Image:user_invoice_details.png]]
 

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

= Payments =

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

 
= Details =

Self-explanatory.

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

Here tax parameters are entered for the user.

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

Self-explanatory.
 

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

= Recordings =

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

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


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

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

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

= Comment =

Here you are able to write private comment about user.

MOR API invoices get

2017-09-19T07:40:13Z

Robert: /* Returns */

=Description=
[[MOR API]] Retrieves a list of invoices in the selected time period.

If a user has 'admin' rights, he will get '''ALL''' invoices from the selected period. If user has 'user' rights, he will get only '''HIS''' invoices from the selected period.
 
=Usage=

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

* u - username username of user which can view invoices. '''Required'''.
* from/till - time period for invoices in [http://en.wikipedia.org/wiki/Unix_time Unix Epoch Time] format. Invoice's '''period start''' should be >= '''from''' and '''period end''' <= '''till'''.
** http://www.epochconverter.com/ can help to convert time for testing.
* lang - choose the language in which you want to get invoice details (mainly 'Calls').
 
===Request===

HTML POST: http://<SERVER IP>/billing/api/invoices_get?u=username&from=1188604800&till=1191196799&lang=en
 
===Returns===

'''Success'''

<Invoices till="2015-08-22" from="2005-04-21">
<Invoice clientid="" number="INV0706221" agreementnumber="" user_id="0">
<paid>0</paid>
<Product>
<Name>Calls</Name>
<Quantity>2</Quantity>
<Price>5.0000</Price>
<Date_added></Date_added>
<Issue_date>2012-06-22</Issue_date>
</Product>
</Invoice>
<Invoice clientid="" number="INV0706222" agreementnumber="" user_id="2">
<paid>1</paid>
<Product>
<Name>Calls</Name>
<Quantity>4</Quantity>
<Price>20.0000</Price>
<Date_added></Date_added>
<Issue_date>2012-06-22</Issue_date>
</Product>
<Product>
<Name>Test_periodic_service - Test_preriodic_service_memo</Name>
<Quantity>1</Quantity>
<Price>390.5591</Price>
<Date_added></Date_added>
<Issue_date>2012-06-22</Issue_date>
</Product>
</Invoice>
<Invoice clientid="" number="INV0706223" agreementnumber="0000000001" user_id="3">
<paid>1</paid>
<Product>
<Name>Calls</Name>
<Quantity>2</Quantity>
<Price>11.0000</Price>
<Date_added></Date_added>
<Issue_date>2012-06-22</Issue_date>
</Product>
<Product>
<Name>Calls from Users</Name>
<Quantity>7</Quantity>
<Price>52.0000</Price>
<Date_added></Date_added>
<Issue_date>2012-06-22</Issue_date>
</Product>
</Invoice>
</Invoices>
 
----

'''Errors'''

<?xml version="1.0" encoding="UTF-8"?>
<status>
<error>Incorrect hash</error>
</status>

<Error>user not found</Error>

<Error>no invoices found</Error>
 

=See also=

* [[MOR API]]

MOR API invoice update

2017-09-19T07:37:01Z

Robert: Created page with '=Description=  MOR API for invoice update. =Usage= * From '''MOR X11''' call: '''/api/invoice_update''' * Metho…'

=Description=

[[MOR API]] for invoice update.
 
=Usage=

* From '''MOR X11''' call: '''/api/invoice_update'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

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

* id - Inovice ID in MOR database, which we want to change. '''Required'''.

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

Parameters which are '''not included''' into hash:
* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username to login. '''Required'''.
* address - User Details address
* city - User Details city
* postcode - User Details postcode
* state - User Details state
* country_id - User Details Country ([[Directions_and_Destinations#Directions|Direction]] id)
* phone - User Details phone
* tax_reg_number - User Details TAX Registration Number
* comment - Comment
* name - User Details name
* invoice_sent_manually - Invoice sent manually setting.
* pay - paid status setting.

 

===Request===
If API Secret Key = secret

You send:

HTML POST: http://<SERVER IP>/billing/api/invoice_update?u=admin&id=38282ca5e65e63746498ef5b39a2fe71c6448df4

'''* Note that username (u) is not included in the hash'''
 
===Returns===

'''Success'''
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Invoice successfully updated</success>
</status>
</page>
 
----

'''Errors'''

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

<?xml version="1.0" encoding="UTF-8"?>
<status>
<error>Incorrect hash</error>
</status>

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Access denied</error>
</status>
</page>

=See also=

* [[MOR API]]
* [[Invoices#Invoice_details | Inoice Details]]

M4 Quick Stats

2017-09-05T13:46:36Z

Robert: /* Quick Stats for the System Admin */

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

===Quick Stats for the System Admin and Manager===
These are stats for all Calls made in the system in the mentioned periods:
 
[[Image:m2_admin_quick_stats.png]]
 
In addition to financial data uptime stats are shown for active Servers. 
Click on the Active Calls value to go to the '''Active Calls''' page for more details. 
Click on the Calls value to go to the '''Last Calls''' page for more details. 
Hold mouse pointer over chosen server line for more details. 
Manager can access this page only if have permission to manage [[M2_Managers#Manager_Groups | DASHBOARD> Quick Stats]]. 
Manager with setting [[M2_Managers#Manager_Create.2FEdit | 'Show only assigned Users']] on, can only see the data of assigned Users.
 


===Quick Stats for Users===
In the Quick Stats Users can see Statistics of Call originated or terminated via their Connection Points. These Statistics include the amount of Calls, a Call Duration, and a Price. 
With a Setting (MAINTENANCE > Settings > Active Calls > Show Active Calls for Users) Users can also see their Active Calls. 
In addition, Users can see their current Balance. 
[[Image:M2_user_quick_stats.png]]

=See Also=
* [[Active Calls]]
* [[Last Calls]]

M4 API quickstats get

2017-09-05T13:31:38Z

Robert: /* Description */

=Description=

Retrieves [[Quick Stats]] and [[Active Calls]] for today and a current month 

Data can be retrieved for the '''System Admin''', '''Manager''' and a '''Simple User'''. 
'''Note''' Manager can retrieve data only if have permission to manage DASHBOARD> Quick Stats
 
'''Simpe User Notes:'''
* Active Calls can be retrieved for Simple Users only if a Setting: '''MAINTENANCE > Settings > Show Active Calls for Users''' is on.
* Simple users can only see the amount of Calls, Call Duration, Call Price, and their Balance.
 

=Usage=

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

* [[MOR API hash construction | hash]] - SHA1 hash constructed using API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked).
* u - username for authentication. '''Required'''.

'''Note that u is included in to the HASH only if u is not the System Admin'''
 

===Request===

If API Secret Key = secret

You send:

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

'''* Note that username (u) is not included in the hash'''
 

===Returns===

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

<?xml version="1.0" encoding="UTF-8"?>
<page>
<quickstats>
<today>
<calls>4</calls>
<duration>345</duration>
<revenue>1.4475</revenue>
<self_cost>0.6725</self_cost>
<profit>0.775</profit>
<margin>54</margin>
</today>
<month>
<calls>19</calls>
<duration>2182</duration>
<revenue>6.04</revenue>
<self_cost>3.734166</self_cost>
<profit>2.305834</profit>
<margin>38</margin>
</month>
<active_calls>
<total>0</total>
<answered_calls>0</answered_calls>
</active_calls>
</quickstats>
</page>

'''Errors:'''

* <error>API Requests are disabled</error> – '''Allow API globally''' setting is unchecked
* <error>GET Requests are disabled</error> – '''Allow GET API''' setting is unchecked
* <error>Access Denied</error> – user with such username cannot use this method
* <error>Bad login</error> – such username does not exist in the database or it was not specified
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string
* <error>Cannot connect to Elasticsearch</error> – data is not reachable

Example:

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

=See also=

* [[M2 API]]

M4 API quickstats get

2017-09-05T13:31:07Z

Robert: /* Description */

=Description=

Retrieves [[Quick Stats]] and [[Active Calls]] for today and a current month 

Data can be retrieved for the '''System Admin''', '''Manager''' and a '''Simple User'''. 
'''Note''' Manager can retrieve data only if have permission to manage DASHBOARD> Quick Stats
 
'''Simpe User Notes:'''
* Active Calls can be retrieved for Simple Users only if a Setting: '''MAINTENANCE > Settings > Show Active Calls for Users''' is on.
* Simple users can only see the amount of Calls, Call Duration, Call Price, and their Balance.
 

=Usage=

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

* [[MOR API hash construction | hash]] - SHA1 hash constructed using API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked).
* u - username for authentication. '''Required'''.

'''Note that u is included in to the HASH only if u is not the System Admin'''
 

===Request===

If API Secret Key = secret

You send:

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

'''* Note that username (u) is not included in the hash'''
 

===Returns===

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

<?xml version="1.0" encoding="UTF-8"?>
<page>
<quickstats>
<today>
<calls>4</calls>
<duration>345</duration>
<revenue>1.4475</revenue>
<self_cost>0.6725</self_cost>
<profit>0.775</profit>
<margin>54</margin>
</today>
<month>
<calls>19</calls>
<duration>2182</duration>
<revenue>6.04</revenue>
<self_cost>3.734166</self_cost>
<profit>2.305834</profit>
<margin>38</margin>
</month>
<active_calls>
<total>0</total>
<answered_calls>0</answered_calls>
</active_calls>
</quickstats>
</page>

'''Errors:'''

* <error>API Requests are disabled</error> – '''Allow API globally''' setting is unchecked
* <error>GET Requests are disabled</error> – '''Allow GET API''' setting is unchecked
* <error>Access Denied</error> – user with such username cannot use this method
* <error>Bad login</error> – such username does not exist in the database or it was not specified
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string
* <error>Cannot connect to Elasticsearch</error> – data is not reachable

Example:

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

=See also=

* [[M2 API]]

M4 API quickstats get

2017-09-05T13:30:48Z

Robert: /* Description */

=Description=

Retrieves [[Quick Stats]] and [[Active Calls]] for today and a current month 

Data can be retrieved for the '''System Admin''', '''Manager''' and a '''Simple User'''. 
'''Note''' Manager can retrieve data only if have permission to manage DASHBOARD> Quick Stats
'''Simpe User Notes:'''
* Active Calls can be retrieved for Simple Users only if a Setting: '''MAINTENANCE > Settings > Show Active Calls for Users''' is on.
* Simple users can only see the amount of Calls, Call Duration, Call Price, and their Balance.
 

=Usage=

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

* [[MOR API hash construction | hash]] - SHA1 hash constructed using API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked).
* u - username for authentication. '''Required'''.

'''Note that u is included in to the HASH only if u is not the System Admin'''
 

===Request===

If API Secret Key = secret

You send:

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

'''* Note that username (u) is not included in the hash'''
 

===Returns===

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

<?xml version="1.0" encoding="UTF-8"?>
<page>
<quickstats>
<today>
<calls>4</calls>
<duration>345</duration>
<revenue>1.4475</revenue>
<self_cost>0.6725</self_cost>
<profit>0.775</profit>
<margin>54</margin>
</today>
<month>
<calls>19</calls>
<duration>2182</duration>
<revenue>6.04</revenue>
<self_cost>3.734166</self_cost>
<profit>2.305834</profit>
<margin>38</margin>
</month>
<active_calls>
<total>0</total>
<answered_calls>0</answered_calls>
</active_calls>
</quickstats>
</page>

'''Errors:'''

* <error>API Requests are disabled</error> – '''Allow API globally''' setting is unchecked
* <error>GET Requests are disabled</error> – '''Allow GET API''' setting is unchecked
* <error>Access Denied</error> – user with such username cannot use this method
* <error>Bad login</error> – such username does not exist in the database or it was not specified
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string
* <error>Cannot connect to Elasticsearch</error> – data is not reachable

Example:

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

=See also=

* [[M2 API]]

File:Manager permissions.png

2017-09-05T13:26:47Z

Robert: uploaded a new version of "File:Manager permissions.png"

MOR API CLI info get

2017-09-05T10:38:36Z

Robert: /* Parametres */

=Description=

[[MOR API]] CLI get info

Please note that admin/reseller can retrieve CLI info just for their own Users Devices.
 
=Usage=

* Call: /api/cli_info_get

 
===Parametres===

* u – username to login. '''Required'''.
* cli – this specifies CLI number whose info to show.
* domain - this specifies CLI domain whose info to show.
* [[MOR API hash construction | hash]] – SHA1 hash constructed using just '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.

Returning XML is put in file. That file is gziped and returned as a response content.
 

===Request===

We have API Secret Key = 456789, cli number = 12345
We send:

HTML POST: http://<server_ip>/billing/api/cli_get_info?u=admin&p=admin&cli=12345&hash=71516eea4850f7e0300ac86adf9fb64bca845aa7

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

===Returns===

'''Success'''

<page>
<cli>
<device>
<user_id>2</user_id>
<device_id>2</device_id>
</device>
</cli>
</page>

 
----

'''Errors'''

* <error>CLI not found</error> – CLI was not found.
* <error>CLI is empty</error> – CLI was not sent.
* <error>Access Denied</error> – User was not found by username and password. Use correct username and password. Make sure that username (u) and password (p) are specified.
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
 

=See also=

* [[MOR API]]
* [[CLIs (Incoming CallerIDs)]]

MOR API device clis get

2017-09-05T10:36:43Z

Robert: /* Returns */

=Description=

[[MOR API]] Device clis get

Please note that accountant and reseller must have permissions to use this API.

 
=Usage=

* Call: /api/device_clis_get
* Methods: POST, GET(if allowed, not recomended)

 
===Parametres===

* u – username to login. '''Required'''.
* devices_id – this is the id of users device. '''Optional'''.
* users_id - this is the id of the user whose CLIs will be selected. '''Optional'''
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.

 

===Request===

We have API Secret Key = secret 
We send:

HTML POST: http://<server_ip>/billing/api/device_clis_get?u=admin&devices_id=6&users_id=3&e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4

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

===Returns===

'''Success'''

<page>
<status>
<cli_id>3</cli_id>
<cli_cli>45456464</cli_cli>
<cli_domain>test.domain</cli_domain>
<cli_device>IAX2/ipauth4aa73a4300</cli_device>
<cli_description>Test Reseller</cli_description>
<cli_added_at>2015-08-31 12:40:23 +0300</cli_added_at>
<cli_updated_at>2015-08-31 16:14:48 +0300</cli_updated_at>
<cli_comment>rhrtghg</cli_comment>
<cli_email_callback>0</cli_email_callback>
<cli_banned>0</cli_banned>
</status>
</page>

 
----

'''Errors'''
* <error>Device was not found</error> – Device was not found.
* <error>CLIs were not found</error> – No CLIs found.
* <error>Access Denied</error> – username (u) is not found.
* <error>You are not authorized to use this functionality</error> – username (u) is reseller or accountant without permissions.
* <error>User was not found</error> – specified user via user_id does not exist.
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
 

=See also=

* [[MOR API]]

MOR API CLI add

2017-09-05T10:33:31Z

Robert: /* Usage */

=Description=

[[MOR API]] CLI add

Please note that admin/reseller can create CLI just for their own Users Devices.
 
=Usage=

* Call: /api/cli_add

 
===Parametres===

* u – username to login. '''Required'''.
* cli_number – this specifies CLI number which will be added. '''Required If cli_domain is empty'''.
* cli_domain - domain of CLI. '''Required If cli_number is empty. It is not included into hash'''.
* cli_description – description of CLI
* comment – comment of CLI
* banned – banned (1) or not banned (0).
* ivr_id – id of the IVR.
* device_id – id of device this CLI should be assigned to. '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.

Returning XML is put in file. That file is gziped and returned as a response content.
 

===Request===

We have API Secret Key = 456789, cli_number = 12345, device_id = 2 and CLI should be banned. 
We send:

HTML POST: http://<server_ip>/billing/api/cli_add?u=admin&cli_number=1234678&cli_description=description&comment=comment&ivr_id=2&banned=1&device_id=2&test=1&hash=1ba6df6ad2532aea7ca035be29b7dd63feb1df88

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

===Returns===

'''Success'''

<page>
<status>CLI successfully created</status>
</page>

 
----

'''Errors'''

* <error>CLI must be numeric</error> – CLI must be numeric.
* <error>CLI already exists. It is assigned to user_name device</error> - such CLI is already created and belongs to the user that is mention in this error notice.
* <error>CLI Number cannot be empty</error> - CLI number must be specified.
* <error>IVR was not found</error> - if IVR parameter is used, IVR id must be also specified.
* <error>Device ID cannot be empty</error> - device id must be specified.
* <error>Access Denied</error> – User was not found by username and password. Use correct username and password. Make sure that username (u) and password (p) are specified.
* <error>You are not authorised to use this functionality</error> - accountant needs to have Manage Device permissions.
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
 

=See also=

* [[MOR API]]
* [[CLIs (Incoming CallerIDs)]]

MOR API subscription update

2017-09-05T10:29:16Z

Robert: /* Returns */

=Deescription=

[[MOR API]] Update subscription
 
=Usage=

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

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

* subscription_id - Subscription ID. '''Required'''.

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

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
* subscription_activation_start - timestamp of Subscription activation start.
* subscription_activation_end - timestamp of Subscription activation end.
* subscription_memo - memo of Subscription.
* subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off).
* subscription_no_expiration_at_the_end_of_a_month - subscription has no expiration at the end of month. (0 - off, 1 - on, default - off). '''Only for Flat Rate'''.
 

===Request===

We have subscription_id = 10, subscription_activation_start = 1255132800, subscription_memo = acc_one, API Secret Key = 456789.

We send:

HTML POST: http://<SERVER_IP>/billing/api/subscription_update?u=username&subscription_id=10&subscription_activation_start=1255132800&subscription_memo=acc_one&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

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

===Returns===

'''Success'''

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

 
----
'''Errors'''
* <error>Access Denied</error> - user does not exist or cannot use this functionality.
* <error>You are not authorised to use this functionality</error> - accountant does not have Manage Subscription permission.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Subscription activation end date must be valid timestamp</error> - self explanatory.
* <error>Subscription activation start date must be valid timestamp</error> - self explanatory.
* <error>Subscription was not found</error> - Subscription with specified subscription_id was not found.
* <error>Activation start date must be earlier than end date</error> - self explanatory.
* <error>Service is not flat rate</error> - you are using subscription_no_expiration_at_the_end_of_a_month parameter with service which is not Flat-Rate type.
'''Info'''
* <info>Not possible to set activation end until canceled </info> - It is not possible to set activations end until canceled, for subscription types: One Time fee, Dynamic Flat rate.
* <info>Not possible to change dates </info> - It is not possible to change date, for subscription type Dynamic Flat rate and it is not possible to change end date for subscription type One time fee.
 

=See also=

* [[MOR API]]
* [[MOR API subscription delete]]
* [[MOR API Subscriptions get]]
* [[MOR API subscription create]]

M4 Users

2017-09-05T08:45:42Z

Robert: /* General */

=Where to find user details?=

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

Here you can see list of all users.

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


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

= Details update =

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

* '''Username''' – username for user to login to MOR GUI.
* '''Password''' – password for user to login to MOR GUI.
* '''[[Balance and Credit | Balance]]''' – the user's balance.
* '''Balance range''' – minimal and maximal balance which User will be able to have.
* '''[[Minimum contract billing | Minimal Charge for Calls]]''' – minimum charge user pays for voice calls.
* '''[[Minimum contract billing | Minimal Charge for Calls Date]]''' – date since when the previous option is valid.
* '''[[Hide Users | Not Hidden/Hidden]]''' – is this user hidden?
* '''[[Simultaneous call limitation | Call Limit]]''' – how many simultaneous calls the user can make?
* '''Max Call rate''' - set maximum allowed rate (price per min) when making calls (0 - unlimited).
* '''Default Currency''' – User's default Currency
* '''Time Zone''' – User's native Time Zone
* '''Responsible Manager''' – dropdown to choose Manager responsible for this User. (only Admin can set Responsible Manager)
* '''PBX Pool''' – PBX pool assigned to User
* '''Hide Non-Answered calls''' – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. 
* '''Ignore Global Alerts''' – check and User will be ignored on checking for [[M2_Alerts | Alerts]]
* '''Show Hangup Cause''' – allow User to see numeric hangup cause value (for example '''FAILED (41)''' instead of '''FAILED''').
 

= Blocking =

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

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

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

= Invoices =

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

= Details =

Self-explanatory.

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

Self-explanatory:

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

Here tax parameters are entered for the user.

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

Self-explanatory.
 
=Blacklists / Whitelists=

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

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

User Details

2017-09-05T08:43:59Z

Robert: /* General */

=Where to find user details?=

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


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

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

= General =

* Username – username for user to login to MOR GUI.
* Password – password for user to login to MOR GUI. Password must contain at least one numeric value, capital and lowercase symbol. '''Note''': To use simple passwords turn off setting in various section called '''Use strong passwords for users'''
* [[Users#User_types | User type]] – by default it is "user".
* [[LCR]] – LCR indicating which of the user's devices will be used to dial out.
* [[Tariffs | Tariff]] – prices for the user.
* [[Balance and Credit | Balance]] – the user's balance.
* Daily Balance limit – Total balance available for user per day. If User reaches this limit all User's calls will be dropped with hangupcause '211 Low balance for user'. This limit is reset each day at midnight (00:00:00).
* [[Balance and Credit | Credit]] – the user's credit, showing how low the user's balance can go.
* [[Minimum contract billing | Minimal Charge for Calls]] - minimum charge user pays for voice calls.
* [[Minimum contract billing | Minimal Charge for Calls Date]] - date since when the previous option is valid.
* Postpaid/Prepaid – type of user.
* [[Hide Users | Not Hidden/Hidden]] – is this user hidden?
* Primary device – the primary device for this user.
* [[Allow loss calls]] – should loss calls be allowed for this user?
* [[Simultaneous call limitation | Call Limit]] – how many simultaneous calls the user can make?
* Max Call rate - set maximum allowed rate (price per min) when making calls (0 - unlimited)
* Default [[Currencies | Currency]] – currency which will be used to show balance, rates and prices in Users' GUI and exported files. Notice that balance (also other values) will be saved in [[Currencies |default system currency]] in DB and converted on the fly using current exchange rate - e.g. balance can change when [[Currencies#Automatic_Currency_Update |exchange rate changes]]. So your user can be surprised when he does not make calls but balance fluctuates.
* [[GUI_time_zone | Time Zone]] – time zone which will be used to show dates and time in Users' GUI and exported files
* Responsible accountant – dropdown to choose accountant responsible for user's profit. (only Admin can set Responsible accountant)
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. 
* Allow to change CallerID – with this option enabled simple user can change his devices custom CallerID.
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] 
* Show Stats from User perspective – hide intermediate Call attempts for User in Last Calls. For example, if LCR contains two Providers and first one is unreachable, then MOR tries to call second Provider. If this setting is checked, User will see only single Call attempt (through second Provider). If settings is unchecked, User will see both attempts in his Last Calls.
 

= Blocking =

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

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

More details: [[Warning balance]]
 
= Invoices =

[[Image:user_invoice_details.png]]
 

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

= Payments =

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

 
= Details =

Self-explanatory.

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

Here tax parameters are entered for the user.

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

Self-explanatory.
 

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

= Recordings =

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

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


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

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

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

= Comment =

Here you are able to write private comment about user.

User Details

2017-09-05T08:42:25Z

Robert: /* General */

=Where to find user details?=

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


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

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

= General =

* Username – username for user to login to MOR GUI.
* Password – password for user to login to MOR GUI. Password must contain at least one numeric value, capital and lowercase symbol. '''Note''': To use simple passwords turn off setting in various section called '''Use strong passwords for users'''
* [[Users#User_types | User type]] – by default it is "user".
* [[LCR]] – LCR indicating which of the user's devices will be used to dial out.
* [[Tariffs | Tariff]] – prices for the user.
* [[Balance and Credit | Balance]] – the user's balance.
* Daily Balance limit – Total balance available for user per day. If User reaches this limit all User's calls will be dropped with hangupcause '211 Low balance for user'. This limit is reset each day at midnight (00:00:00).
* [[Balance and Credit | Credit]] – the user's credit, showing how low the user's balance can go.
* [[Minimum contract billing | Minimal Charge for Calls]] - minimum charge user pays for voice calls.
* [[Minimum contract billing | Minimal Charge for Calls Date]] - date since when the previous option is valid.
* Postpaid/Prepaid – type of user.
* [[Hide Users | Not Hidden/Hidden]] – is this user hidden?
* Primary device – the primary device for this user.
* [[Allow loss calls]] – should loss calls be allowed for this user?
* [[Simultaneous call limitation | Call Limit]] – how many simultaneous calls the user can make?
* Max Call rate - set maximum allowed rate (price per min) when making calls (0 - unlimited)
* Default [[Currencies | Currency]] – currency which will be used to show balance, rates and prices in Users' GUI and exported files. Notice that balance (also other values) will be saved in [[Currencies |default system currency]] in DB and converted on the fly using current exchange rate - e.g. balance can change when [[Currencies#Automatic_Currency_Update |exchange rate changes]]. So your user can be surprised when he does not make calls but balance fluctuates.
* [[GUI_time_zone | Time Zone]] – time zone which will be used to show dates and time in Users' GUI and exported files
* Responsible accountant – dropdown to choose accountant responsible for user's profit. (only for Admin)
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. 
* Allow to change CallerID – with this option enabled simple user can change his devices custom CallerID.
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] 
* Show Stats from User perspective – hide intermediate Call attempts for User in Last Calls. For example, if LCR contains two Providers and first one is unreachable, then MOR tries to call second Provider. If this setting is checked, User will see only single Call attempt (through second Provider). If settings is unchecked, User will see both attempts in his Last Calls.
 

= Blocking =

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

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

More details: [[Warning balance]]
 
= Invoices =

[[Image:user_invoice_details.png]]
 

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

= Payments =

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

 
= Details =

Self-explanatory.

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

Here tax parameters are entered for the user.

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

Self-explanatory.
 

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

= Recordings =

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

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


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

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

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

= Comment =

Here you are able to write private comment about user.

File:M2 load stats.png

2017-09-05T07:57:19Z

Robert: uploaded a new version of "File:M2 load stats.png"

File:M2 load stats.png

2017-09-05T07:56:16Z

Robert: uploaded a new version of "File:M2 load stats.png"

File:M2 Load Stats Refine.png

2017-09-05T07:54:40Z

Robert: uploaded a new version of "File:M2 Load Stats Refine.png"

File:M2 Load Stats Refine.png

2017-09-05T07:54:04Z

Robert: uploaded a new version of "File:M2 Load Stats Refine.png"

M4 Load Stats

2017-09-05T07:51:55Z

Robert: /* Usage */

=Description=
Load stats help to check and find how the server is loaded during a certain time period.
 
Statistics are shown from the date you specify till the current day, e.g. if you choose 28th of January and today is 31th of January, the graph will show statistics of four days.
 
=Usage=

Go to '''REPORTS –> Load Stats'''
 
You can Refine the search results by providing a Date, a User and their Devices and a Server.
 
[[File:M2 Load Stats Refine.png]]
 
And here you will see the chart:
 
[[Image:m2_load_stats.png]]

File:M2 load stats.png

2017-09-05T07:51:40Z

Robert: uploaded a new version of "File:M2 load stats.png"

File:M2 Load Stats Refine.png

2017-09-05T07:49:37Z

Robert:

File:Sim calls stats.png

2017-09-05T07:36:16Z

Robert: uploaded a new version of "File:Sim calls stats.png"

File:Sim calls stats.png

2017-09-05T07:35:33Z

Robert: uploaded a new version of "File:Sim calls stats.png"

Number Pool

2017-09-05T06:50:26Z

Robert: /* Number Pool as Blacklist / Whitelist */

=Description=

Number Pool is array of various numbers. Number Pool can be used for Device or Provider as CallerIDs. This functionality gives you an ability to send different caller number on each Call. When Number Pool is chosen as CallerID in Device or Provider, during the Call system takes random number from all array of numbers which belongs to selected Number Pool. It is useful if you want to send different CallerID on each Call even if it is made from same Device. 
Number Pools are also used in [[ Static_Blacklist_and_Whitelist_functionality#Blacklists_.2F_Whitelists | Static Blacklist/Whitelist]] to deny/allow specific numbers or prefixes.

=Usage=

Go to '''SETTINGS –> Billing –> Functions –> Number Pools'''
 
[[File:number_pool_path.png]]
 
Here you are able to see list of all Number Pools which you have:
 
[[File:number_pool_list.png]]
 
Also you can [[Image:icon_add.png]]'''Add new Number Pool''', [[image:icon_edit.png]] edit or delete old one. Click on details icon to see array of numbers in chosen Number Pool.
 
[[File:number_pool_numbers.png]]
 
Here you are able to import new numbers (any number, leading "+" or "#" or a "%" wildcard is allowed in a number), delete the old ones or search for specific ones in a list. Wildcards such as "%" or "_" are available to use in the search form (e.g. search for "370%" will result in finding all numbers that begin with 370). If it is necessary to search for numbers such as "370%", the wildcard has to be escaped: "370\%".
 
== Number Pool as Device CallerID ==

Go to [[Device settings]] and choose Number Pool as CallerID
 
[[File:device_callerid.png]]
 
== Number Pool as Provider CallerID ==

Go to [[Providers|Provider settings]] and choose Number Pool as CallerID
 
[[File:provider_callerid.png]]
 
==Number Pool as Blacklist / Whitelist ==

Go to [[User_Details#Blacklists_.2F_Whitelists|User settings]] or [[Providers#Blacklist.2FWhitelist | Provider settings]] and choose Number Pool as Blacklist / Whitelist. 
'''Note:''' when using Number Pools for Blacklist/Whitelist, it is possible to upload prefixes. To do so, just import prefixes with percent (%) or pound (#) sign at the end (example: '''370%''' will act as prefix for 370xxxxxxxx number or '''370########''' each # represents ONE digit so using it this way you can determine the length of acceptable CallerIDs ). '''Note:''' It is posible to upload 'empty' word, that means CLI is empty.
 
[[Image:user_blacklists_details.png]]
 

=See also=

* [[Devices]]
* [[Providers]]

CLIs (Incoming CallerIDs)

2017-09-05T06:44:03Z

Robert: /* Description */

=Description=

CLI or CallerID is a number from which a user can dial MOR. From MOR x10 user also can dial MOR by providing domain. These values are used when the user is dialing into MOR through Trunk/Provider with ANI (Automatic Number Identification).

It is important to understand that CLI or domain is not the CallerID that is put on a call that goes out of the system.

CLI or domain is the CallerID for a call that is COMING INTO the system.

It is mainly used to AUTHENTICATE the caller.
If only CLI is set, then MOR will authenticate calls just by CLI.
If only domain is set, then MOR will authenticate calls only by domain.
If both CLI and domain are set, then MOR will authenticate calls either by CLI OR by domain.

<big>'''IMPORTANT! CLIs should be in E.164 format!'''</big>
 

=Usage=

You can reach the main CLI window in Devices list by clicking [[Image:icon_clis.png]] icon or by going straight to '''SETTINGS –> Users –> Devices –> CLIs''' page.
 
[[Image:clis_path.png]]
 
Here you are able to see all CLIs of system.
 
[[Image:clis_list.png]]
 
'''NOTE''' that if you will come from Devices list, CLIs page will show specific Device CLIs (you can see that in search box)
 
Click [[Image:icon_add.png]]'''Add new CLI''' to create new CLI or click on [[image:icon_edit.png]] icon to change settings of existing CLI.
 
=See also=

* [[ANI/CLI ban system]]

CLIs (Incoming CallerIDs)

2017-09-05T06:41:42Z

Robert: /* Description */

=Description=

CLI or CallerID is a number from which a user can dial MOR. From MOR x10 user also can dial MOR by providing domain. These values are used when the user is dialing into MOR through Trunk/Provider with ANI (Automatic Number Identification).

It is important to understand that CLI or domain is not the CallerID that is put on a call that goes out of the system.

CLI or domain is the CallerID for a call that is COMING INTO the system.

It is mainly used to AUTHENTICATE the caller.

<big>'''IMPORTANT! CLIs should be in E.164 format!'''</big>
 

=Usage=

You can reach the main CLI window in Devices list by clicking [[Image:icon_clis.png]] icon or by going straight to '''SETTINGS –> Users –> Devices –> CLIs''' page.
 
[[Image:clis_path.png]]
 
Here you are able to see all CLIs of system.
 
[[Image:clis_list.png]]
 
'''NOTE''' that if you will come from Devices list, CLIs page will show specific Device CLIs (you can see that in search box)
 
Click [[Image:icon_add.png]]'''Add new CLI''' to create new CLI or click on [[image:icon_edit.png]] icon to change settings of existing CLI.
 
=See also=

* [[ANI/CLI ban system]]

File:Clis list.png

2017-09-05T06:34:53Z

Robert: uploaded a new version of "File:Clis list.png"

File:Select responsible manager.png

2017-09-04T11:58:35Z

Robert:

Number Pool

2017-09-04T05:59:04Z

Robert:

=Description=

Number Pool is array of various numbers. Number Pool can be used for Device or Provider as CallerIDs. This functionality gives you an ability to send different caller number on each Call. When Number Pool is chosen as CallerID in Device or Provider, during the Call system takes random number from all array of numbers which belongs to selected Number Pool. It is useful if you want to send different CallerID on each Call even if it is made from same Device. 
Number Pools are also used in [[ Static_Blacklist_and_Whitelist_functionality#Blacklists_.2F_Whitelists | Static Blacklist/Whitelist]] to deny/allow specific numbers or prefixes.

=Usage=

Go to '''SETTINGS –> Billing –> Functions –> Number Pools'''
 
[[File:number_pool_path.png]]
 
Here you are able to see list of all Number Pools which you have:
 
[[File:number_pool_list.png]]
 
Also you can [[Image:icon_add.png]]'''Add new Number Pool''', [[image:icon_edit.png]] edit or delete old one. Click on details icon to see array of numbers in chosen Number Pool.
 
[[File:number_pool_numbers.png]]
 
Here you are able to import new numbers (any number, leading "+" or "#" or a "%" wildcard is allowed in a number), delete the old ones or search for specific ones in a list. Wildcards such as "%" or "_" are available to use in the search form (e.g. search for "370%" will result in finding all numbers that begin with 370). If it is necessary to search for numbers such as "370%", the wildcard has to be escaped: "370\%".
 
== Number Pool as Device CallerID ==

Go to [[Device settings]] and choose Number Pool as CallerID
 
[[File:device_callerid.png]]
 
== Number Pool as Provider CallerID ==

Go to [[Providers|Provider settings]] and choose Number Pool as CallerID
 
[[File:provider_callerid.png]]
 
==Number Pool as Blacklist / Whitelist ==

Go to [[User_Details#Blacklists_.2F_Whitelists|User settings]] or [[Providers#Blacklist.2FWhitelist | Provider settings]] and choose Number Pool as Blacklist / Whitelist. 
'''Note:''' when using Number Pools for Blacklist/Whitelist, it is possible to upload prefixes. To do so, just import prefixes with percent (%) or pound (#) sign at the end (example: '''370%''' will act as prefix for 370xxxxxxxx number or '''370########''' each # represents ONE digit so using it this way you can determine the length of acceptable CallerIDs ). 
[[Image:user_blacklists_details.png]]
 

=See also=

* [[Devices]]
* [[Providers]]

File:Autodialer Stats User.png

2017-08-18T13:54:35Z

Robert: uploaded a new version of "File:Autodialer Stats User.png"

M4 Tariffs

2017-08-10T06:25:40Z

Robert:

=Description=

Tariffs are sets of Rates (prices) to different Destinations. There is supported just one type off Tariffs and it is '''Wholesale'''. In Wholesale Tariffs, Rates can be set to every Destination possible.
 
=Usage=

Go to '''Billing > Tariffs''' and here you will see all tariffs list grouped by Buy and Sell Tariffs.
 
[[File:tariffs_list.png|1000px]]
 
In this list you can find such information as Tariff name, its Currency, how many Rates does Tariff has. Also you can check usage, how many [[M2 Termination Points | Termination Points]]/[[M2_Origination_Points|Origination Points]] are using particular Tariff. 
You can make a lot actions like manage [[M2 Rates | Rates]], make new Tariff from current Tariff, export PDF/CSV files. Also there is ability to create new Tariff without Rates or Generate new Tariff from old ones already with Rates, change Tariff for Users and Export Destinations to CSV.
 
==Tariff Generator==

This is an functionality to generate a new Tariff by combining existing ones.

Just go to '''BILLING > Tariffs''' find button '''Generate Tariff''' and press it.
 
[[File:tariff_generator.png]]
 
Here you can enter name of new Tariff, its Currency, Profit Margin percent and select from which Tariffs new one should be generated. Tariffs you can choose by Tariff names and by [[M2 Dial Peers|Dial Peers]] (all [[M2 Termination Points|Termination Point]] tariffs will be used)

All selected Tariffs will be merged into one new Tariff. If two or more Tariffs have Rates for the same Destination, then selected n-th cheast Rate (valued by system Currency) for that Destination will be chosen. If Profit Margin on selected cheapest n-th Rate is lower than Profit Margin on the cheapest Rate (for the same prefix in all selected Tariffs) then cheapest Rate with Profit Margin will be used instead on n-th cheapest Rate. All Rates will be converted to selected Currency.
 
===Exampe===

Current Rates of selected Tariffs:
 
{| class="wikitable" border="1" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #C0C0C0; padding: 0"
|-
! Destination (Prefix)
! Tariff A
! Tariff B
|-
| 370
| 0.1
| 0.05
|-
| 3705
| 0.1
| -
|-
| 3706
| 0.2
| 0.3
|-
| 888
| -
|0.8
|}
 
If in selected Tariffs there will be Destinations without Rates, Rates from Destinations with shorter Prefix will be taken. If there is no Destination with shorter Prefix, it will stay without Rate.
 
{| class="wikitable" border="1" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #C0C0C0; padding: 0"
|-
! Destination (Prefix)
! Tariff A
! Tariff B
|-
| 370
| 0.1
| 0.05
|-
| 3705
| 0.1
| '''0.05'''
|-
| 3706
| 0.2
| 0.3
|-
| 888
| -
|0.8
|}
'''NOTE''' Rate 0.05 will be treated as Rate of Prefix 3705 in Tariff B, because Prefix 370 has this Rate. Prefix 888 in Tariff A will be treated as without Rate, because there are no Prefixes in that Tariff which starts with 8.
 
If Profit Margin is 10% on 1st cheapest Rate new Tariff will have Rates as Tariff C:
 
{| class="wikitable" border="1" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #C0C0C0; padding: 0"
|-
! Destination (Prefix)
! Tariff A
! Tariff B
! Tariff C
|-
| 370
| 0.1
| 0.05
| 0.055
|-
| 3705
| 0.1
| 0.05
| 0.055
|-
| 3706
| 0.2
| 0.3
| 0.22
|-
| 888
| -
|0.8
|0.88
|}

 
If two or more rates have different minimal time, increment or connection fee value, '''max''' value will be chosen for newly created rates.

 

= Create new tariff from highest Rate, not lowest =

If you know you have 3 tariffs from which you want to create new tariff, then select to add something to the 3rd tariff, that would be the same as adding something to the highest rate.

Example:

You have 3 tariffs: A with price 3, B with price 5, C with price 1

Let's add 100% to the 3rd "CHEAPEST" rate, that would be tariff B with price 5 (ordered in increasing order: 1 3 5)

Result would be 5 + 100% = 10

This is the same as creating new tariff from the highest rate.

 
= Compare Tariffs =
This is an functionality to compare two Tariffs.

Just go to '''BILLING > Tariffs''' find button '''Compare Tariffs''' and press it.
 
[[File:M2 Compare tariffs.png]]
 

Here you can choose two Tariffs, currency and email (by default current User email). 
The result of comparison will be sent to your email. 
You will receive result in XLSX format file, like this:
 
[[File:M2 Tariffs compare result.png]]