# Hot Desking
Hot Desking of PBX system.
## Lists hot desking devices
> Retrieve a collection of hot desking.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Hot Desking","description":"Hot Desking of PBX system.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/hotdesking":{"get":{"tags":["Hot Desking"],"operationId":"listHotDeskingDevices","summary":"Lists hot desking devices","description":"Retrieve a collection of hot desking.\n","parameters":[{"name":"filter","in":"query","schema":{"type":"string"},"description":"Use the `filter` query parameter to retrieve just a subset of a collection.\n"},{"name":"search","in":"query","schema":{"type":"string"},"description":"Use the `search` query parameter to restrict the results of a request to match a search criterion.\n"},{"name":"orderby","in":"query","schema":{"type":"string"},"description":"Use the `orderby` query parameter to specify the sort order of the items returned from server. \nThe default order is ascending order.\n"},{"name":"skip","in":"query","schema":{"type":"integer","format":"int32","minimum":0,"default":0},"description":"Use the `skip` query parameter to set the number of items to skip at the start of a collection.\n"},{"name":"top","in":"query","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":100},"description":"Use the `top` query parameter to specify the page size of the result set.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int64","minimum":0,"description":"Total number of resource.\n"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of hot desking.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"},"extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of hot desking.\n"},"current_extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The current extension number of hot desking.\n"},"display_name":{"type":"string","maxLength":1024,"description":"The display name of hot desking.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Create a hot desking device.
> Add a new hot desking into system.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Hot Desking","description":"Hot Desking of PBX system.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/hotdesking":{"post":{"tags":["Hot Desking"],"operationId":"createHotDeskingDevice","summary":"Create a hot desking device.","description":"Add a new hot desking into system.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of hot desking.\n"},"extension_password":{"allOf":[{"type":"string","description":"The extension password.\n"}],"description":"The extension password of hot desking.\n"},"display_name":{"type":"string","maxLength":1024,"description":"The display name of hot desking.\n"},"mac":{"allOf":[{"type":"string","description":"MAC address.\n"}],"description":"MAC address of this IP phone.\n"},"filename":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"vendor":{"type":"string","description":"The phone vendor of IP phone.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"},"password":{"type":"string","description":"Password for accessing the Web interface of phone.\nThe username remains default because most phone manufacturers do not\nallow modification of the user name. This is supported for some phone model, such as \"Snom 300\".\n"},"language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"Language for strings displayed on Phone Display LCD.\nSupported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN,\nGREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.\n"},"transfer":{"type":"string","enum":["BLIND","ATTENDED","NEW_CALL"],"default":"BLIND","description":"The transfer method for auto provision. \nCan be either: \n- `BLIND`: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.\n- `ATTENDED`: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.\n- `NEW_CALL`: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.\n"},"timezone":{"type":"string","description":"The timezone of phone.\n"},"ringtone":{"type":"string","description":"The ringtone of phone.\n"},"queue_ringtone":{"type":"string","description":"The queue ringtone of phone for queue calls or ring group calls.\n"},"external_ringtone":{"type":"string","description":"The ringtone of phone for external calls.\n"},"date_format":{"type":"string","description":"The date format of phone.\n"},"time_format":{"type":"string","description":"The time format of phone.\n"},"powerled":{"type":"string","description":"The power led of phone.\n"},"backlight":{"type":"string","description":"The backlight of phone.\n"},"screensaver":{"type":"string","description":"The screensaver of phone.\n"},"rps":{"type":"boolean","description":"Send to RPS or not.\n"},"https":{"type":"boolean","description":"Whether to use https\n"},"codecs":{"type":"array","items":{"type":"string"},"description":"Settings for the priority of the codecs in this phone.\nThis indicates the first preferred codec.\n"},"enable_lldp":{"type":"boolean","default":false,"description":"Enable or disable Link Layer Discovery Protocol."},"enable_vlan_wan_port":{"type":"boolean","default":false,"description":"Enable or disable VLAN for WAN Port.\n"},"wan_port_id":{"type":"integer","minimum":1,"maximum":4094,"description":"VLAN ID for WAN PORT.\n"},"wan_port_priority":{"type":"integer","minimum":0,"maximum":7,"description":"VLAN priority for WAN Port.\n"},"enable_vlan_pc_port":{"type":"boolean","default":false,"description":"Enable or disable VLAN for PC Port.\n"},"pc_port_id":{"type":"integer","minimum":1,"maximum":4094,"description":"VLAN ID for PC PORT.\n"},"pc_port_priority":{"type":"integer","minimum":0,"maximum":7,"description":"VLAN priority for PC Port.\n"},"interface":{"type":"string","enum":["WEB_DOMAIN","PUBLIC_IPV4","PUBLIC_IPV6","PRIVATE_IPV4","PRIVATE_IPV6","SBC_DOMAIN"],"description":"The interface type for QR code or auto provisioning. \nCan be neither: \n- `WEB_DOMAIN`:\n- `PUBLIC_IPV4`:\n- `PUBLIC_IPV6`:\n- `PRIVATE_IPV4`:\n- `PRIVATE_IPV6`:\n- `SBC_DOMAIN`:\n"},"preferred_transport":{"type":"string","enum":["UDP","TCP","TLS"],"description":"The transport protocol: \nCan be either: \n- `UDP`:\n- `TCP`:\n- `TLS`:\n"},"serial_number":{"type":"string","description":"The serial number of phone.\n"}},"required":["extension_number","extension_password","mac","filename","vendor","model","password","language","transfer","timezone","codecs","interface","preferred_transport"]}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of hot desking.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve hot desking
> Retrieve hot desking by it's unique ID.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Hot Desking","description":"Hot Desking of PBX system.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/hotdesking/{id}":{"get":{"tags":["Hot Desking"],"operationId":"showHotDeskingDevice","summary":"Retrieve hot desking","description":"Retrieve hot desking by it's unique ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of hot desking.\n"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of hot desking.\n"},"extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of hot desking.\n"},"current_extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The current extension number of hot desking.\n"},"display_name":{"type":"string","maxLength":1024,"description":"The display name of hot desking.\n"},"mac":{"allOf":[{"type":"string","description":"MAC address.\n"}],"description":"MAC address of this IP phone.\n"},"filename":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"vendor":{"type":"string","description":"The phone vendor of IP phone.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"},"password":{"type":"string","description":"Password for accessing the Web interface of phone.\nThe username remains default because most phone manufacturers do not\nallow modification of the user name. This is supported for some phone model, such as \"Snom 300\".\n"},"language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"Language for strings displayed on Phone Display LCD.\nSupported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN,\nGREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.\n"},"transfer":{"type":"string","enum":["BLIND","ATTENDED","NEW_CALL"],"default":"BLIND","description":"The transfer method for auto provision. \nCan be either: \n- `BLIND`: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.\n- `ATTENDED`: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.\n- `NEW_CALL`: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.\n"},"timezone":{"type":"string","description":"The timezone of phone.\n"},"ringtone":{"type":"string","description":"The ringtone of phone.\n"},"queue_ringtone":{"type":"string","description":"The queue ringtone of phone for queue calls or ring group calls.\n"},"external_ringtone":{"type":"string","description":"The ringtone of phone for external calls.\n"},"date_format":{"type":"string","description":"The date format of phone.\n"},"time_format":{"type":"string","description":"The time format of phone.\n"},"powerled":{"type":"string","description":"The power led of phone.\n"},"backlight":{"type":"string","description":"The backlight of phone.\n"},"screensaver":{"type":"string","description":"The screensaver of phone.\n"},"rps":{"type":"boolean","description":"Send to RPS or not.\n"},"https":{"type":"boolean","description":"Whether to use https\n"},"codecs":{"type":"array","items":{"type":"string"},"description":"Settings for the priority of the codecs in this phone.\nThis indicates the first preferred codec.\n"},"enable_lldp":{"type":"boolean","default":false,"description":"Enable or disable Link Layer Discovery Protocol."},"enable_vlan_wan_port":{"type":"boolean","default":false,"description":"Enable or disable VLAN for WAN Port.\n"},"wan_port_id":{"type":"integer","minimum":1,"maximum":4094,"description":"VLAN ID for WAN PORT.\n"},"wan_port_priority":{"type":"integer","minimum":0,"maximum":7,"description":"VLAN priority for WAN Port.\n"},"enable_vlan_pc_port":{"type":"boolean","default":false,"description":"Enable or disable VLAN for PC Port.\n"},"pc_port_id":{"type":"integer","minimum":1,"maximum":4094,"description":"VLAN ID for PC PORT.\n"},"pc_port_priority":{"type":"integer","minimum":0,"maximum":7,"description":"VLAN priority for PC Port.\n"},"interface":{"type":"string","enum":["WEB_DOMAIN","PUBLIC_IPV4","PUBLIC_IPV6","PRIVATE_IPV4","PRIVATE_IPV6","SBC_DOMAIN"],"description":"The interface type for QR code or auto provisioning. \nCan be neither: \n- `WEB_DOMAIN`:\n- `PUBLIC_IPV4`:\n- `PUBLIC_IPV6`:\n- `PRIVATE_IPV4`:\n- `PRIVATE_IPV6`:\n- `SBC_DOMAIN`:\n"},"preferred_transport":{"type":"string","enum":["UDP","TCP","TLS"],"description":"The transport protocol: \nCan be either: \n- `UDP`:\n- `TCP`:\n- `TLS`:\n"},"serial_number":{"type":"string","description":"The serial number of phone.\n"},"url":{"type":"string","description":"Auto provision server URL.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update hot desking
> Update hot desking
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Hot Desking","description":"Hot Desking of PBX system.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/hotdesking/{id}":{"post":{"tags":["Hot Desking"],"operationId":"updateHotDeskingDevice","summary":"Update hot desking","description":"Update hot desking\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of hot desking.\n"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"display_name":{"type":"string","maxLength":1024,"description":"The display name of hot desking.\n"},"password":{"type":"string","description":"Password for accessing the Web interface of phone.\nThe username remains default because most phone manufacturers do not\nallow modification of the user name. This is supported for some phone model, such as \"Snom 300\".\n"},"language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"Language for strings displayed on Phone Display LCD.\nSupported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN,\nGREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.\n"},"transfer":{"type":"string","enum":["BLIND","ATTENDED","NEW_CALL"],"default":"BLIND","description":"The transfer method for auto provision. \nCan be either: \n- `BLIND`: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.\n- `ATTENDED`: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.\n- `NEW_CALL`: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.\n"},"timezone":{"type":"string","description":"The timezone of phone.\n"},"ringtone":{"type":"string","description":"The ringtone of phone.\n"},"queue_ringtone":{"type":"string","description":"The queue ringtone of phone for queue calls or ring group calls.\n"},"external_ringtone":{"type":"string","description":"The ringtone of phone for external calls.\n"},"date_format":{"type":"string","description":"The date format of phone.\n"},"time_format":{"type":"string","description":"The time format of phone.\n"},"powerled":{"type":"string","description":"The power led of phone.\n"},"backlight":{"type":"string","description":"The backlight of phone.\n"},"screensaver":{"type":"string","description":"The screensaver of phone.\n"},"rps":{"type":"boolean","description":"Send to RPS or not.\n"},"https":{"type":"boolean","description":"Whether to use https\n"},"codecs":{"type":"array","items":{"type":"string"},"description":"Settings for the priority of the codecs in this phone.\nThis indicates the first preferred codec.\n"},"enable_lldp":{"type":"boolean","default":false,"description":"Enable or disable Link Layer Discovery Protocol."},"enable_vlan_wan_port":{"type":"boolean","default":false,"description":"Enable or disable VLAN for WAN Port.\n"},"wan_port_id":{"type":"integer","minimum":1,"maximum":4094,"description":"VLAN ID for WAN PORT.\n"},"wan_port_priority":{"type":"integer","minimum":0,"maximum":7,"description":"VLAN priority for WAN Port.\n"},"enable_vlan_pc_port":{"type":"boolean","default":false,"description":"Enable or disable VLAN for PC Port.\n"},"pc_port_id":{"type":"integer","minimum":1,"maximum":4094,"description":"VLAN ID for PC PORT.\n"},"pc_port_priority":{"type":"integer","minimum":0,"maximum":7,"description":"VLAN priority for PC Port.\n"},"interface":{"type":"string","enum":["WEB_DOMAIN","PUBLIC_IPV4","PUBLIC_IPV6","PRIVATE_IPV4","PRIVATE_IPV6","SBC_DOMAIN"],"description":"The interface type for QR code or auto provisioning. \nCan be neither: \n- `WEB_DOMAIN`:\n- `PUBLIC_IPV4`:\n- `PUBLIC_IPV6`:\n- `PRIVATE_IPV4`:\n- `PRIVATE_IPV6`:\n- `SBC_DOMAIN`:\n"},"preferred_transport":{"type":"string","enum":["UDP","TCP","TLS"],"description":"The transport protocol: \nCan be either: \n- `UDP`:\n- `TCP`:\n- `TLS`:\n"},"serial_number":{"type":"string","description":"The serial number of phone.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Query hot desking's status
> Query hot desking'status by it's unique ID.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Hot Desking","description":"Hot Desking of PBX system.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/hotdesking/{id}/status":{"get":{"tags":["Hot Desking"],"operationId":"getHotDeskingDeviceStatus","summary":"Query hot desking's status","description":"Query hot desking'status by it's unique ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of hot desking.\n"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["OFFLINE","ONLINE"],"readOnly":true,"description":"The status of the hot desking device.\n- `OFFLINE`:\n- `ONLINE`:\n"},"current_extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The current extension number of hot desking.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Logout a hot desking
> Logout hot desking.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Hot Desking","description":"Hot Desking of PBX system.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/hotdesking/{id}/logout":{"post":{"tags":["Hot Desking"],"operationId":"logoutHotDeskingDevice","summary":"Logout a hot desking","description":"Logout hot desking.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of hot desking.\n"}}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
## Delete hot desking
> Destroy hot desking.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Hot Desking","description":"Hot Desking of PBX system.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/hotdesking/{id}/destroy":{"post":{"tags":["Hot Desking"],"operationId":"deleteHotDeskingDevice","summary":"Delete hot desking","description":"Destroy hot desking.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of hot desking.\n"}}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```