Revision as of 13:03, 12 April 2016

Descriptiom

MOR API DID assign Device

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 recomended)

u - username for authentication. Required.
did - DID number where device have to be assigned. Required.
device_id - Device ID in MOR database, to be assigned for specified DID Required.
hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.

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

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

@@ Line 10: / Line 10: @@
 ===Parametres (in this order only) ===
+* u - username for authentication. '''Required'''.
 * 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'''.
 * [[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>