MOR API

IMPORTANT!!! API methods described here are for MOR X5. 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

Functions

API Related

• API Configuration – configuration options for API.
• Hash construction – how to construct hash to authenticate data over API.

Balance

• user_balance_get (balance) – retrieves a user balance.
• user_simple_balance_get (simple_balance) – gets user's balance
• user_balance_update (change_user_balance) – change user's balance
• user_balance_get_by_psw – gets user's balance with his Device password

Callback

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

Calls

• user_calls_get (user_calls) – retrieves a list of calls in a selected time period for a user/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.

Device

• device_create – create device
• device_delete (delete_device) – delete device
• devices_get (device_list) – users device list
• 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_details_get – shows all information about specified device.
• device_update – updates location_id of selected Device.

DID

• dids_get – get list of particular DIDs
• did_create – DID create
• did_device_assign (did_assign_device) – Assign Device to DID
• did_device_unassign (did_unassign_device) – Unassign Device from DID

Email

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

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.

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

SMS Send

• sms_send (send_sms) – send SMS.

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.

Resellers

• MOR API reseller group create - create new Reseller Group

Version

• system_version_get (get_version) – get MOR version number.

Examples

• MOR API PHP 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.

See also

• API Configuration
• MOR integration
• How to block access to some API functions
• API specification to be implemented in the future