Difference between revisions of "MOR API"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(10 intermediate revisions by 4 users not shown)
Line 23: Line 23:
* [[API Configuration]] – configuration options for API.
* [[API Configuration]] – configuration options for API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.
<br>
==Aggregate==
* [[MOR API aggregate get | aggregate_get]] - for getting MOR aggregate statistics.


<br>
<br>
Line 122: Line 127:
* [[MOR API did rates get|did_rates_get]] – Get DID rates
* [[MOR API did rates get|did_rates_get]] – Get DID rates
* [[MOR API did close|did_close]] – close the DID
* [[MOR API did close|did_close]] – close the DID
* [[MOR API did delete|did_delete]] – delete the DID
* [[MOR API did rates details get|did_rates_details_get]] – Get DID rates details
* [[MOR API did rates details update|did_rates_details_update]] – Update DID rates details




Line 146: Line 154:
==LCR==
==LCR==
* [[MOR API lcrs_get|lcrs_get]] - retrieves list of LCRs.
* [[MOR API lcrs_get|lcrs_get]] - retrieves list of LCRs.
* [[MOR API lcr_create|lcr_create]] - creates LCR
* [[MOR API lcr_update|lcr_update]] - updates LCR
* [[MOR API lcr_delete|lcr_delete]] - updates LCR
* [[MOR API lcr_add_provider|lcr_add_provider]] - adds provider to LCR
* [[MOR API lcr_delete_provider|lcr_delete_provider]] - deletes provider from LCR


<br>
<br>
==Location Rules==
==Location Rules==
* [[MOR API location_rule_create|location_rule_create]] – creates location rule.
* [[MOR API location_rule_create|location_rule_create]] – creates location rule.
Line 197: Line 211:
* [[MOR API provider delete| provider_delete]]  – delete provider.
* [[MOR API provider delete| provider_delete]]  – delete provider.
<br>
<br>
=== Provider Rules===
* [[MOR_API_provider_rules_get| provider_rules_get]] - shows provider rules
* [[MOR_API_provider_rules_get| provider_rules_get]] - shows provider rules
* [[MOR_API_provider_rule_delete| provider_rules_delete]] - deletes provider rules
* [[MOR_API_provider_rule_delete| provider_rules_delete]] - deletes provider rules
Line 246: Line 261:
* [[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.
* [[MOR_API_user_sms_get | user_sms_get ]] – Retrieves a list of SMS in a selected time period for a user/device.
* [[MOR_API_user_sms_get | user_sms_get ]] – Retrieves a list of SMS in a selected time period for a user/device.
<br>
==Spy==
* [[MOR API spy_call | spy_call]] – Initiates a spy call.


<br>
<br>
Line 260: Line 280:
* [[MOR API subscription create|subscription_create]] - Subscription create.
* [[MOR API subscription create|subscription_create]] - Subscription create.
* [[MOR API subscription create bulk|subscription_create_bulk]] - Bulk Subscription create.
* [[MOR API subscription create bulk|subscription_create_bulk]] - Bulk Subscription create.
* [[MOR API subscription update|subscription_update]] - Subscription delete.
* [[MOR API subscription update|subscription_update]] - Subscription update.
* [[MOR API Subscription Flat Rate Number Status Get| subscription_flat_rate_number_status_get]] -  check prefix covering flat-rate subscriptions
* [[MOR API Subscription Flat Rate Number Status Get| subscription_flat_rate_number_status_get]] -  check prefix covering flat-rate subscriptions
<br>
<br>

Latest revision as of 07:31, 22 January 2024

"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


Aggregate


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


LCR


Location Rules


Login


Monitorings


Number Pools


Payments


PBX Pool


Phonebooks


Providers


Provider Rules


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)


Spy


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