Difference between revisions of "MOR API"

From Kolmisoft Wiki
Jump to navigationJump to search
(30 intermediate revisions by 12 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 X6. 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 36: Line 36:


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


<br>
<br>
==Calling Cards==
==Calling Cards==
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
Line 46: Line 48:
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.
* [[MOR_API_cc_groups_get| cc_groups_get]] – show Calling Cards Group info.
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.
* [[MOR_API_Calling_Cards_get| calling_cards_get]] - get Calling Cards.
* [[MOR_API_Card_Group_create| cc_group_create]] – create Card Group.
* [[MOR_API_Card_Group_update| cc_group_update]] – update Card Group.
* [[MOR API Card Groups get| cc_groups_get]] – show Calling Cards Group info.
<br>
<br>


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


<br>
<br>
Line 63: Line 70:
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.
<br>
==Currencies==
* [[MOR_API_Exchange_rate_update|exchange_rate_update]] - Currency Exchange rate update.


<br>
<br>
==Device==
==Device==
* [[MOR API device create| device_create]] – create device
* [[MOR API device create| device_create]] – create device
* [[MOR_API_device_update | device_update]]  –  update device settings.
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[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 details get | device_details_get]] – shows all information about specified device.
<br>
* [[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 device callflow update | device_callflow_update]] – updates information of specified device callflow state.  
<br>
* [[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.
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.  
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.  
* [[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
* [[MOR API device details get | device_details_get]] – shows all information about specified device.
* [[MOR_API_device_update | device_update]]  –  updates location_id of selected Device.
<br>
<br>


Line 85: Line 98:
* [[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  
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription
* [[MOR API did terminate|did_terminate]] – DID terminate
* [[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


<br>
<br>
Line 101: Line 120:
==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>
<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 115: Line 136:
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.
<br>
==PBX Pool==
* [[MOR API pbx_pool_create| pbx_pool_create]] – PBX Pool create.


<br>
<br>
Line 134: Line 159:
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff
<br>
==Recordings==
* [[MOR API recordings get| recordings_get]] – get MOR recordings.
<br>
== Resellers ==
* [[MOR API reseller group create]] - create new Reseller Group


<br>
<br>
Line 145: Line 178:


==SMS==
==SMS==
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.
* [[MOR_API_user_sms_get | user_sms_get ]] – Retrieves a list of SMS in a selected time period for a user/device.
<br>
==Statistics==
* [[MOR API quickstats_get | quickstats_get]] – gets today's [[Quick Stats]] and [[Active Calls]] count
<br>


<br>
<br>
Line 161: Line 203:
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
* [[MOR API users_get| users_get]] - get user list
<br>
<br>


== Resellers ==
==Version==
* [[MOR API reseller group create]] - create new Reseller Group
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.


<br>
<br>
==Version==
 
* [[MOR API system version get| system_version_get]] (get_version) get MOR version number.
==Vouchers==
* [[MOR API voucher use| voucher_use]] – use selected voucher.


<br>
<br>

Revision as of 07:40, 4 January 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.


Conflines


Credit notes


Currencies


Device




DID



Email


Financial statements


Invoices


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