Difference between revisions of "MOR API"
| Line 71: | Line 71: | ||
2. Execute this line: <code>update calls set calldate = now();</code> | 2. Execute this line: <code>update calls set calldate = now();</code> | ||
3. Create a monitoring with low charge. See the [[Monitorings | 3. Create a monitoring with low charge. See the [[Monitorings Addon]] page for information how to do it. | ||
4. Choose sending an email. | 4. Choose sending an email. | ||
Revision as of 19:05, 2 June 2012
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
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
- wholesale_tariff - update or create wholesale tariff
Device
- device_create - create device
- delete_device - delete device
Monitorings addon
Installing ruby script
1. Connect to SQL and add email if it is still not in the database:
INSERT INTO emails (`name`, `format`, `body`, `owner_id`, `subject`, `template`, `callcenter`, `date_created`) VALUES('monitoring_activation', 'plain', x'4d6f6e69746f72696e672064657461696c733a0d0a0d0a547970653a203c253d6d6f6e69746f72696e675f74797065253e0d0a42616c616e63653a203c253d6d6f6e69746f72696e675f616d6f756e74253e0d0a426c6f636b3a203c253d6d6f6e69746f72696e675f626c6f636b253e0d0a0d0a41666665637465642075736572733a0d0a0d0a3c253d6d6f6e69746f72696e675f7573657273253e', 0,'Monitoring was activated', 1, 0, '2010-06-11 12:54:58');
2. Execute this line: update calls set calldate = now();
3. Create a monitoring with low charge. See the Monitorings Addon page for information how to do it.
4. Choose sending an email.
5. Turn on API. Specifying the key is optional, it depends on the way you execute the script.
6. Execute the script: ruby /home/mor/lib/scripts/monitoring_script.rb -ahttp://192.168.0.30/billing/api/ma_activate -p mor -umor -nmor -kkey
In this example we assume that API key is "key".
7. Check what is in /tmp/monitoring_debug.txt file. It should be similar to:
2010-06-12 10:24:19 --- STARTING MONITORING
found users size : 4 in monitoring id :1
2010-06-12 10:24:21 --- MONITORING notice send to http://192.168.0.30/billing/api/ma_activate
<?xml version="1.0" encoding="UTF-8"?>
<status>
<success>success</success>
<users>
<user>
<id>0</id>
<status> email sent</status>
</user>
<user>
<id>2</id>
<status> email sent</status>
</user>
<user>
<id>3</id>
<status> email sent</status>
</user>
<user>
<id>5</id>
<status> email sent</status>
</user>
</users>
</status>
8. Check for errors. If there is something wrong it will be showed (for example if API is off).
Phonebooks
- phonebooks_api - phonebooks list.
- phonebook_edit_api - edit phonebook.
Payments list
- payments_list - payments list.
Credit notes
- credit_notes - credit notes list.
- credit_note_update - credit note update.
- credit_note_create - credit note create.
- credit_note_delete - credit note delete.
Financial statements
- financial_statements - financial statements list.
Payments
- create_payment - create paymentt.
Calling cards
- cc_by_cli - creats and update calling cards, including adding and transferring funds, by being identified according the Caller_ID.
- buy_card_from_callingroup - solds cards from calling card group.
- show_calling_card_group - Show calling group info.
MOR version
- get_version - get MOR version number
Examples
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.
