Difference between revisions of "MOR API"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 115: Line 115:
==Invoices==
==Invoices==
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.
* [[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


<br>
<br>
==Login==
==Login==
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.

Revision as of 13:53, 19 September 2017

"warning"IMPORTANT!!! API methods described here are for MOR X9. For previous versions please check appropriate manual.

"api"



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


Balance

Various methods to retrieve User balance


Callback

NOTE: Callback addon is needed. Does not work on limited version.


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


Currencies


Device




DID


Email


Financial statements


Invoices


Login


Monitorings


Payments


PBX Pool


Phonebooks


Quickforwards


Rates


Recordings


Resellers


Services


SMS

NOTE: SMS addon is need to have these APIs


Statistics



Subscriptions


User


Version


Vouchers


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