Hotdesking

Lists hot desking devices

get

Retrieve a collection of hot desking.

Authorizations

Query parameters

filterstringoptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringoptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringoptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100optional

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/hotdesking' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "model": "text",
      "extension_number": "text",
      "current_extension_number": "text",
      "display_name": "text"
    }
  ]
}

OK

Create a hot desking device.

post

Add a new hot desking into system.

Authorizations

Body

extension_numberall ofrequired

The extension number of hot desking.

The extension number.

extension_passwordall ofrequired

The extension password of hot desking.

The extension password.

display_namestring · max: 1024optional

The display name of hot desking.

macall ofrequired

MAC address of this IP phone.

MAC address.

filenamestringrequired

Template XML file name for phone provisioning.

vendorstringrequired

The phone vendor of IP phone.

modelstringrequired

The name of IP phone model.

passwordstringrequired

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".

languagestring · enumrequired

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.

Options: ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, BULGARIAN

transferstring · enum · default: "BLIND"required

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.

Options: BLIND, ATTENDED, NEW_CALL

timezonestringrequired

The timezone of phone.

ringtonestringoptional

The ringtone of phone.

queue_ringtonestringoptional

The queue ringtone of phone for queue calls or ring group calls.

external_ringtonestringoptional

The ringtone of phone for external calls.

date_formatstringoptional

The date format of phone.

time_formatstringoptional

The time format of phone.

powerledstringoptional

The power led of phone.

backlightstringoptional

The backlight of phone.

screensaverstringoptional

The screensaver of phone.

rpsbooleanoptional

Send to RPS or not.

httpsbooleanoptional

Whether to use https

codecsstring[]required

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpboolean · default: falseoptional

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean · default: falseoptional

Enable or disable VLAN for WAN Port.

wan_port_idinteger · min: 1 · max: 4094optional

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7optional

VLAN priority for WAN Port.

enable_vlan_pc_portboolean · default: falseoptional

Enable or disable VLAN for PC Port.

pc_port_idinteger · min: 1 · max: 4094optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7optional

VLAN priority for PC Port.

interfacestring · enumrequired

The interface type for QR code or auto provisioning.
Can be neither:

• WEB_DOMAIN:
• PUBLIC_IPV4:
• PUBLIC_IPV6:
• PRIVATE_IPV4:
• PRIVATE_IPV6:
• SBC_DOMAIN:

Options: WEB_DOMAIN, PUBLIC_IPV4, PUBLIC_IPV6, PRIVATE_IPV4, PRIVATE_IPV6, SBC_DOMAIN

preferred_transportstring · enumrequired

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

Options: UDP, TCP, TLS

serial_numberstringoptional

The serial number of phone.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/hotdesking' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": true,
    "enable_vlan_wan_port": true,
    "wan_port_id": 1,
    "wan_port_priority": 1,
    "enable_vlan_pc_port": true,
    "pc_port_id": 1,
    "pc_port_priority": 1,
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "serial_number": "text"
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

OK

Retrieve hot desking

get

Retrieve hot desking by it's unique ID.

Authorizations

Path parameters

idall ofrequired

The unique ID of hot desking.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/hotdesking/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "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": true,
  "enable_vlan_wan_port": true,
  "wan_port_id": 1,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": true,
  "pc_port_id": 1,
  "pc_port_priority": 1,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "serial_number": "text",
  "url": "text"
}

OK

Update hot desking

post

Update hot desking

Authorizations

Path parameters

idall ofrequired

The unique ID of hot desking.

The unique ID of the resource.

Body

display_namestring · max: 1024optional

The display name of hot desking.

passwordstringoptional

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".

languagestring · enumoptional

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.

Options: ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, BULGARIAN

transferstring · enum · default: "BLIND"optional

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.

Options: BLIND, ATTENDED, NEW_CALL

timezonestringoptional

The timezone of phone.

ringtonestringoptional

The ringtone of phone.

queue_ringtonestringoptional

The queue ringtone of phone for queue calls or ring group calls.

external_ringtonestringoptional

The ringtone of phone for external calls.

date_formatstringoptional

The date format of phone.

time_formatstringoptional

The time format of phone.

powerledstringoptional

The power led of phone.

backlightstringoptional

The backlight of phone.

screensaverstringoptional

The screensaver of phone.

rpsbooleanoptional

Send to RPS or not.

httpsbooleanoptional

Whether to use https

codecsstring[]optional

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpboolean · default: falseoptional

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean · default: falseoptional

Enable or disable VLAN for WAN Port.

wan_port_idinteger · min: 1 · max: 4094optional

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7optional

VLAN priority for WAN Port.

enable_vlan_pc_portboolean · default: falseoptional

Enable or disable VLAN for PC Port.

pc_port_idinteger · min: 1 · max: 4094optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7optional

VLAN priority for PC Port.

interfacestring · enumoptional

The interface type for QR code or auto provisioning.
Can be neither:

• WEB_DOMAIN:
• PUBLIC_IPV4:
• PUBLIC_IPV6:
• PRIVATE_IPV4:
• PRIVATE_IPV6:
• SBC_DOMAIN:

Options: WEB_DOMAIN, PUBLIC_IPV4, PUBLIC_IPV6, PRIVATE_IPV4, PRIVATE_IPV6, SBC_DOMAIN

preferred_transportstring · enumoptional

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

Options: UDP, TCP, TLS

serial_numberstringoptional

The serial number of phone.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/hotdesking/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": true,
    "enable_vlan_wan_port": true,
    "wan_port_id": 1,
    "wan_port_priority": 1,
    "enable_vlan_pc_port": true,
    "pc_port_id": 1,
    "pc_port_priority": 1,
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "serial_number": "text"
  }'

200

4XX

200

No body

OK