User Tools

Site Tools


api:pbx:sipphone:hotdeskrelease

API : PBX : SIP phone Hotdesk release

Introduction

This request will release a hotdesk sipphone that is currently assigned to an extension.

Request

URL https://api.telecomx.dk/pbx/sipphone/SIPPHONE-ID/hotdesk
Method DELETE
Access level PERSONAL, VIEWER (may only release from own extension), MANAGER, OWNER, RESELLER, RESELLER_ADMIN, ADMIN.
Params SIPPHONE-ID String Id of the SIP phone to grab.

Request body example

DELETE https://api.telecomx.dk/pbx/sipphone/12345678901234567890ABCD/hotdesk

Response

Json object
success Boolean True on success.

Example

{
  "success": true
}

Errors

Error code Message Description
403 access_denied Insufficient access level
404 not_found SIP phone not found
409 id SIP phone in wrong state or not a hotdesk phone
500 internal_error <Unspecified>
api/pbx/sipphone/hotdeskrelease.txt · Last modified: 2026/01/19 10:55 by Per Møller

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki