MOR API device delete

From Kolmisoft Wiki
Jump to navigationJump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Description

MOR API Delete device

Usage

  • Call: /api/device_delete
  • For Backwards-compatibility old name 'device_destroy' is also usable. Call: /api/device_destroy
  • Methods: POST, GET(if allowed, not recomended)



Parametres

  • device - Device ID in MOR database, whose datas we want to delete. Required.
  • u - username for authentication. Required.
  • hash - SHA1 hash constructed using device and API_Secret_Key ( More described in Constructing hash). Required.



Request

We have device = 123, API Secret Key = 456789

We send:

HTML POST: http://<SERVER_IP>/billing/api/device_delete?u=admin&device=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

NOTE that username and password are not included in hash

Returns

Success

<?xml version="1.0" encoding="UTF-8"?>
<page>
 <status>Device was deleted</status>
</page>




Errors

  • <error>Device was not found</error> - Device was not found using device. Use correct device id.</error>
  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.</error>
  • <error>Registration over API is disabled</error> - Setting: Settings->API->API allow Registration, is off. Turn on API allow Registration.</error>
  • <error>Access Denied</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.</error>
  • <error>Cannot delete device - it has calls. You can only hide device's user. Why is that and how to do that - please read in manual.</error>
  • <error>Device has forwarded calls - we cannot delete it</error>
  • <error>Unable to delete this device - it is used in Call Flow for Fax Detect</error>
  • <error>Device has Dial Plans - we cannot delete it</error>
  • <error>One or more Location rules are using this Device</error>
  • <error>Cannot delete device - it is assigned to Queue</error>



See also