Difference between revisions of "MOR PRO v0.6 documentation"
(→API) |
|||
Line 17: | Line 17: | ||
==API== | ==API== | ||
API waits for HTML POST to get request data. Then it returns result in XML. | |||
===Invoices=== | ===Invoices=== | ||
====Request==== | |||
HTML POST: http://<SERVER IP>/mor/api/invoices?u=username&p=password&from=1188604800&till=1191196799 | HTML POST: http://<SERVER IP>/mor/api/invoices?u=username&p=password&from=1188604800&till=1191196799 |
Revision as of 15:02, 11 December 2007
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. If this setting is no (default) - cheaper providers will not be used in dialing.
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).
API
API waits for HTML POST to get request data. Then it returns result in XML.
Invoices
Request
HTML POST: http://<SERVER IP>/mor/api/invoices?u=username&p=password&from=1188604800&till=1191196799
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 Unix Epoch format. Invoice's period start should be >= from and period end <= till.
Example result
<Invoices from="2007-09-01" till="2007-10-01"> <Invoice agreementnumber="0000000000" user_id="0"> <Product> <Name>Monthly fee - test</Name> <Quantity></Quantity> <Price>10.0</Price> </Product> </Invoice> <Invoice agreementnumber="0000000000" user_id="0"> <Product> <Name>Calls</Name> <Quantity>65</Quantity> <Price>112.3324</Price> </Product> </Invoice> </Invoices>
Errors
<Error>user not found</Error>
<Error>no invoices found</Error>