Difference between revisions of "MOR API"
(→SMS) |
(→DID) |
||
(20 intermediate revisions by 11 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 | [[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 55: | 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. | |||
<br> | <br> | ||
Line 67: | 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> | ||
Line 72: | Line 79: | ||
* [[MOR API device create| device_create]] – create device | * [[MOR API device create| device_create]] – create device | ||
* [[MOR_API_device_update | device_update]] – | * [[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 | ||
Line 91: | 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 | |||
* [[MOR API did close|did_close]] – close the DID | |||
<br> | <br> | ||
Line 107: | Line 121: | ||
==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 121: | Line 137: | ||
* [[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 140: | Line 160: | ||
* [[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 151: | Line 179: | ||
==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. | ||
Line 175: | Line 204: | ||
* [[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> | ||
== | ==Version== | ||
* [[MOR API | * [[MOR API system version get| system_version_get]] (get_version) – get MOR version number. | ||
<br> | <br> | ||
== | |||
* [[MOR API | ==Vouchers== | ||
* [[MOR API voucher use| voucher_use]] – use selected voucher. | |||
<br> | <br> |
Revision as of 08:21, 18 March 2019
IMPORTANT!!! API methods described here are for newest MOR version. For previous versions please check appropriate manual.
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
- API Configuration – configuration options for API.
- Hash construction – how to construct hash to authenticate data over API.
Balance
- user_balance_update (change_user_balance) – changes User's Balance
Various methods to retrieve User balance
- user_balance_get (balance) – retrieves a User Balance.
- user_simple_balance_get (simple_balance) – gets User's Balance
- user_balance_get_by_psw – gets User's Balance by his owned Device's Password
- user_balance_get_by_username – gets User's Balance by his owned Device's Username
Callback
NOTE: Callback addon is needed. Does not work on limited version.
- callback_init (callback) – initiates callback.
Calling Cards
- card_by_cli_update (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
- card_from_group_sell (buy_card_from_callingroup) – sells cards from calling card group.
- card_group_get (show_calling_card_group) – show calling group info.
- card_balance_get (card_balance_get) – show card's balance.
- card_payment_add – add payment to the calling card.
- calling_cards_create – create Calling Cards.
- calling_card_update – update Calling Card.
- calling_cards_get - get Calling Cards.
- cc_group_create – create Card Group.
- cc_group_update – update Card Group.
- cc_groups_get – show Calling Cards Group info.
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
- conflines_update – changes settings for API, Default User or Default Device.
Credit notes
- credit_notes_get (credit_notes) – credit notes list.
- credit_note_update – credit note update.
- credit_note_create – credit note create.
- credit_note_delete – credit note delete.
Currencies
- exchange_rate_update - Currency Exchange rate update.
Device
- device_create – create device
- device_update – update device settings.
- device_delete (delete_device) – delete device
- devices_get (device_list) – users device list
- device_details_get – shows all information about specified device.
- device_callflow_get - returns information about specified device callflow state.
- device_callflow_update – updates information of specified device callflow state.
- cli_info_get (cli_get_info) – shows id of device where CLI belongs.
- cli_delete – deletes specified CLI.
- cli_add – creates CLI and assigns it to the specified device.
- device_clis_get – CLIs list by User and/or Device
DID
- dids_get – get list of particular DIDs
- did_create – DID create
- did_device_assign (did_assign_device) – Assign Device to DID
- did_trunk_device_assign (did_trunk_device_assign) – Assign Trunk Device to DID
- did_device_unassign (did_unassign_device) – Unassign Device from DID
- did_details_update (did_details_update) – Update DID details
- did_subscription_stop – STOP DID subscription
- did_terminate – DID terminate
- did_make_free – DID make free
- did_rates_update – Update DID rates
- did_rates_get – Get DID rates
- did_close – close the DID
- email_send (send_email) – send Email.
Financial statements
- financial_statements_get (financial_statements) – financial statements list.
Invoices
- invoices_get (invoices) – retrieves a list of invoices in a selected time period.
- invoice_update - update Invoice
Login
- user_login (login) – logs user in to MOR.
- user_logout (logout) – logs user out from MOR.
Monitorings
- ma_activate – turn on monitorings addon
Payments
- payment_create (create_payment) – create payment.
- payments_get (payments_list) – payments list.
PBX Pool
- pbx_pool_create – PBX Pool create.
Phonebooks
- phonebooks_get (phonebooks_api ) – phonebooks list.
- phonebook_edit (phonebook_edit_api) – edit phonebook.
- phonebook_record_create – create phonebook.
Quickforwards
- quickforwards_dids_get (quickforwards_dids_get) – get Quickforwards.
- quickforwards_did_update (quickforwards_did_update) – update Quickforwards.
- quickforwards_did_delete (quickforwards_did_delete) – delete Quickforwards.
Rates
- rate_get (rate) – check user rate by prefix
- tariff_rates_get (get_tariff) – get all tariff's rates
- tariff_retail_import (import_relail_tariff) – import xml retail tariff
- tariff_wholesale_update (wholesale_tariff) – update or create wholesale tariff
Recordings
- recordings_get – get MOR recordings.
Resellers
- MOR API reseller group create - create new Reseller Group
Services
- service_create – create Service.
- service_delete – delete Service.
- services_get – get Services.
- service_update – update Service.
SMS
NOTE: SMS addon is need to have these APIs (SMS add-on is no longer supported, new functionality will not be developed)
- sms_send (send_sms) – send SMS.
- user_sms_service_subscribe – User subscription to SMS Service.
- user_sms_get – Retrieves a list of SMS in a selected time period for a user/device.
Statistics
- quickstats_get – gets today's Quick Stats and Active Calls count
Subscriptions
- subscription_delete - Subscription delete.
- subscriptions_get - Subscriptions get.
- subscription_create - Subscription create.
- subscription_update - Subscription delete.
User
- user_register – create new user from params.
- user_details_get (user_details) – gets user details.
- user_details_update (user_update_api) – update user from params.
- users_get - get user list
Version
- system_version_get (get_version) – get MOR version number.
Vouchers
- voucher_use – use selected voucher.
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:
- Value of money will be returned in Default System Currency.
- Date will not be affected of Default date format setting.
- Value of money will not be affected of Number digits setting.