Difference between revisions of "MOR PRO v0.6 documentation"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(80 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This section describes features already implemented into development version of MOR PRO v0.6. When MOR PRO v0.6 will be released all this info will go to the manual.
[[Image:mor06box.png|right]]
This section describes features already implemented into version of MOR PRO v0.6.  
 


==Allow loss calls==
==Allow loss calls==
Allow loss calls - this setting let's you decide - do you want to allow user to use some provider if provider's rate to some destination is lower then user's rate. Allowing such call you will pay more to provider then user pays you for such call - that means you will take loss on such call.
[[Allow loss calls]]
If this setting is no (default) - cheaper providers will not be used in dialing.
 


==CID control by DIDs==
==CID control by DIDs==
Line 16: Line 16:
The final section shows Total/Min/Max rates for each tariff. Using these values let's you see which tariff is the most expensive/cheap.  
The final section shows Total/Min/Max rates for each tariff. Using these values let's you see which tariff is the most expensive/cheap.  
NOTE: Min + Max can be not equal to Total because same provider can have MIN and MAX rates for some prefix if there're no more providers for this prefix (destination).
NOTE: Min + Max can be not equal to Total because same provider can have MIN and MAX rates for some prefix if there're no more providers for this prefix (destination).
''NOTE: this function is removed in MOR 0.7 due to huge system resources and limited usability''
==Destinations CSV==
This link in Tariffs window gets you CSV file with all Destinations/Directions. It is suitable for rate entering and importing back to MOR.




Line 22: Line 28:
API waits for HTML POST to get request data. Then it returns result in XML.
API waits for HTML POST to get request data. Then it returns result in XML.


===Invoices===
[[MOR API]] <- more details
 
 
<br>
 
 
==Addons==
 
New addons introduced in MOR PRO v0.6
 
[[MOR Addons]] <- more details
 
 
<br>
 
==Invoice by CallerID==
 
[[Invoice by CallerID]]
 
==Hide users==
 
As it is not allowed to delete users who have at least 1 call - after some time such 'non-active' users accumulate and we need to do something to them to have clear control panel.


Retrieves list of invoices in selected time period.
For that reason we just '''Hide''' them. They remain active - nothing changes for them - except we do not see them in the GUI.


====Request====
Later you can find them in '''SETTINGS - Users - Hidden'''. You can unhide them if you wish anytime.


HTML POST: http://<SERVER IP>/mor/api/invoices?u=username&p=password&from=1188604800&till=1191196799&lang=en
To hide a user go to his details and select '''Hidden'''. To unhide - '''Not hidden'''.


Here:
* username/password - of the user who is asking for the invoices. If user has 'admin' rights - he will get all invoices from selected period, if user has 'user' rights - he will get only his invoices in selected period.
* 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 in which language do you want to get invoice details (mainly 'Calls').


====Example result====
<br>
----
<br>


<Invoices from="2007-09-01" till="2007-10-01">
  <Invoice agreementnumber="0000000000" user_id="0" clientid="240887380">
    <Product>
      <Name>Monthly fee - test</Name>
      <Quantity></Quantity>
      <Price>10.0</Price>
    </Product>
  </Invoice>
  <Invoice agreementnumber="0000000000" user_id="0" clientid="240887380">
    <Product>
      <Name>Calls</Name>
      <Quantity>65</Quantity>
      <Price>112.3324</Price>
    </Product>
  </Invoice>
</Invoices>


====Errors====
=Hangupcause codes=


<Error>user not found</Error>
[[Hangupcause Codes]]


<Error>no invoices found</Error>


<br>
----
<br>


==Invoice by CallerID==
=Active Calls=
 
[[Active Calls]]
 
<br>
----
<br>
 
=Quick Forwards=
 
[[Quick Forwards]]
 
<br>
----
<br>
 
=Destination to create from CSV=
 
When importing rates from CSV file now you can check which Destinations will be created automatically.
 
You can view them in separate window when you press '''List''' in step 4 in field '''Destinations to create'''.
 
Such destinations do not exist in MOR database and MOR will create them when importing rate file.
 
'''IMPORTANT! DO NOT FORGET TO ADD THEM TO APPROPRIATE DESTINATION GROUP LATER!!!'''


This type of invoice groups all calls by CallerID.


It looks like this:
<br>
----
<br>


Client number: 37052058393


Number Date Duration Rate Price Destination
37063042439 2007-12-01 16:21:03 00:00:20 0.7597 0.2532 Lithuania
...
37068723423 2007-12-14 12:50:17 00:00:22 0.7597 0.2785 Lithuania
                    Lithuania 150.4886 LTL (Without VAT)
                    Total: 150.4886 LTL (Without VAT)


Client number: 37063042438
=Device details=
Number Date Duration Rate Price Destination
37068723423 2007-12-01 14:45:14 00:03:20 0.7597 2.5322 Lithuania
...
37065017476 2007-12-13 21:31:14 00:04:11 0.7597 3.1779 Lithuania
                    Lithuania 26.9805 LTL (Without VAT)
                    Total: 26.9805 LTL (Without VAT)


                    Monthly fee - test memo2 10.0000 LTL (Without VAT)
This window shows all fields from database table devices to some particular device. It is only read-only.  
                    TOTAL TO PAY: 187.4692 LTL


==Hide users==
It can help to troubleshoot login problems for device.


As it is not allowed to delete users who have at least 1 call - after some time such 'non-active' users accumulate and we need to do something to them to have clear control panel.


For that reason we just '''Hide''' them. They remain active - nothing changes for them - except we do not see them in the GUI.
<br>
----
<br>


Later you can find them in '''SETTINGS - Users - Hidden'''. You can unhide them if you wish anytime.
=VoiceMail configuration=


To hide a user go to his details and select '''Hidden'''. To unhide - '''Not hidden'''.
[[Voicemail]]




Line 104: Line 125:
<br>
<br>


=Addons=
=Provider with ANI=


==Reseller addon==
[[Provider with ANI]]


This addon incorporates basic reseller support into MOR PRO
==Similar scenario which can't be used with ANI for Provider==


Currently it lets to create user with type 'reseller'
If you have access number as DID, you can enter p(pause) after your DID calling to the provider and then enter destination. But that's totally different scenario. It should be configured with DID + Auth. by ANI DialPlan, because destination is send to MOR by DTMF, not by provider as in previous example.


When this user logs into the system he is able to:
Example:  


# Create tariffs
* If your DID is: 234567890 and you want to dial dst: 987654321 in your mobile phone (example) you enter:  234567890p987654321
# Create users
* That way call will reach MOR, when p (pause) is reached - MOR will play "please enter destination" and 987654321 will be sent by DTMF to MOR.
# Assign tariffs to users
# View calls and other stats for his own users


When his users are making calls - reseller's balance decreases along with user's balance.
=Provider timeout=


===DIDs===
This setting lets set how long this provider should be dialed before giving up. '''Default''' value is 60 seconds. '''Minimum''' value is 30 seconds.


Currently DIDs can be assigned only by admin. E.g. reseller can't assign DID to his user. Example:
It can be found in '''Provider Edit''' page.


ADMIN - RESELLER - USER
=Device timeout=


ADMIN can assign DID to USER directly bypassing RESELLER.
This setting can be set under each device Edit window. It describes how long device should be trying to be reached before timeouting the call.  


NOTE: This functionality will be adjusted in the future to let resellers add DID directly.
'''Default''' value is 60 seconds. '''Minimum''' value is 10 seconds.


=WebMoney integration=


=Hangupcause codes=


MOR application saves hangupcause codes to DB so it is easy to check what was an error and why call failed.


<table>
[[Webmoney]]
<tr>
 
  <td> <b>Code</b> </td>
=Process SIPCHANINFO=
  <td> <b>Cause</b> </td>
 
</tr>
[[SIP debug info]]
<tr>
  <td> 200 </td>
  <td> MOR can't determine who is calling </td>
</tr>
<tr>
  <td> 201 </td>
  <td> User is blocked </td>
</tr>
<tr>
  <td> 202 </td>
  <td> Reseller is blocked </td>
</tr>
<tr>
  <td> 203 </td>
  <td> No rates for user </td>
</tr>
<tr>
  <td> 204 </td>
  <td> No suitable providers found </td>
</tr>
<tr>
  <td> 205 </td>
  <td> MOR PRO not authorized to work on this computer </td>
</tr>
<tr>
  <td> 210 </td>
  <td> Balance > 0, but not enough to make call 1s in length </td>
</tr>
<tr>
  <td> 211 </td>
  <td> Low balance for user </td>
</tr>
<tr>
  <td> 212 </td>
  <td> Too low balance for more simultaneous calls </td>
</tr>
<tr>
  <td> 213 </td>
  <td> Low balance for DID owner </td>
</tr>
<tr>
  <td> 214 </td>
  <td> Too low balance for DID owner for more simultaneous calls </td>
</tr>
<tr>
  <td> 215 </td>
  <td> Low balance for reseller </td>
</tr>
<tr>
  <td> 216 </td>
  <td> Too low balance for reseller for more simultaneous calls </td>
</tr>


</table>
=Logo upload=


Standard hangup codes can be found [http://www.voip-info.org/wiki/index.php?page=Asterisk+variable+hangupcause here].
[[Logo change]]

Latest revision as of 19:11, 26 March 2009

Mor06box.png

This section describes features already implemented into version of MOR PRO v0.6.


Allow loss calls

Allow loss calls

CID control by DIDs

This setting let's you control what CID user can enter in his devices. These CID numbers should be from the set of device's DIDs. It is mainly used when user's PBX is connected over trunk and many DIDs are routed to this Trunk. Calls coming out from this PBX must have CallerID Number from the set of DIDs assigned to this Trunk (PBX). If CID from DIDs is checked - system checks if device's cid number is from dids assigned to this device. If no dids are assigned - this value is ignored. In order for this setting to be active - CID Name/Number fields must be empty to allow user enter any CID number he wants. If CID from DIDs is checked and user enters any CID (not from his DIDs) - system will change his CID by his first available DID (selected from database by lowest id).


Tariff analysis

Using this tool you can select the tariffs (wholesale) which you want to compare. Click on desired tariffs and select currency in which you want to compare tariffs. When you selected tariffs press on Generate CSV icon to get CSV file. In this file you can see all selected tariffs with their rates for ALL destinations. In 4 last columns you will find MIN and MAX rates for each destination with their providers. This let's you compare tariffs on the fly. The final section shows Total/Min/Max rates for each tariff. Using these values let's you see which tariff is the most expensive/cheap. NOTE: Min + Max can be not equal to Total because same provider can have MIN and MAX rates for some prefix if there're no more providers for this prefix (destination).

NOTE: this function is removed in MOR 0.7 due to huge system resources and limited usability

Destinations CSV

This link in Tariffs window gets you CSV file with all Destinations/Directions. It is suitable for rate entering and importing back to MOR.


API

API waits for HTML POST to get request data. Then it returns result in XML.

MOR API <- more details




Addons

New addons introduced in MOR PRO v0.6

MOR Addons <- more details



Invoice by CallerID

Invoice by CallerID

Hide users

As it is not allowed to delete users who have at least 1 call - after some time such 'non-active' users accumulate and we need to do something to them to have clear control panel.

For that reason we just Hide them. They remain active - nothing changes for them - except we do not see them in the GUI.

Later you can find them in SETTINGS - Users - Hidden. You can unhide them if you wish anytime.

To hide a user go to his details and select Hidden. To unhide - Not hidden.





Hangupcause codes

Hangupcause Codes




Active Calls

Active Calls



Quick Forwards

Quick Forwards



Destination to create from CSV

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

You can view them in separate window when you press List in step 4 in field Destinations to create.

Such destinations do not exist in MOR database and MOR will create them when importing rate file.

IMPORTANT! DO NOT FORGET TO ADD THEM TO APPROPRIATE DESTINATION GROUP LATER!!!





Device details

This window shows all fields from database table devices to some particular device. It is only read-only.

It can help to troubleshoot login problems for device.




VoiceMail configuration

Voicemail




Provider with ANI

Provider with ANI

Similar scenario which can't be used with ANI for Provider

If you have access number as DID, you can enter p(pause) after your DID calling to the provider and then enter destination. But that's totally different scenario. It should be configured with DID + Auth. by ANI DialPlan, because destination is send to MOR by DTMF, not by provider as in previous example.

Example:

  • If your DID is: 234567890 and you want to dial dst: 987654321 in your mobile phone (example) you enter: 234567890p987654321
  • That way call will reach MOR, when p (pause) is reached - MOR will play "please enter destination" and 987654321 will be sent by DTMF to MOR.

Provider timeout

This setting lets set how long this provider should be dialed before giving up. Default value is 60 seconds. Minimum value is 30 seconds.

It can be found in Provider Edit page.

Device timeout

This setting can be set under each device Edit window. It describes how long device should be trying to be reached before timeouting the call.

Default value is 60 seconds. Minimum value is 10 seconds.

WebMoney integration

Webmoney

Process SIPCHANINFO

SIP debug info

Logo upload

Logo change

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_PRO_v0.6_documentation&oldid=3206"