Difference between revisions of "MOR API"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 60: Line 60:
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.
* [[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 info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.
<br><br>
<br><br>

Revision as of 06:51, 21 August 2013

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



Login



User



Callback



Accounting

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



Calls

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



Balance



Rates



Device



DID



Monitorings



Phonebooks



Payments list



Credit notes



Financial statements



Payments



Calling cards



MOR version



SMS Send



Send Email



Morphone



Quickforwards



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