MOR API

From Kolmisoft Wiki

Jump to: navigation, search

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

"api"



Contents

[edit] 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.



[edit] MOR users that are allowed to use MOR API

  • Admin
  • Reseller
  • Accountant - only by using Admin Hash and Secret key
  • Simple User



[edit] Functions

[edit] API Related


[edit] Balance

Various methods to retrieve User balance


[edit] Callback

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


[edit] Calling Cards


[edit] Calls

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


[edit] Conflines

  • conflines_update – changes settings for API, Default User or Default Device.


[edit] Credit notes


[edit] Currencies


[edit] Device




[edit] DID


[edit] Email


[edit] Financial statements


[edit] Invoices

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


[edit] Login


[edit] Monitorings


[edit] Payments


[edit] PBX Pool


[edit] Phonebooks


[edit] Quickforwards


[edit] Rates


[edit] Recordings


[edit] Resellers


[edit] Services


[edit] SMS

NOTE: SMS addon is need to have these APIs


[edit] Statistics



[edit] Subscriptions


[edit] User


[edit] Version


[edit] Vouchers


[edit] Examples



[edit] 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.

[edit] 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:



[edit] See also

Personal tools

Try MOR

Try M2