Difference between revisions of "MOR API Quickforwards delete"
From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with '=Description= MOR API Delete device <br><br> =Usage= * From '''MOR X4''' Call: '''/api/quickforward_did_delete''' * Methods: POST, GET(if allowed, not recomended) <br><br> =…') |
|||
Line 1: | Line 1: | ||
NOTE: Available from MOR X5 | |||
=Description= | =Description= | ||
[[MOR API]] Delete device | [[MOR API]] Delete device |
Revision as of 13:08, 13 August 2013
NOTE: Available from MOR X5
Description
MOR API Delete device
Usage
- From MOR X4 Call: /api/quickforward_did_delete
- Methods: POST, GET(if allowed, not recomended)
Parametres
- DID - DID number, which we want to delete. 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 = 37063042438, API Secret Key = 123456 We send:
HTML POST: http://<SERVER_IP>/billing/api/quickforwards_did_delete?u=admin&did=37063042438&hash=8fe8606b6bb38ba1cc5e80630436b270cfc7e65e
NOTE that username and password are not included in hash
Success
<?xml version="1.0" encoding="UTF-8"?> <page> <status>Quickforward successfully deleted</status> </page>
Errors
- <error>User was not found</error> - user was not found using username. Use correct username.
- <error>DID was not found</error> - DID was not found using DID number. Use correct DID.
- <error>You are not authorised to use Quickforwards</error> - Such username does not exist in the database or it was not specified.
- <error>No Quickforward is assigned to specified DID</error> - No Quickforward is assigned to specified DID.