Difference between revisions of "MOR API"

From Kolmisoft Wiki
Jump to navigationJump to search
m
Line 46: Line 46:


==Callback==
==Callback==
NOTE: Callback addon is needed. Does not work on limited version.
NOTE: A Callback addon is needed. Does not work on a limited version.
* [[MOR API callback init|callback_init]] (callback) – initiates callback.
* [[MOR API callback init|callback_init]] (callback) – initiates callback.


Line 263: Line 263:
* username - the user name and password of the user who is asking for the data.  
* 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.
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.
<br><br>
<br><br>
=Useful to know=
=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:
* All API methods return data straight from the database. It means that MOR GUI settings do not affect data, it will be returned as it is saved in the database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Date will not be affected by [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.
** Value of money will not be affected by [[Configuration_from_GUI#Visual|Number digits]] setting.


<br><br>
<br><br>

Revision as of 13:06, 19 April 2021

"warning"IMPORTANT!!! API methods described here are for newest MOR version. 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


Autodialer


Balance

Various methods to retrieve User balance


Callback

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


Calling Cards


Calls

  • user_calls_get (user_calls) – retrieves a list of calls in a selected time period for a user/device.
  • local_calls_get - retrieves a list of local calls in a selected time period for a user.
  • active_calls_get - Retrieves list of active calls for specified User.


Conflines


Credit notes


Currencies


Device





DID



Email


Financial statements


Invoices


IVR


Location Rules


Login


Monitorings


Payments


PBX Pool


Phonebooks


Queue


Quickforwards


Rates


Recordings


Resellers


Services


SMS

NOTE: SMS addon is need to have these APIs (SMS add-on is no longer supported, new functionality will not be developed)


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 return data straight from the database. It means that MOR GUI settings do not affect data, it will be returned as it is saved in the database. For example:



See also