Difference between revisions of "MOR API did device assign"
From Kolmisoft Wiki
Jump to navigationJump to search
| (12 intermediate revisions by 6 users not shown) | |||
| Line 4: | Line 4: | ||
=Usage= | =Usage= | ||
* | * From '''MOR X4''' call: '''/api/did_device_assign''' | ||
* For Backwards-compatibility old name 'did_assignt_device' is also usable. Call: /api/did_assign_device | * For Backwards-compatibility old name 'did_assignt_device' is also usable. Call: '''/api/did_assign_device''' | ||
* Methods: POST, GET(if allowed, not | * Methods: POST, GET(if allowed, not recommend) | ||
<br><br> | <br><br> | ||
=== | ===Parameters=== | ||
Parameters which are '''included''' into hash: | |||
* device_id - Device ID in MOR database, to be assigned for specified DID '''Required'''. | * device_id - Device ID in MOR database, to be assigned for specified DID '''Required'''. | ||
* did - DID number to which device have to be assigned. '''Required'''. | |||
Parameters which are '''not included''' into hash: | |||
* u - username for authentication. '''Required'''. | * u - username for authentication. '''Required'''. | ||
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. | * [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. | ||
<br><br> | <br><br> | ||
===Request=== | ===Request=== | ||
| Line 26: | Line 34: | ||
'''NOTE that username and password are not included in hash''' | '''NOTE that username and password are not included in hash''' | ||
'''NOTE''' if you want to assign DID to Reseller's User Device, then reserve DID to Reseller first by using [[MOR_API_did_details_update]] and after that use did_device_assign with u=<reseller username>. | |||
<br><br> | <br><br> | ||
===Returns=== | ===Returns=== | ||
| Line 33: | Line 44: | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<page> | <page> | ||
<status>Device assigned to DID</status> | <status> | ||
<success>Device assigned to DID</success> | |||
</status> | |||
</page> | </page> | ||
<br><br> | <br><br> | ||
| Line 40: | Line 53: | ||
'''Errors''' | '''Errors''' | ||
<?xml version="1.0" encoding="UTF-8"?> | |||
* | <page> | ||
* | <status> | ||
* | <error>Error message</error> | ||
* | </status> | ||
* | </page> | ||
Error messages: | |||
* | |||
* | * Incorrect hash – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. | ||
* | * Access Denied – Only Admin, Accountant or Reseller may use API. | ||
* Device was not found – Device ID does not exist in system. | |||
* DID was not found – DID number does not exist or incorrect. | |||
* Your are not authorized to use this Device – Specified Device is not available to this user. | |||
* You are not authorized to manage DIDs – If Accountant or Reseller is using API, they should have all permissions to perform specified actions. | |||
* Your are not authorized to use this DID – Specified DID is not available to this user. | |||
* DID is terminated – DID is terminated and cannot be used. | |||
* DID is not free – DID is being used in a Dial Plan or another Device is already assigned. | |||
* Device was not assigned – unknown error | |||
<br><br> | <br><br> | ||
=See also= | =See also= | ||
* [[MOR API did trunk device assign]] | |||
* [[MOR API]] | * [[MOR API]] | ||
Latest revision as of 05:38, 21 May 2018
Descriptiom
MOR API DID assign Device
Usage
- From MOR X4 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 recommend)
Parameters
Parameters which are included into hash:
- device_id - Device ID in MOR database, to be assigned for specified DID Required.
- did - DID number to which device have to be assigned. Required.
Parameters which are not included into hash:
- 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
NOTE if you want to assign DID to Reseller's User Device, then reserve DID to Reseller first by using MOR_API_did_details_update and after that use did_device_assign with u=<reseller username>.
Returns
Success
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Device assigned to DID</success>
</status>
</page>
Errors
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Error message</error>
</status>
</page>
Error messages:
- Incorrect hash – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
- Access Denied – Only Admin, Accountant or Reseller may use API.
- Device was not found – Device ID does not exist in system.
- DID was not found – DID number does not exist or incorrect.
- Your are not authorized to use this Device – Specified Device is not available to this user.
- You are not authorized to manage DIDs – If Accountant or Reseller is using API, they should have all permissions to perform specified actions.
- Your are not authorized to use this DID – Specified DID is not available to this user.
- DID is terminated – DID is terminated and cannot be used.
- DID is not free – DID is being used in a Dial Plan or another Device is already assigned.
- Device was not assigned – unknown error
