Difference between revisions of "MOR API did details update"
From Kolmisoft Wiki
Jump to navigationJump to search
| Line 23: | Line 23: | ||
* '''u''' – username to login. '''Required'''. | * '''u''' – username to login. '''Required'''. | ||
* '''call_limit''' – call limit of did which will be updated. '''Optional''' | * '''call_limit''' – call limit of did which will be updated. '''Optional''' | ||
* <!--FROM MOR X6--->'''did_user_id''' – User ID from database whom DID should be assigned. Just free DID can be assigned to User. DID can be assigned to Reseller or simple User. Set -1 to make DID free. '''Optional''' | * <!--FROM MOR X6--->'''did_user_id''' – User ID from database whom DID should be assigned. '''Just free DID can be assigned to User.''' DID can be assigned to Reseller or simple User. Set -1 to make DID free. '''Optional''' | ||
<br><br> | <br><br> | ||
===Request=== | ===Request=== | ||
| Line 49: | Line 49: | ||
---- | ---- | ||
'''Errors''' | '''Errors''' | ||
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission. | * <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission. | ||
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. | * <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. | ||
* <error>Call limit is incorrect format</error> – Specified call limit has to be 0 or positive number. | |||
* <error>DID is already assigned</error> – DID is already assign to other User, Reseller or Dial Plan. | |||
* <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u). | |||
<br><br> | <br><br> | ||
Revision as of 17:06, 14 January 2016
Description
MOR API DID details update
Please note that only admin, accountant(with device management) with permission and reseller can use this API.
Usage
- Call: /api/did_details_update
- Methods: POST, GET(if allowed, not recomended)
Parametres
Parameter which is included into hash:
- did_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 did_id and API_Secret_Key ( More described in Constructing hash). Required.
- u – username to login. Required.
- call_limit – call limit of did which will be updated. Optional
- did_user_id – User ID from database whom DID should be assigned. Just free DID can be assigned to User. DID can be assigned to Reseller or simple User. Set -1 to make DID free. Optional
Request
We have API Secret Key = secret, did_id = 6511
We send:
HTML POST: http://<server_ip>/billing/api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46
* Note that username is not included in hash
Returns
Success
<page> <status> <success>DID details successfully updated</success> </status> </page>
After successfully updating DID action log record is added.
Errors
- <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.
- <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
- <error>Call limit is incorrect format</error> – Specified call limit has to be 0 or positive number.
- <error>DID is already assigned</error> – DID is already assign to other User, Reseller or Dial Plan.
- <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).
