Difference between revisions of "MOR API"

From Kolmisoft Wiki
Jump to navigationJump to search
(18 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X9. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>
[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for newest MOR version. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>
[[File:api.png|right|alt="api"|link=]]
[[File:api.png|right|alt="api"|link=]]
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta>
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta>
Line 57: Line 57:
==Calls==
==Calls==
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.
* [[MOR API local calls get|local_calls_get]] - retrieves a list of local calls in a selected time period for a user.
* [[MOR_API_active_calls_get|active_calls_get]] - Retrieves list of active calls for specified User.


<br>
<br>
Line 90: Line 92:
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device
<br>
* [[MOR API device rules get | device_rules_get]] – show Device Rules.
* [[MOR API device rule delete | device_rule_delete]] – delete Device Rule.
* [[MOR API device rule create | device_rule_create]] – create Device Rule.
<br>
<br>


Line 97: Line 103:
* [[MOR API did_create| did_create]] – DID create
* [[MOR API did_create| did_create]] – DID create
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_trunk_device_assign| did_trunk_device_assign]] (did_trunk_device_assign) – Assign Trunk Device to DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details  
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details  
Line 102: Line 109:
* [[MOR API did terminate|did_terminate]] – DID terminate
* [[MOR API did terminate|did_terminate]] – DID terminate
* [[MOR API did make free|did_make_free]] – DID make free
* [[MOR API did make free|did_make_free]] – DID make free
* [[MOR API did rates update|did_rates_update]] – Update DID rates
* [[MOR API did rates get|did_rates_get]] – Get DID rates
* [[MOR API did close|did_close]] – close the DID


<br>
<br>
Line 115: Line 126:
==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>
==IVR==
* [[MOR_API_ivr_dial_plan_update|ivr_dial_plan_update]] (invoices) – Updates IVR dial plan.
* [[MOR_API_ivr_time_period_update|ivr_time_period_update]] (invoices) – Updates IVR time period.


<br>
<br>
==Location Rules==
* [[MOR API location_rule_create|location_rule_create]] – creates location rule.
* [[MOR API location_rule_update|location_rule_update]] – updates location rule.
* [[MOR API location_rules_get|location_rules_get]] – retrieves location rules.
* [[MOR API location_rule_get|location_rule_get]] – retrieves location rule information.
* [[MOR API location_rule_copy|location_rule_copy]] – copies rule from one location to other one.
* [[MOR API location_rule_delete|location_rule_delete]] – delete location rule.
<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.
Line 171: Line 198:


==SMS==
==SMS==
NOTE: SMS addon is need to have these APIs
NOTE: SMS addon is need to have these APIs (SMS add-on is no longer supported, new functionality will not be developed)
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.

Revision as of 10:59, 16 April 2019

"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


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.
  • 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


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 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