Hotdesking
Retrieve a collection of hot desking.
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100GET /api/hotdesking HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"model": "text",
"extension_number": "text",
"current_extension_number": "text",
"display_name": "text"
}
]
}Add a new hot desking into system.
The extension number of hot desking.
The extension number.
[0-9]{3,64}The extension password of hot desking.
The extension password.
The display name of hot desking.
MAC address of this IP phone.
MAC address.
Template XML file name for phone provisioning.
The phone vendor of IP phone.
The name of IP phone model.
Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".
Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.
The transfer method for auto provision.
Can be either:
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.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.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.
BLINDPossible values: The timezone of phone.
The ringtone of phone.
The queue ringtone of phone for queue calls or ring group calls.
The ringtone of phone for external calls.
The date format of phone.
The time format of phone.
The power led of phone.
The backlight of phone.
The screensaver of phone.
Send to RPS or not.
Whether to use https
Settings for the priority of the codecs in this phone. This indicates the first preferred codec.
Enable or disable Link Layer Discovery Protocol.
falseEnable or disable VLAN for WAN Port.
falseVLAN ID for WAN PORT.
VLAN priority for WAN Port.
Enable or disable VLAN for PC Port.
falseVLAN ID for PC PORT.
VLAN priority for PC Port.
The interface type for QR code or auto provisioning.
Can be neither:
WEB_DOMAIN:PUBLIC_IPV4:PUBLIC_IPV6:PRIVATE_IPV4:PRIVATE_IPV6:SBC_DOMAIN:
The transport protocol:
Can be either:
UDP:TCP:TLS:
The serial number of phone.
POST /api/hotdesking HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 653
{
"extension_number": "text",
"extension_password": "text",
"display_name": "text",
"mac": "text",
"filename": "text",
"vendor": "text",
"model": "text",
"password": "text",
"language": "ENGLISH",
"transfer": "BLIND",
"timezone": "text",
"ringtone": "text",
"queue_ringtone": "text",
"external_ringtone": "text",
"date_format": "text",
"time_format": "text",
"powerled": "text",
"backlight": "text",
"screensaver": "text",
"rps": true,
"https": true,
"codecs": [
"text"
],
"enable_lldp": false,
"enable_vlan_wan_port": false,
"wan_port_id": 1,
"wan_port_priority": 1,
"enable_vlan_pc_port": false,
"pc_port_id": 1,
"pc_port_priority": 1,
"interface": "WEB_DOMAIN",
"preferred_transport": "UDP",
"serial_number": "text"
}{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}Retrieve hot desking by it's unique ID.
The unique ID of hot desking.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /api/hotdesking/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"extension_number": "text",
"current_extension_number": "text",
"display_name": "text",
"mac": "text",
"filename": "text",
"vendor": "text",
"model": "text",
"password": "text",
"language": "ENGLISH",
"transfer": "BLIND",
"timezone": "text",
"ringtone": "text",
"queue_ringtone": "text",
"external_ringtone": "text",
"date_format": "text",
"time_format": "text",
"powerled": "text",
"backlight": "text",
"screensaver": "text",
"rps": true,
"https": true,
"codecs": [
"text"
],
"enable_lldp": false,
"enable_vlan_wan_port": false,
"wan_port_id": 1,
"wan_port_priority": 1,
"enable_vlan_pc_port": false,
"pc_port_id": 1,
"pc_port_priority": 1,
"interface": "WEB_DOMAIN",
"preferred_transport": "UDP",
"serial_number": "text",
"url": "text"
}Update hot desking
The unique ID of hot desking.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe display name of hot desking.
Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".
Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.
The transfer method for auto provision.
Can be either:
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.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.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.
BLINDPossible values: The timezone of phone.
The ringtone of phone.
The queue ringtone of phone for queue calls or ring group calls.
The ringtone of phone for external calls.
The date format of phone.
The time format of phone.
The power led of phone.
The backlight of phone.
The screensaver of phone.
Send to RPS or not.
Whether to use https
Settings for the priority of the codecs in this phone. This indicates the first preferred codec.
Enable or disable Link Layer Discovery Protocol.
falseEnable or disable VLAN for WAN Port.
falseVLAN ID for WAN PORT.
VLAN priority for WAN Port.
Enable or disable VLAN for PC Port.
falseVLAN ID for PC PORT.
VLAN priority for PC Port.
The interface type for QR code or auto provisioning.
Can be neither:
WEB_DOMAIN:PUBLIC_IPV4:PUBLIC_IPV6:PRIVATE_IPV4:PRIVATE_IPV6:SBC_DOMAIN:
The transport protocol:
Can be either:
UDP:TCP:TLS:
The serial number of phone.
POST /api/hotdesking/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 537
{
"display_name": "text",
"password": "text",
"language": "ENGLISH",
"transfer": "BLIND",
"timezone": "text",
"ringtone": "text",
"queue_ringtone": "text",
"external_ringtone": "text",
"date_format": "text",
"time_format": "text",
"powerled": "text",
"backlight": "text",
"screensaver": "text",
"rps": true,
"https": true,
"codecs": [
"text"
],
"enable_lldp": false,
"enable_vlan_wan_port": false,
"wan_port_id": 1,
"wan_port_priority": 1,
"enable_vlan_pc_port": false,
"pc_port_id": 1,
"pc_port_priority": 1,
"interface": "WEB_DOMAIN",
"preferred_transport": "UDP",
"serial_number": "text"
}No content