Difference between revisions of "MOR API"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 22: Line 22:
<br>
<br>
==Balance==
==Balance==
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a 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
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – change user's balance
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets user's balance with his Device password
* [[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


<br>
<br>

Revision as of 16:20, 8 September 2014

Warning.pngIMPORTANT!!! API methods described here are for MOR X5. For previous versions please check appropriate manual.



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



Functions

API Related


Balance


Callback


Calling Cards


Calls

  • user_calls_get (user_calls) – retrieves a list of calls in a selected time period for a user/device.


Conflines


Credit notes


Device


DID


Email


Financial statements


Invoices

  • invoices_get (invoices) – retrieves a list of invoices in a selected time period.


Login


Monitorings


Payments


Phonebooks


Quickforwards


Rates


SMS Send


User


Resellers


Version


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:



See also