MOR API Card Groups get
From Kolmisoft Wiki
Revision as of 15:56, 13 November 2015 by Aisteb (talk | contribs) (moved MOR API cc groups get to MOR API Card Groups get)
NOTE: Available from MOR X7
Description
MOR API Calling Cards Groups get
Usage
- From MOR X7 Calling Cards Groups: /api/cc_groups_get
- Methods: POST, GET(if allowed, not recomended)
Parametres
- u - username for authentication.
- cc_group_id - Calling Cards Group ID.
- hash - SHA1 hash constructed using API_Secret_Key ( More described in Constructing hash). Required.
Request
We have: API Secret Key = secret
We send:
HTML POST: http://<SERVER_IP>/billing/api/cc_groups_get?u=admin&cc_group_id=1&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4
NOTE that username is not included in hash
Success
<page> <cc_groups> <cc_group> <group_id>1</group_id> <group_image>example.jpg</group_image> <group_name>Test_cardgroup</group_name> <group_description>Test_cardgroup description</group_description> <group_number_pin_length>10/4</group_number_pin_length> <group_tarrif>Test Tariff for Users</group_tarrif> <group_lcr>Primary</group_lcr> <group_price>10.0840</group_price> <group_price_without_tax>10.0840</group_price_without_tax> <group_cards_count>21</group_cards_count> </cc_group> </cc_groups> </page>
Errors
- <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
- <error>You are not authorized to use this functionality</error> - User does not have rights to manage Calling Cards.
- <error>Access Denied</error> - User does not have access to Calling Cards.
- <error>Wrong calling cards group ID</error> - User supplied wrong Calling Cards group ID.
- <error>Calling cards groups were not found</error> - Calling cards groups were not found.