Hotdesking

Lists hot desking devices

Retrieve a collection of hot desking.

get

/hotdesking

Authorizations
Query parameters
filterstring

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

searchstring

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

orderbystring

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: 0

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: 100

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

Responses
curl -L \
  --url 'https://HOSTNAME:8887/api/hotdesking' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "count": 100,
  "items": [
    {
      "model": "text",
      "display_name": "text",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "extension_number": "text",
      "current_extension_number": "text"
    }
  ]
}

OK

Create a hot desking device.

Add a new hot desking into system.

post

/hotdesking

Authorizations
Body
display_namestring · max: 1024

The display name of hot desking.

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

timezonestringrequired

The timezone of phone.

ringtonestring

The ringtone of phone.

queue_ringtonestring

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

external_ringtonestring

The ringtone of phone for external calls.

date_formatstring

The date format of phone.

time_formatstring

The time format of phone.

powerledstring

The power led of phone.

backlightstring

The backlight of phone.

screensaverstring

The screensaver of phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

enable_lldpboolean · default: false

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean · default: false

Enable or disable VLAN for WAN Port.

wan_port_idinteger · min: 1 · max: 4094

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7

VLAN priority for WAN Port.

enable_vlan_pc_portboolean · default: false

Enable or disable VLAN for PC Port.

pc_port_idinteger · min: 1 · max: 4094

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7

VLAN priority for PC Port.

serial_numberstring

The serial number of phone.

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: BLINDrequired

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
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
codecsstring[]required
extension_numberall ofrequired

The extension number of hot desking.

The extension number.

extension_passwordall ofrequired

The extension password of hot desking.

The extension password.

macall ofrequired

MAC address of this IP phone.

MAC address.

Responses
curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/hotdesking' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "display_name": "text",
    "filename": "text",
    "vendor": "text",
    "model": "text",
    "password": "text",
    "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,
    "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,
    "serial_number": "text",
    "language": "ENGLISH",
    "transfer": "BLIND",
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "codecs": [
      "text"
    ],
    "extension_number": "text",
    "extension_password": "text",
    "mac": "text"
  }'
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

OK

Retrieve hot desking

Retrieve hot desking by it's unique ID.

get

/hotdesking/{id}

Authorizations
Path parameters
idall ofrequired

The unique ID of hot desking.

The unique ID of the resource.

Responses
curl -L \
  --url 'https://HOSTNAME:8887/api/hotdesking/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "display_name": "text",
  "filename": "text",
  "vendor": "text",
  "model": "text",
  "password": "text",
  "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,
  "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,
  "serial_number": "text",
  "url": "text",
  "language": "ENGLISH",
  "transfer": "BLIND",
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "codecs": [
    "text"
  ],
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "extension_number": "text",
  "current_extension_number": "text",
  "mac": "text"
}

OK

Update hot desking

Update hot desking

post

/hotdesking/{id}

Authorizations
Path parameters
idall ofrequired

The unique ID of hot desking.

The unique ID of the resource.

Body
display_namestring · max: 1024

The display name of hot desking.

passwordstring

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

timezonestring

The timezone of phone.

ringtonestring

The ringtone of phone.

queue_ringtonestring

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

external_ringtonestring

The ringtone of phone for external calls.

date_formatstring

The date format of phone.

time_formatstring

The time format of phone.

powerledstring

The power led of phone.

backlightstring

The backlight of phone.

screensaverstring

The screensaver of phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

enable_lldpboolean · default: false

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean · default: false

Enable or disable VLAN for WAN Port.

wan_port_idinteger · min: 1 · max: 4094

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7

VLAN priority for WAN Port.

enable_vlan_pc_portboolean · default: false

Enable or disable VLAN for PC Port.

pc_port_idinteger · min: 1 · max: 4094

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7

VLAN priority for PC Port.

serial_numberstring

The serial number of phone.

languagestring · enum

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

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
interfacestring · enum

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 · enum

The transport protocol:
Can be either:

  • UDP:
  • TCP:
  • TLS:
Options: UDP, TCP, TLS
codecsstring[]
Responses
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",
    "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,
    "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,
    "serial_number": "text",
    "language": "ENGLISH",
    "transfer": "BLIND",
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "codecs": [
      "text"
    ]
  }'
No body

OK

PreviousDestroyNextStatus

Was this helpful?