Difference between revisions of "MOR API"
From Kolmisoft Wiki
Jump to navigationJump to search
(→Rate) |
|||
| Line 27: | Line 27: | ||
* [[MOR API callback|callback]] - initiates callback. | * [[MOR API callback|callback]] - initiates callback. | ||
* [[MOR API c2c_callback|c2c_callback]] - initiates Click2Call specific callback. | * [[MOR API c2c_callback|c2c_callback]] - initiates Click2Call specific callback. | ||
==Accounting== | ==Accounting== | ||
* [[MOR API invoices|invoices]] - retrieves a list of invoices in a selected time period. | * [[MOR API invoices|invoices]] - retrieves a list of invoices in a selected time period. | ||
==Calls== | ==Calls== | ||
* [[MOR API user_calls|user_calls]] - retrieves a list of calls in a selected time period for a user/device. | * [[MOR API user_calls|user_calls]] - retrieves a list of calls in a selected time period for a user/device. | ||
==Balance== | ==Balance== | ||
| Line 43: | Line 42: | ||
* [[Change user balance | change_user_balance]] - change user's balance | * [[Change user balance | change_user_balance]] - change user's balance | ||
==Rates== | ==Rates== | ||
| Line 49: | Line 47: | ||
* [[MOR API get_tariff| get_tariff]] - get all tariff's rates | * [[MOR API get_tariff| get_tariff]] - get all tariff's rates | ||
* [[MOR API import_xml_retail_tariff_api| import_tariff_retail]] - import xml retail tariff | * [[MOR API import_xml_retail_tariff_api| import_tariff_retail]] - import xml retail tariff | ||
==Device== | ==Device== | ||
| Line 57: | Line 53: | ||
* [[MOR API delete_device_api| delete_device]] - delete device | * [[MOR API delete_device_api| delete_device]] - delete device | ||
==Phonebooks== | ==Phonebooks== | ||
* [[MOR API phonebooks_api| phonebooks_api]] - phonebooks list. | * [[MOR API phonebooks_api| phonebooks_api]] - phonebooks list. | ||
* [[MOR API phonebook_edit_api| phonebook_edit_api]] - edit phonebook. | * [[MOR API phonebook_edit_api| phonebook_edit_api]] - edit phonebook. | ||
==Payments list== | ==Payments list== | ||
Revision as of 14:41, 21 December 2011
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.
Functions
API Related
- API Configuration - configuration options for API.
- Hash construction - how to construct hash to authenticate data over API.
Login
User
- user_register - create new user from params.
- user_details - gets user details
- user_update_api - update user from params.
Callback
- callback - initiates callback.
- c2c_callback - initiates Click2Call specific callback.
Accounting
- invoices - retrieves a list of invoices in a selected time period.
Calls
- user_calls - retrieves a list of calls in a selected time period for a user/device.
Balance
- balance - retrieves a user balance.
- simple_balance - gets user's balance
- change_user_balance - change user's balance
Rates
- rate - check user rate by prefix
- get_tariff - get all tariff's rates
- import_tariff_retail - import xml retail tariff
Device
- device_create - create device
- delete_device - delete device
Phonebooks
- phonebooks_api - phonebooks list.
- phonebook_edit_api - edit phonebook.
Payments list
- payments_list - payments list.
HTML POST
All requests are in a similar format:
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username&p=password
- username/password - 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.
