Table of Contents

API : PBX : SIP phone Hotdesk grab

Introduction

This request will grab an available hotdesk phone and assign it to the selected extension.

Request

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

Request body example

{
  "extensionId": "12345678901234567890ABCD"
}

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
404 extensionId Extension not found
409 id SIP phone in wrong state or not a hotdesk phone
500 internal_error <Unspecified>