[Index]

Model: device/spark/DeviceConfig

Model Details: device/spark/DeviceConfig

Title Description Details
device_id A unique identifier for the device + product.
  • Field Name: device_id
  • Type: String
Id A unique identifier for the device.
  • Field Name: id
  • Type: String
model model - e.g. DMS Cisco 8845
  • Field Name: model
  • Type: String
product product - e.g. Cisco 8845
  • Field Name: product
  • Type: String
Customisations
  • Field Name: customizations
  • Type: Object
ATA
  • Field Name: ata
  • Type: Object
deviceIsAta This is a control field providing a boolean to trigger the VOSS GUI rule in order to display ATA values
  • Field Name: customizations.ata.deviceIsAta
  • Type: Boolean
Audio Codec Priority
  • Field Name: audioCodecPriority
  • Type: Object
Use Custom Values Override regional defaults with customised values
  • Field Name: customizations.ata.audioCodecPriority.custom
  • Type: Boolean
Primary
  • Field Name: customizations.ata.audioCodecPriority.primary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Secondary
  • Field Name: customizations.ata.audioCodecPriority.secondary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Tertiary
  • Field Name: customizations.ata.audioCodecPriority.tertiary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
ATA DTMF mode Choose the DTMF mode for Cisco ATA devices. Please note – misconfiguration may cause service impacts.
  • Field Name: customizations.ata.ataDtmfMode
  • Type: String
  • Choices: ["STRICT", "NORMAL"]
ATA DTMF method Choose the DTMF method for Cisco ATA devices. Please note – misconfiguration may cause service impacts.
  • Field Name: customizations.ata.ataDtmfMethod
  • Type: String
  • Choices: ["INBAND", "AVT", "AUTO"]
CDP Enable or disable CDP for local devices. Please note – Misconfiguration could cause local devices to lose contact with the network. WARNING: setting this option incorrectly may cause devices to become disconnected from the network and require a local factory reset of the device to bring it back online.
  • Field Name: customizations.ata.cdpEnabled
  • Type: Boolean
LLDP Enable or disable LLDP for local devices. Please note – misconfiguration could cause local devices to lose contact with the network. WARNING: setting this option incorrectly may cause devices to become disconnected from the network and require a local factory reset of the device to bring it back online.
  • Field Name: customizations.ata.lldpEnabled
  • Type: Boolean
QoS Enable or disable the QOS tagging of packets from the local device to the Webex Calling platform.
  • Field Name: customizations.ata.qosEnabled
  • Type: Boolean
VLAN
  • Field Name: vlan
  • Type: Object
VLAN Enabled
  • Field Name: customizations.ata.vlan.enabled
  • Type: Boolean
VLAN ID Specify a numeric VLAN ID for devices. WARNING: setting this option incorrectly may cause devices to become disconnected from the network and require a local factory reset of the device to bring it back online.
  • Field Name: customizations.ata.vlan.value
  • Type: Integer
Web access Controls user-level web access to the local device.
  • Field Name: customizations.ata.webAccessEnabled
  • Type: Boolean
Nightly resync Allows the automatic nightly configuration resync of the MPP device to be disabled. Please note – by disabling the nightly resync, any configuration changes to the phone will not be applied unless a manual Apply Changes request is issued from Control Hub or if the phone is manually rebooted.
  • Field Name: customizations.ata.nightlyResyncEnabled
  • Type: Boolean
SNMP
  • Field Name: snmp
  • Type: Object
Enabled
  • Field Name: customizations.ata.snmp.enabled
  • Type: Boolean
Trusted IP
  • Field Name: customizations.ata.snmp.trustedIP
  • Type: String
Get community
  • Field Name: customizations.ata.snmp.getCommunity
  • Type: String
Set community
  • Field Name: customizations.ata.snmp.setCommunity
  • Type: String
SNMP V3
  • Field Name: customizations.ata.snmp.snmpV3Enabled
  • Type: Boolean
MPP
  • Field Name: mpp
  • Type: Object
deviceIsMpp This is a control field providing a boolean to trigger the VOSS GUI rule in order to display MPP values
  • Field Name: customizations.mpp.deviceIsMpp
  • Type: Boolean
802.1x Enable or disable Port Based Network Access Control for devices. Please note – misconfiguration may cause devices to lose connection with the network requiring a factory reset to restore services. WARNING: setting this option incorrectly may cause devices to become disconnected from the network and require a local factory reset of the device to bring it back online.
  • Field Name: customizations.mpp.pnacEnabled
  • Type: Boolean
Audio Codec Priority
  • Field Name: audioCodecPriority
  • Type: Object
Use Custom Values Override regional defaults with customised values
  • Field Name: customizations.mpp.audioCodecPriority.custom
  • Type: Boolean
Primary
  • Field Name: customizations.mpp.audioCodecPriority.primary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Secondary
  • Field Name: customizations.mpp.audioCodecPriority.secondary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Tertiary
  • Field Name: customizations.mpp.audioCodecPriority.tertiary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Backlight timer Choose the length of time the backlight should stay on in minutes.
  • Field Name: customizations.mpp.backlightTimer
  • Type: String
  • Choices: ["1 Minute", "5 minutes", "30 Minutes", "Always on"]
Backlight timer Controls the use of the Backlight feature on 6800 and 7800 series devices.
  • Field Name: customizations.mpp.backlightTimer68XX78XX
  • Type: String
  • Choices: ["10 Seconds", "20 Seconds", "30 Seconds", "Always on", "Off"]
Background Image Choose from the image options for the MPP 8875 phone background.
  • Field Name: customizations.mpp.backgroundImage8875
  • Type: String
  • Choices: ["Dark Cyan", "Dark Purple", "Dark Blue", "Light Blue", "Dark Violet", "Light Violet"]
Background Image
  • Field Name: background
  • Type: Object
Background Image Choose from the image options or select 'None' to use the phone default background. This option only works on phones that have an 800x480 screen size. This does not affect MPP 8875 background.
  • Field Name: customizations.mpp.background.image
  • Type: String
  • Choices: ["None", "Dark Blue", "Cisco Dark Blue", "Webex Dark Blue", "Custom Background"]
Custom URL
  • Field Name: customizations.mpp.background.customUrl
  • Type: String
Display Name The display name appears on the phone screen. Selecting the 'User phone number/location number' will display the user’s phone number, or if a user doesn’t have a phone number, the location number will be displayed.
  • Field Name: customizations.mpp.displayNameFormat
  • Type: String
  • Choices: ["User phone number/Location number", "User Name (First Name Last Name)", "User Name (Last Name First Name)"]
CDP Enable or disable CDP for local devices. Please note – Misconfiguration could cause local devices to lose contact with the network. WARNING: setting this option incorrectly may cause devices to become disconnected from the network and require a local factory reset of the device to bring it back online.
  • Field Name: customizations.mpp.cdpEnabled
  • Type: Boolean
Default logging level Choose the desired logging level for MPP devices. Please note – the debugging level may affect the performance of the phone and should only be used during troubleshooting sessions.
  • Field Name: customizations.mpp.defaultLoggingLevel
  • Type: String
  • Choices: ["Standard", "Debugging"]
DND services Enable or disable Do-Not-Disturb capabilities for MPP devices.
  • Field Name: customizations.mpp.dndServicesEnabled
  • Type: Boolean
ACD
  • Field Name: acd
  • Type: Object
Enabled
  • Field Name: customizations.mpp.acd.enabled
  • Type: Boolean
Display CQ Agent softkeys Choose the location of the Call Queue Agent Login/Logout Softkey on MPP devices. Note – This parameter is not supported on the MPP 8875
  • Field Name: customizations.mpp.acd.displayCallqueueAgentSoftkeys
  • Type: String
  • Choices: ["Front page", "Last page"]
Interdigit Short Timer The Interdigit Short Time defines the amount of time that the phone waits for the user to enter a digit. A smaller timer value requires digits to be dialled quickly.
  • Field Name: customizations.mpp.shortInterdigitTimer
  • Type: Integer
Interdigit Long Timer The Interdigit Long Timer defines the amount of time that the phone will wait when no digit patterns match before the phone dials the number. A smaller time value causes unmatched dialled digits to be dialled quickly.
  • Field Name: customizations.mpp.longInterdigitTimer
  • Type: Integer
Line Key Label Line key labels define the format of what’s shown next to line keys. Selecting 'User extension/First name' will display the user extension, or if a user doesn’t have an extension, the user’s first name will be displayed.
  • Field Name: customizations.mpp.lineKeyLabelFormat
  • Type: String
  • Choices: ["User extension/First name", "User Name (First Name Last Name)", "User Name (Last Name First Name)"]
Line Key LED Pattern LED patterns define lighting schemes for the line keys on the MPP devices. Note – This parameter is not supported on the MPP 8875.
  • Field Name: customizations.mpp.lineKeyLEDPattern
  • Type: String
  • Choices: ["Default", "Preset 1"]
LLDP Enable or disable LLDP for local devices. Please note – misconfiguration could cause local devices to lose contact with the network. WARNING: setting this option incorrectly may cause devices to become disconnected from the network and require a local factory reset of the device to bring it back online.
  • Field Name: customizations.mpp.lldpEnabled
  • Type: Boolean
MPP Web Access (User) Enable or disable user access to the web interface of MPP devices. Please note – enabling user web access to phones is not recommended for security reasons.
  • Field Name: customizations.mpp.mppUserWebAccessEnabled
  • Type: Boolean
Multicast
  • Field Name: multicast.[n]
  • Type: Array
Off-hook timer Specify the amount of time a phone can remain off-the-hook.
  • Field Name: customizations.mpp.offHookTimer
  • Type: Integer
Phone language Set the phone language for MPP devices. This value will override the default value derived from its provisioned location. There are some languages that are not available on the MPP 8875.
  • Field Name: customizations.mpp.phoneLanguage
  • Type: String
POE mode Enable or disable the Power-over-Ethernet mode for MPP devices. Please note – misconfiguration may cause key expansion modules to stop functioning. Note – This parameter is not supported on the MPP 8875
  • Field Name: customizations.mpp.poeMode
  • Type: String
  • Choices: ["Normal", "Maximum"]
QoS Enable or disable the QOS tagging of packets from the local device to the Webex Calling platform.
  • Field Name: customizations.mpp.qosEnabled
  • Type: Boolean
Screensaver
  • Field Name: screenTimeout
  • Type: Object
Enabled
  • Field Name: customizations.mpp.screenTimeout.enabled
  • Type: Boolean
Screen timeout Specify the inactivity time in seconds before the phone's screen saver should turn on. Values are 30-65000. Note – This parameter is not supported on the MPP 8875
  • Field Name: customizations.mpp.screenTimeout.value
  • Type: Integer
VLANs
  • Field Name: vlan
  • Type: Object
VLAN Enabled
  • Field Name: customizations.mpp.vlan.enabled
  • Type: Boolean
LAN port Specify a numeric VLAN ID for devices. WARNING: setting this option incorrectly may cause devices to become disconnected from the network and require a local factory reset of the device to bring it back online.
  • Field Name: customizations.mpp.vlan.value
  • Type: Integer
PC Port
  • Field Name: customizations.mpp.vlan.pcPort
  • Type: Integer
Wi-Fi network
  • Field Name: wifiNetwork
  • Type: Object
Enabled Specify the wireless network to be used by Wi-Fi-capable MPP devices. Note – This parameter is not supported on the MPP 8875 WARNING: setting this option incorrectly may cause devices to become disconnected from the network and require a local factory reset of the device to bring it back online.
  • Field Name: customizations.mpp.wifiNetwork.enabled
  • Type: Boolean
Authentication Method
  • Field Name: customizations.mpp.wifiNetwork.authenticationMethod
  • Type: String
  • Choices: ["NONE", "EAP_FAST", "PEAP_GTC", "PEAP_MSCHAPV2", "PSK", "WEP"]
SSID name
  • Field Name: customizations.mpp.wifiNetwork.ssidName
  • Type: String
userId
  • Field Name: customizations.mpp.wifiNetwork.userId
  • Type: String
Call history Sets call history to either use the local device information only or the unified call history from all of the end user's devices. This setting currently only applies to user devices. Does not apply to workspace devices.
  • Field Name: customizations.mpp.callHistory
  • Type: String
  • Choices: ["Webex Unified call history", "Local call history"]
Contacts Sets directory services to either use the standard xsi query method from the device or the Webex enterprise directory.
  • Field Name: customizations.mpp.contacts
  • Type: String
  • Choices: ["Webex Directory", "XSI Directory"]
Webex Meetings Sets the availability of the Webex Meetings functionality from the phone.
  • Field Name: customizations.mpp.webexMeetingsEnabled
  • Type: Boolean
USB ports
  • Field Name: usbPorts
  • Type: Object
Enabled
  • Field Name: customizations.mpp.usbPorts.enabled
  • Type: Boolean
Side USB By default the side USB port is enabled to support KEMs and other peripheral devices. Use the option to disable use of this port.
  • Field Name: customizations.mpp.usbPorts.sideUsbEnabled
  • Type: Boolean
Rear USB Enable or disable use of the rear USB port on MPP devices. Please note – disabling may cause peripheral devices to stop functioning.
  • Field Name: customizations.mpp.usbPorts.rearUsbEnabled
  • Type: Boolean
Default volume settings
  • Field Name: volumeSettings
  • Type: Object
Ringer volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: customizations.mpp.volumeSettings.ringerVolume
  • Type: Integer
Speaker volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: customizations.mpp.volumeSettings.speakerVolume
  • Type: Integer
Handset volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: customizations.mpp.volumeSettings.handsetVolume
  • Type: Integer
Headset volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: customizations.mpp.volumeSettings.headsetVolume
  • Type: Integer
Wireless headset hookswitch control Enable/disable the wireless headset hookswitch control.
  • Field Name: customizations.mpp.volumeSettings.eHookEnabled
  • Type: Boolean
Allow end user override When setting the Preserve End User option for this device setting, the value defined for the device setting will NOT be applied and the existing value on the phone will persist. To force an override of the setting on the phone, please disable the Preserve End User option.
  • Field Name: customizations.mpp.volumeSettings.allowEndUserOverrideEnabled
  • Type: Boolean
Call forward expanded softkey Sets the default call forward softkey behaviour between the multiple menu option and single option versions.
  • Field Name: customizations.mpp.cfExpandedSoftKey
  • Type: String
  • Choices: ["Only the call forward all", "All call forwards"]
HTTP Proxy
  • Field Name: httpProxy
  • Type: Object
HTTP mode
  • Field Name: customizations.mpp.httpProxy.mode
  • Type: String
  • Choices: ["Off", "Manual", "Auto"]
Auto discovery
  • Field Name: customizations.mpp.httpProxy.autoDiscoveryEnabled
  • Type: Boolean
Host
  • Field Name: customizations.mpp.httpProxy.host
  • Type: String
Port
  • Field Name: customizations.mpp.httpProxy.port
  • Type: String
PAC URL
  • Field Name: customizations.mpp.httpProxy.packUrl
  • Type: String
Authentication settings
  • Field Name: customizations.mpp.httpProxy.authSettingsEnabled
  • Type: Boolean
Username
  • Field Name: customizations.mpp.httpProxy.username
  • Type: String
Password
  • Field Name: customizations.mpp.httpProxy.password
  • Type: String
Bluetooth menu
  • Field Name: bluetooth
  • Type: Object
Enabled
  • Field Name: customizations.mpp.bluetooth.enabled
  • Type: Boolean
Bluetooth mode
  • Field Name: customizations.mpp.bluetooth.mode
  • Type: String
  • Choices: ["Phone", "Hands-free", "Both"]
Passthrough port Controls the use of the PC passthrough Ethernet port on supported phone models.
  • Field Name: customizations.mpp.passThroughPortEnabled
  • Type: Boolean
Show user password menu Controls the ability for an end user to set a local password on the phone to restrict local access to the device.
  • Field Name: customizations.mpp.userPasswordOverrideEnabled
  • Type: Boolean
Active call focus Controls the default screen behaviour when inbound calls are received.
  • Field Name: customizations.mpp.activeCallFocusEnabled
  • Type: Boolean
Peer firmware enabled
  • Field Name: customizations.mpp.peerFirmwareEnabled
  • Type: Boolean
Noise cancellation
  • Field Name: noiseCancellation
  • Type: Object
Enabled Controls the local noise cancellation on active calls from the device.
  • Field Name: customizations.mpp.noiseCancellation.enabled
  • Type: Boolean
Allow end user override When setting the Preserve End User option for this device setting, the value defined for the device setting will NOT be applied and the existing value on the phone will persist. To force an override of the setting on the phone, please disable the Preserve End User option.
  • Field Name: customizations.mpp.noiseCancellation.allowEndUserOverrideEnabled
  • Type: Boolean
Dial assist Sets the availability of the Dial Assist feature on the phone.
  • Field Name: customizations.mpp.dialAssistEnabled
  • Type: Boolean
Calls per line limit Controls the number of calls per unique line appearance on the phone.
  • Field Name: customizations.mpp.callsPerLine
  • Type: Integer
Nightly resync Allows the automatic nightly configuration resync of the MPP device to be disabled. Please note – by disabling the nightly resync, any configuration changes to the phone will not be applied unless a manual Apply Changes request is issued from Control Hub or if the phone is manually rebooted.
  • Field Name: customizations.mpp.nightlyResyncEnabled
  • Type: Boolean
Missed call notification Controls the option to display a visual indication on the line appearance when a call is missed.
  • Field Name: customizations.mpp.missedCallNotificationEnabled
  • Type: Boolean
SoftKey layouts
  • Field Name: softKeyLayout
  • Type: Object
Customise softkey menus
  • Field Name: softKeyMenu
  • Type: Object
set Default Values
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.setToDefault
  • Type: Boolean
Idle key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.idleKeyList
  • Type: String
Off-hook key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.offHookKeyList
  • Type: String
Dialling input key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.dialingInputKeyList
  • Type: String
Progressing key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.progressingKeyList
  • Type: String
Connected key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.connectedKeyList
  • Type: String
Connected video key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.connectedVideoKeyList
  • Type: String
Start transfer key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.startTransferKeyList
  • Type: String
Start conference key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.startConferenceKeyList
  • Type: String
Conferencing key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.conferencingKeyList
  • Type: String
Releasing key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.releasingKeyList
  • Type: String
Hold key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.holdKeyList
  • Type: String
Ringing key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.ringingKeyList
  • Type: String
Shared active key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.sharedActiveKeyList
  • Type: String
Shared held key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenu.sharedHeldKeyList
  • Type: String
Customise PSK
  • Field Name: psk
  • Type: Object
set Default Values
  • Field Name: customizations.mpp.softKeyLayout.psk.setToDefault
  • Type: Boolean
PSK 1
  • Field Name: customizations.mpp.softKeyLayout.psk.psk1
  • Type: String
PSK 2
  • Field Name: customizations.mpp.softKeyLayout.psk.psk2
  • Type: String
PSK 3
  • Field Name: customizations.mpp.softKeyLayout.psk.psk3
  • Type: String
PSK 4
  • Field Name: customizations.mpp.softKeyLayout.psk.psk4
  • Type: String
PSK 5
  • Field Name: customizations.mpp.softKeyLayout.psk.psk5
  • Type: String
PSK 6
  • Field Name: customizations.mpp.softKeyLayout.psk.psk6
  • Type: String
PSK 7
  • Field Name: customizations.mpp.softKeyLayout.psk.psk7
  • Type: String
PSK 8
  • Field Name: customizations.mpp.softKeyLayout.psk.psk8
  • Type: String
PSK 9
  • Field Name: customizations.mpp.softKeyLayout.psk.psk9
  • Type: String
PSK 10
  • Field Name: customizations.mpp.softKeyLayout.psk.psk10
  • Type: String
PSK 11
  • Field Name: customizations.mpp.softKeyLayout.psk.psk11
  • Type: String
PSK 12
  • Field Name: customizations.mpp.softKeyLayout.psk.psk12
  • Type: String
PSK 13
  • Field Name: customizations.mpp.softKeyLayout.psk.psk13
  • Type: String
PSK 14
  • Field Name: customizations.mpp.softKeyLayout.psk.psk14
  • Type: String
PSK 15
  • Field Name: customizations.mpp.softKeyLayout.psk.psk15
  • Type: String
PSK 16
  • Field Name: customizations.mpp.softKeyLayout.psk.psk16
  • Type: String
Default SoftKey layouts
  • Field Name: softKeyMenuDefaults
  • Type: Object
Idle key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.idleKeyList
  • Type: String
Off-hook key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.offHookKeyList
  • Type: String
Dialling input key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.dialingInputKeyList
  • Type: String
Progressing key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.progressingKeyList
  • Type: String
Connected key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.connectedKeyList
  • Type: String
Connected video key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.connectedVideoKeyList
  • Type: String
Start transfer key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.startTransferKeyList
  • Type: String
Start conference key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.startConferenceKeyList
  • Type: String
Conferencing key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.conferencingKeyList
  • Type: String
Releasing key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.releasingKeyList
  • Type: String
Hold key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.holdKeyList
  • Type: String
Ringing key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.ringingKeyList
  • Type: String
Shared active key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.sharedActiveKeyList
  • Type: String
Shared held key list
  • Field Name: customizations.mpp.softKeyLayout.softKeyMenuDefaults.sharedHeldKeyList
  • Type: String
PSK Defaults
  • Field Name: pskDefaults
  • Type: Object
PSK 1
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk1
  • Type: String
PSK 2
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk2
  • Type: String
PSK 3
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk3
  • Type: String
PSK 4
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk4
  • Type: String
PSK 5
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk5
  • Type: String
PSK 6
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk6
  • Type: String
PSK 7
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk7
  • Type: String
PSK 8
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk8
  • Type: String
PSK 9
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk9
  • Type: String
PSK 10
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk10
  • Type: String
PSK 11
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk11
  • Type: String
PSK 12
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk12
  • Type: String
PSK 13
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk13
  • Type: String
PSK 14
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk14
  • Type: String
PSK 15
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk15
  • Type: String
PSK 16
  • Field Name: customizations.mpp.softKeyLayout.pskDefaults.psk16
  • Type: String
Accessibility – Voice feedback Controls the visibility of the Accessibility – Voice Feedback menu on the MPP device so that the feature cannot be enabled from the phone.
  • Field Name: customizations.mpp.voiceFeedbackAccessibilityEnabled
  • Type: Boolean
WiFi
  • Field Name: wifi
  • Type: Object
deviceIsWiFi This is a control field providing a boolean to trigger the VOSS GUI rule in order to display WiFi values
  • Field Name: customizations.wifi.deviceIsWiFi
  • Type: Boolean
Audio Codec Priority
  • Field Name: audioCodecPriority
  • Type: Object
Use Custom Values Override regional defaults with customised values
  • Field Name: customizations.wifi.audioCodecPriority.custom
  • Type: Boolean
Primary
  • Field Name: customizations.wifi.audioCodecPriority.primary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Secondary
  • Field Name: customizations.wifi.audioCodecPriority.secondary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Tertiary
  • Field Name: customizations.wifi.audioCodecPriority.tertiary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
LDAP
  • Field Name: ldap
  • Type: Object
Enabled
  • Field Name: customizations.wifi.ldap.enabled
  • Type: Boolean
Server address
  • Field Name: customizations.wifi.ldap.serverAddress
  • Type: String
Server port
  • Field Name: customizations.wifi.ldap.serverPort
  • Type: Integer
Communication security
  • Field Name: customizations.wifi.ldap.commSecurityType
  • Type: String
  • Choices: ["StartTLS", "SSL", "None"]
Bind DN
  • Field Name: customizations.wifi.ldap.bindDn
  • Type: String
Bind PW
  • Field Name: customizations.wifi.ldap.bindPw
  • Type: String
Base DN
  • Field Name: customizations.wifi.ldap.baseDn
  • Type: String
Primary email address
  • Field Name: customizations.wifi.ldap.primaryEmailAttribute
  • Type: String
Alternative email address
  • Field Name: customizations.wifi.ldap.alternateEmailAttribute
  • Type: String
Web access
  • Field Name: webAccess
  • Type: Object
Enabled Sets the availability of the local end user web access for an 840/860 Wi-fi phone.
  • Field Name: customizations.wifi.webAccess.enabled
  • Type: Boolean
Set password
  • Field Name: customizations.wifi.webAccess.password
  • Type: String
Phone security password Sets the local security password on an 840/860 Wi-Fi phone. Minimum 3 and maximum 6 characters.
  • Field Name: customizations.wifi.phoneSecurityPwd
  • Type: String
Define customised device settings Apply the location’s default settings or customise the settings for this device. Then resync the device to apply these changes.
  • Field Name: customEnabled
  • Type: Boolean
Update In Progress
  • Field Name: updateInProgress
  • Type: Boolean
Last Update Time
  • Field Name: lastUpdateTime
  • Type: String
Device Count
  • Field Name: deviceCount
  • Type: Integer
Max Line Count
  • Field Name: maxLineCount
  • Type: String
lines
  • Field Name: members.[n]
  • Type: Array
id
  • Field Name: members.[n].id
  • Type: String
Person
  • Field Name: members.[n].personId
  • Type: String
  • Target: device/spark/User
  • Target attr: email
  • Format: uri
Workspace Name
  • Field Name: members.[n].workspaceId
  • Type: String
  • Target: device/spark/Place
  • Target attr: displayName
  • Format: uri
First Name
  • Field Name: members.[n].firstName
  • Type: String
Last Name
  • Field Name: members.[n].lastName
  • Type: String
Phone Number
  • Field Name: members.[n].phoneNumber
  • Type: String
Extension
  • Field Name: members.[n].extension
  • Type: String
Primary Owner
  • Field Name: members.[n].primaryOwner
  • Type: Boolean
Port
  • Field Name: members.[n].port
  • Type: Integer
T38 Fax Compression Enabled
  • Field Name: members.[n].t38FaxCompressionEnabled
  • Type: Boolean
Line Type
  • Field Name: members.[n].lineType
  • Type: String
  • Choices: ["PRIMARY", "SHARED_CALL_APPEARANCE"]
Line Weight
  • Field Name: members.[n].lineWeight
  • Type: Integer
Host IP
  • Field Name: members.[n].hostIP
  • Type: String
Remote IP
  • Field Name: members.[n].remoteIP
  • Type: String
Hotline Enabled
  • Field Name: members.[n].hotlineEnabled
  • Type: Boolean
Hotline Destination
  • Field Name: members.[n].hotlineDestination
  • Type: String
Allow Call Decline Enabled
  • Field Name: members.[n].allowCallDeclineEnabled
  • Type: Boolean
Line Label
  • Field Name: members.[n].lineLabel
  • Type: String
Line Port
  • Field Name: members.[n].linePort
  • Type: String
Member Type
  • Field Name: members.[n].memberType
  • Type: String
  • Choices: ["PEOPLE", "PLACE", "VIRTUAL_LINE"]
location
  • Field Name: location
  • Type: Object
id
  • Field Name: members.[n].location.id
  • Type: String
Name
  • Field Name: members.[n].location.name
  • Type: String