Difference between revisions of "MOR API"
From Kolmisoft Wiki
Jump to navigationJump to search
m |
m |
||
| Line 26: | Line 26: | ||
* [[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. | ||
<br><br> | |||
==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. | ||
<br><br> | |||
==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. | ||
<br><br> | |||
==Balance== | ==Balance== | ||
| Line 40: | Line 40: | ||
* [[Balance in phone | simple_balance]] - gets user's balance | * [[Balance in phone | simple_balance]] - gets user's balance | ||
* [[Change user balance | change_user_balance]] - change user's balance | * [[Change user balance | change_user_balance]] - change user's balance | ||
<br><br> | |||
==Rate== | ==Rate== | ||
* [[MOR API rate|rate]] - check user rate for prefix. | * [[MOR API rate|rate]] - check user rate for prefix. | ||
<br><br> | |||
==Registration== | ==Registration== | ||
* [[MOR API user_register| user_register]] - create new user from params. | * [[MOR API user_register| user_register]] - create new user from params. | ||
<br><br> | |||
==Update user== | ==Update user== | ||
* [[MOR API user_update_api| user_update_api]] - update user from params. | * [[MOR API user_update_api| user_update_api]] - update user from params. | ||
<br><br> | |||
==Delete device== | ==Delete device== | ||
* [[MOR API delete_device_api| delete_device]] - delete device. | * [[MOR API delete_device_api| delete_device]] - delete device. | ||
<br><br> | |||
==Create device== | ==Create device== | ||
* [[MOR API create_device_api| device_create]] - create device. | * [[MOR API create_device_api| device_create]] - create device. | ||
<br><br> | |||
==Import XML Retail tariff== | ==Import XML Retail tariff== | ||
* [[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. | ||
<br><br> | |||
==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. | ||
<br><br> | |||
==Payments list== | ==Payments list== | ||
Revision as of 14:29, 13 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
Details
- user_details - gets user details
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
Rate
- rate - check user rate for prefix.
Registration
- user_register - create new user from params.
Update user
- user_update_api - update user from params.
Delete device
- delete_device - delete device.
Create device
- device_create - create device.
Import XML Retail tariff
- import_tariff_retail - import xml retail tariff.
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.
