Difference between revisions of "MOR API did device assign"
From Kolmisoft Wiki
Jump to navigationJump to search
m (moved MOR API did assign device api to MOR API did device assign) |
|
(No difference)
|
Revision as of 09:59, 25 May 2013
Descriptiom
MOR API DID assign Device
Usage
- Call: /api/did_device_assign
- For Backwards-compatibility old name 'did_assignt_device' is also usable. Call: /api/did_assign_device
- Methods: POST, GET(if allowed, not recomended)
Parametres
- did - DID number where device have to be assigned. Required.
- device_id - Device ID in MOR database, to be assigned for specified DID Required.
- u - username for authentication. Required.
- hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.
Request
We have device_id = 1, did=123456789, API Secret Key = secret
We send
HTML POST: http://<SERVER_IP>/billing/api/did_device_assign?u=username&did=123456789&device_id=1&hash=bc2f114099d16656d37e45fd9e8744cb9386d462
Now we can view these changes in GUI through DID edit.
NOTE that username and password are not included in hash
Returns
Success
<?xml version="1.0" encoding="UTF-8"?> <page> <status>Device assigned to DID</status> </page>
Errors
- <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
- <error>Don't be so smart</error> - Only Admin, Accountant or Reseller may use API.
- <error>Device was not found</error> - Enter existing Device ID.
- <error>Your are not authorized to use this Device</error> - Specified Device is not available to this user.
- <error>You are not authorized to manage DIDs</error> - If Accountant or Reseller is using API, they should have all permissions to perform specified actions.
- <error>DID does not exist</error> - Enter existing DID number.
- <error>Invalid DID specified</error> - Enter a valid (numeric) DID number.
- <error>Your are not authorized to use this DID</error> - Specified DID is not available to this user.
- <error>DID is terminated</error> - DID is terminated and cannot be used.
- <error>DID is not free</error> - DID is being used in a Dial Plan or another Device is already assigned.
- <error>Device was not assigned</error>