Difference between revisions of "MOR API users get"
From Kolmisoft Wiki
Jump to navigationJump to search
| Line 13: | Line 13: | ||
* From '''MOR X8''' call: /api/users_get | * From '''MOR X8''' call: /api/users_get | ||
* Methods: POST, GET(if allowed, not recomended) | * Methods: POST, GET(if allowed, not recomended) | ||
<br><br> | |||
===Parametres=== | |||
Parameters that are '''included''' into hash: | |||
* '''dids_id''' – this is id of DID which have to be updated. '''Required'''. | |||
'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key''' | |||
<br><br> | |||
Parameters which are '''not included''' into hash: | |||
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''dids_id''' and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. | |||
* '''u''' – username to login. '''Required'''. | |||
<br><br> | <br><br> | ||
===Parameters=== | ===Parameters=== | ||
Parameters | Parameters that are '''included''' into hash: | ||
* u - username to log in. '''Required'''. | |||
* p - password to login. | |||
Parameters that are '''not included''' into hash: | |||
* uniquehash - user's uniquehash. | * uniquehash - user's uniquehash. | ||
'''note''': you can use either '''p''' or '''uniquehash''' to identify the user.<br> | |||
'''note''': you can use either '''p''' or '''uniquehash''' to identify the user. One of them is required<br> | |||
'''note''': if using the browser's URL bar, then you should encode symbols. Example: | '''note''': if using the browser's URL bar, then you should encode symbols. Example: | ||
** for % use %25. | ** for % use %25. | ||
Revision as of 06:42, 9 October 2025
Description
MOR API for getting list of users
- Admin or Accountant with permissions can get all users list
- Reseller can get his own users list
- Partner can get his resellers and users
Usage
- From MOR X8 call: /api/users_get
- Methods: POST, GET(if allowed, not recomended)
Parametres
Parameters that are included into hash:
- dids_id – this is id of DID which have to be updated. Required.
Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key
Parameters which are not included into hash:
- hash - SHA1 hash constructed using dids_id and API_Secret_Key ( More described in Constructing hash). Required.
- u – username to login. Required.
Parameters
Parameters that are included into hash:
- u - username to log in. Required.
- p - password to login.
Parameters that are not included into hash:
- uniquehash - user's uniquehash.
note: you can use either p or uniquehash to identify the user. One of them is required
note: if using the browser's URL bar, then you should encode symbols. Example:
- for % use %25.
- for # use %23.
- for + use %2B.
- for & use %26.
- hash – SHA1 hash constructed using API Secret Key ( More described in Constructing hash). Required.
Request
If API Secret Key = secret
You send:
HTML POST: http://<SERVER_IP>/billing/api/users_get?u=admin&p=admin1&test=1&hash=c420ef706a02e6449994b7575b25ef5f74cc722b
Returns
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<users>
<user>
<id> ... </id>
<username> ... </username>
<first_name> ... </first_nam>
<last_name> ... </last_name>
<balance> ... </balance>
<blocked> ... </blocked>
<lcr_id> ... </lcr_id>
<tariff_id> ... </tariff_id>
<owner_id> ... </owner_id>
<usertype> ... </usertype>
<hidden> ... </hidden>
</user>
</users>
</status>
</page>
Errors:
- <error>API Requests are disabled</error> – Allow API globally setting is unchecked
- <error>GET Requests are disabled</error> – Allow GET API setting is unchecked
- <error>Access Denied</error> – User is not allowed to to get users list or username and password are not correct.
- <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order of parameters while concatenating the hash_string
- <error>You are not authorized to view this page</error> – User is not authorized to get users list.
Example:
<status> <error>API Requests are disabled</error> </status>
