MOR API did device unassign

Description

MOR API DID unassign Device

Usage

• From MOR X4 call: /api/did_device_unassign
• For Backwards-compatibility old name 'did_unassign_device' is also usable. Call: /api/did_unassign_device
• Methods: POST, GET(if allowed, not recomended)

Parametres

• did – DID number where device have to be unassigned. 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 did=123456789 and API Secret Key = secret

We send:

HTML POST: http://<SERVER_IP>/billing/api/did_device_unassign?u=username&did=123456789&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4

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>
      <success>Device was unassigned from 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.
• 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 already free – No Device is currently assigned to this DID.
• DID is assigned to dialplan – DID is assigned to a Dial Plan.
• Failed to unassign DID – unknown error.

See also

• MOR API