[Index]

Model: relation/WebexDevice

Devices (Webex App)

Full HTML Help

Overview

You can add, update, and delete Webex devices in Automate, including collaboration devices, ATA (analog telephone adaptor) devices, MPP (IP desk phone) devices, and Wi-Fi devices.

You can also add Webex devices in the Webex Control Hub and sync in those devices to the correct hierarchy in Automate.

Note

MPP, ATA, and Wi-FI device types supported in the Control Hub are dynamically retrieved, along with their respective configuration settings, from the Control Hub via the Control Hub's supported device API using Automate's device/spark/SupportedDevices model. This model populates the drop-downs in Automate where you can select a Control Hub supported device.

Webex devices are added by their MAC address to either a user or to a new or existing workspace. In Automate, devices can be added and updated via the Webex App Devices management page (described in this topic) or via Webex App Quick Add Device.

Note

Several configuration options are available for each device type. You can manually configure all these options via the Devices management page, or auto apply configuration via Quick Add Device.

Related Topics

Configure Cisco Webex App Devices

Cisco Webex App devices are managed via the Devices page.

You can select these tabs on the Cisco Webex App Device management page:

Note

You can toggle the toolbar Tab/Panel icon to display the page layout as either tabs or panels.

Device

The Device tab/panel displays read-only device details, such as the MAC address (device name) for a particular device.

When adding a device, you'll choose the product (device type), and define whether to associate the device with a workspace or a person. When choosing a device, configuration settings relevant to the device type become available in Advanced Configuration.

Note

A device can be associated either with a workspace or with a person (Webex user), but not with both.

A device associated with a person is defined as a personal device. The Person column in the Webex Devices summary list view displays the person ID (converted to an email address) when a person (rather than a workspace) is associated with a device.

The email address is used to identify the device and the associated user so that both can be moved to the correct hierarchy in a sync.

Advanced Configuration

The Advanced Configuration tab/panel defines the calling parameters for a device. The available configuration settings depend on the device type, for example, MPP, ATA, or Wi-Fi device.

If you wish to apply custom configuration settings to the device, select Define customized device settings to display the additional custom configuration options for the device.

Note

Device-specific custom configuration settings are the same settings that may be defined on the Control Hub for the device type.

The image displays custom configuration settings for a MPP device:

Note

To reset values for the custom softkey menus or the PSKs, select the applicable Reset to Default Values checkbox. When saving your settings, the default values are retrieved from the Control Hub to replace any custom values.

The image displays custom configuration options for an ATA device:

The image displays custom configuration options for a Wi-Fi device:

Hide custom configuration settings

To hide the custom settings and apply default settings from the Control Hub for the customer and site, deselect Define customized device settings.

Webex Device with device settings

Model Details: relation/WebexDevice

Title Description Details
Device Group Assigned by FDP
  • Field Name: Device
  • Type: Object
Name A friendly name for the device.
  • Field Name: Device.displayName
  • Type: String
Product The product name.
  • Field Name: Device.product
  • Type: String
Serial Serial number for the device.
  • Field Name: Device.serial
  • Type: String
Workspace Id The workspace ID associated with the device.
  • Field Name: Device.workspaceId
  • Type: String
Workspace The workspace Name associated with the device.
  • Field Name: Device.workspaceName
  • Type: String
  • Target: device/spark/Place
  • Target attr: displayName
  • Format: uri
Person Id The person ID associated with the device.
  • Field Name: Device.personId
  • Type: String
  • Target: device/spark/User
  • Target attr: email
  • Format: uri
Person The person Email associated with the device.
  • Field Name: Device.personEmail
  • Type: String
  • Target: device/spark/User
  • Target attr: email
  • Format: uri
MAC Address The unique address for the network adapter.
  • Field Name: Device.mac
  • Type: String
IP Address The current IP address of the device.
  • Field Name: Device.ip
  • Type: String
Software The operating system name data and version tag.
  • Field Name: Device.software
  • Type: String
Errors This device has the following issues.
  • Field Name: Device.errorCodes
  • Type: String
Tags Tags assigned to the device.
  • Field Name: Device.tags
  • Type: String
Upgrade Channel The upgrade channel the device is assigned to.
  • Field Name: Device.upgradeChannel
  • Type: String
Permissions The permissions the user has for this device. For example, xapi means this user is entitled to using the xapi against this device.
  • Field Name: Device.permissions
  • Type: String
password Password for third party device.
  • Field Name: Device.password
  • Type: String
  • Is Password: True
Primary SIP URL The primary SIP address to dial this device.
  • Field Name: Device.primarySipUrl
  • Type: String
SIP URLs All SIP addresses to dial this device.
  • Field Name: Device.sipUrls
  • Type: String
Created The date and time that the device was registered, in ISO8601 format.
  • Field Name: Device.created
  • Type: String
Connection Status The connection status of the device.
  • Field Name: Device.connectionStatus
  • Type: String
Lines Group Assigned by FDP
  • Field Name: Lines
  • Type: Object
Max Line Count
  • Field Name: Lines.maxLineCount
  • Type: String
Device Config
  • Field Name: deviceConfig
  • Type: Object
Max Line Count
  • Field Name: Lines.deviceConfig.maxLineCount
  • Type: String
lines
  • Field Name: members.[n]
  • Type: Array
Port
  • Field Name: Lines.deviceConfig.members.[n].port
  • Type: Integer
Member Type
  • Field Name: Lines.deviceConfig.members.[n].memberType
  • Type: String
  • Choices: ["PEOPLE", "PLACE", "VIRTUAL_LINE"]
Person
  • Field Name: Lines.deviceConfig.members.[n].personId
  • Type: String
  • Target: device/spark/User
  • Target attr: email
  • Format: uri
Workspace Name
  • Field Name: Lines.deviceConfig.members.[n].workspaceId
  • Type: String
  • Target: device/spark/Place
  • Target attr: displayName
  • Format: uri
Phone Number
  • Field Name: Lines.deviceConfig.members.[n].phoneNumber
  • Type: String
Extension
  • Field Name: Lines.deviceConfig.members.[n].extension
  • Type: String
First Name
  • Field Name: Lines.deviceConfig.members.[n].firstName
  • Type: String
Last Name
  • Field Name: Lines.deviceConfig.members.[n].lastName
  • Type: String
Primary Owner
  • Field Name: Lines.deviceConfig.members.[n].primaryOwner
  • Type: Boolean
Allow Call Decline Enabled
  • Field Name: Lines.deviceConfig.members.[n].allowCallDeclineEnabled
  • Type: Boolean
Host IP
  • Field Name: Lines.deviceConfig.members.[n].hostIP
  • Type: String
Remote IP
  • Field Name: Lines.deviceConfig.members.[n].remoteIP
  • Type: String
Hotline Enabled
  • Field Name: Lines.deviceConfig.members.[n].hotlineEnabled
  • Type: Boolean
Hotline Destination
  • Field Name: Lines.deviceConfig.members.[n].hotlineDestination
  • Type: String
Line Label
  • Field Name: Lines.deviceConfig.members.[n].lineLabel
  • Type: String
Line Port
  • Field Name: Lines.deviceConfig.members.[n].linePort
  • Type: String
Line Type
  • Field Name: Lines.deviceConfig.members.[n].lineType
  • Type: String
  • Choices: ["PRIMARY", "SHARED_CALL_APPEARANCE"]
Line Weight
  • Field Name: Lines.deviceConfig.members.[n].lineWeight
  • Type: Integer
T38 Fax Compression Enabled
  • Field Name: Lines.deviceConfig.members.[n].t38FaxCompressionEnabled
  • Type: Boolean
location
  • Field Name: location
  • Type: Object
Name
  • Field Name: Lines.deviceConfig.members.[n].location.name
  • Type: String
lines
  • Field Name: members.[n]
  • Type: Array
Port
  • Field Name: Lines.members.[n].port
  • Type: Integer
Member Type
  • Field Name: Lines.members.[n].memberType
  • Type: String
  • Choices: ["PEOPLE", "PLACE", "VIRTUAL_LINE"]
Person
  • Field Name: Lines.members.[n].personId
  • Type: String
  • Target: device/spark/User
  • Target attr: email
  • Format: uri
Workspace Name
  • Field Name: Lines.members.[n].workspaceId
  • Type: String
  • Target: device/spark/Place
  • Target attr: displayName
  • Format: uri
Phone Number
  • Field Name: Lines.members.[n].phoneNumber
  • Type: String
Extension
  • Field Name: Lines.members.[n].extension
  • Type: String
First Name
  • Field Name: Lines.members.[n].firstName
  • Type: String
Last Name
  • Field Name: Lines.members.[n].lastName
  • Type: String
Primary Owner
  • Field Name: Lines.members.[n].primaryOwner
  • Type: Boolean
Allow Call Decline Enabled
  • Field Name: Lines.members.[n].allowCallDeclineEnabled
  • Type: Boolean
Host IP
  • Field Name: Lines.members.[n].hostIP
  • Type: String
Remote IP
  • Field Name: Lines.members.[n].remoteIP
  • Type: String
Hotline Enabled
  • Field Name: Lines.members.[n].hotlineEnabled
  • Type: Boolean
Hotline Destination
  • Field Name: Lines.members.[n].hotlineDestination
  • Type: String
Line Label
  • Field Name: Lines.members.[n].lineLabel
  • Type: String
Line Port
  • Field Name: Lines.members.[n].linePort
  • Type: String
Line Type
  • Field Name: Lines.members.[n].lineType
  • Type: String
  • Choices: ["PRIMARY", "SHARED_CALL_APPEARANCE"]
Line Weight
  • Field Name: Lines.members.[n].lineWeight
  • Type: Integer
T38 Fax Compression Enabled
  • Field Name: Lines.members.[n].t38FaxCompressionEnabled
  • Type: Boolean
location
  • Field Name: location
  • Type: Object
Name
  • Field Name: Lines.members.[n].location.name
  • Type: String
Advanced Configuration Group Assigned by FDP
  • Field Name: Advanced Configuration
  • Type: Object
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: Advanced Configuration.customEnabled
  • Type: Boolean
Device Config
  • Field Name: deviceConfig
  • Type: Object
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: Advanced Configuration.deviceConfig.customEnabled
  • Type: Boolean
Customisations
  • Field Name: customizations
  • Type: Object
ATA
  • Field Name: ata
  • Type: Object
Audio Codec Priority
  • Field Name: audioCodecPriority
  • Type: Object
Use Custom Values Override regional defaults with customised values
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.audioCodecPriority.custom
  • Type: Boolean
Primary
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.audioCodecPriority.primary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Secondary
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.audioCodecPriority.secondary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Tertiary
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.audioCodecPriority.tertiary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
SNMP
  • Field Name: snmp
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.snmp.enabled
  • Type: Boolean
Get community
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.snmp.getCommunity
  • Type: String
Set community
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.snmp.setCommunity
  • Type: String
SNMP V3
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.snmp.snmpV3Enabled
  • Type: Boolean
Trusted IP
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.snmp.trustedIP
  • Type: String
VLAN
  • Field Name: vlan
  • Type: Object
VLAN Enabled
  • Field Name: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.ata.vlan.value
  • Type: Integer
ATA DTMF mode Choose the DTMF mode for Cisco ATA devices. Please note – misconfiguration may cause service impacts.
  • Field Name: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.ata.lldpEnabled
  • 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: Advanced Configuration.deviceConfig.customizations.ata.nightlyResyncEnabled
  • Type: Boolean
QoS Enable or disable the QOS tagging of packets from the local device to the Webex Calling platform.
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.qosEnabled
  • Type: Boolean
Web access Controls user-level web access to the local device.
  • Field Name: Advanced Configuration.deviceConfig.customizations.ata.webAccessEnabled
  • Type: Boolean
MPP
  • Field Name: mpp
  • Type: Object
ACD
  • Field Name: acd
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.mpp.acd.displayCallqueueAgentSoftkeys
  • Type: String
  • Choices: ["Front page", "Last page"]
Audio Codec Priority
  • Field Name: audioCodecPriority
  • Type: Object
Use Custom Values Override regional defaults with customised values
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.audioCodecPriority.custom
  • Type: Boolean
Primary
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.audioCodecPriority.primary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Secondary
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.audioCodecPriority.secondary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Tertiary
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.audioCodecPriority.tertiary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Background Image
  • Field Name: background
  • Type: Object
Custom URL
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.background.customUrl
  • Type: String
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: Advanced Configuration.deviceConfig.customizations.mpp.background.image
  • Type: String
  • Choices: ["None", "Dark Blue", "Cisco Dark Blue", "Webex Dark Blue", "Custom Background"]
Background Image Choose from the image options for the MPP 8875 phone background.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.backgroundImage8875
  • Type: String
  • Choices: ["Dark Cyan", "Dark Purple", "Dark Blue", "Light Blue", "Dark Violet", "Light Violet"]
Bluetooth menu
  • Field Name: bluetooth
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.bluetooth.enabled
  • Type: Boolean
Bluetooth mode
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.bluetooth.mode
  • Type: String
  • Choices: ["Phone", "Hands-free", "Both"]
Default volume settings
  • Field Name: volumeSettings
  • Type: Object
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: Advanced Configuration.deviceConfig.customizations.mpp.volumeSettings.allowEndUserOverrideEnabled
  • Type: Boolean
Wireless headset hookswitch control Enable/disable the wireless headset hookswitch control.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.volumeSettings.eHookEnabled
  • Type: Boolean
Handset volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.volumeSettings.handsetVolume
  • Type: Integer
Headset volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.volumeSettings.headsetVolume
  • Type: Integer
Ringer volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.volumeSettings.ringerVolume
  • Type: Integer
Speaker volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.volumeSettings.speakerVolume
  • Type: Integer
HTTP Proxy
  • Field Name: httpProxy
  • Type: Object
HTTP mode
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.httpProxy.mode
  • Type: String
  • Choices: ["Off", "Manual", "Auto"]
Auto discovery
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.httpProxy.autoDiscoveryEnabled
  • Type: Boolean
PAC URL
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.httpProxy.packUrl
  • Type: String
Host
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.httpProxy.host
  • Type: String
Port
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.httpProxy.port
  • Type: String
Authentication settings
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.httpProxy.authSettingsEnabled
  • Type: Boolean
Username
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.httpProxy.username
  • Type: String
Password
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.httpProxy.password
  • Type: String
Noise cancellation
  • Field Name: noiseCancellation
  • Type: Object
Enabled Controls the local noise cancellation on active calls from the device.
  • Field Name: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.mpp.noiseCancellation.allowEndUserOverrideEnabled
  • Type: Boolean
Screensaver
  • Field Name: screenTimeout
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.mpp.screenTimeout.value
  • Type: Integer
SoftKey layouts
  • Field Name: softKeyLayout
  • Type: Object
Customise PSK
  • Field Name: psk
  • Type: Object
Reset to Default Values Click here and save to restore default psk values
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.setToDefault
  • Type: Boolean
PSK 1
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk1
  • Type: String
PSK 2
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk2
  • Type: String
PSK 3
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk3
  • Type: String
PSK 4
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk4
  • Type: String
PSK 5
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk5
  • Type: String
PSK 6
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk6
  • Type: String
PSK 7
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk7
  • Type: String
PSK 8
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk8
  • Type: String
PSK 9
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk9
  • Type: String
PSK 10
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk10
  • Type: String
PSK 11
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk11
  • Type: String
PSK 12
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk12
  • Type: String
PSK 13
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk13
  • Type: String
PSK 14
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk14
  • Type: String
PSK 15
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk15
  • Type: String
PSK 16
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.psk.psk16
  • Type: String
Customise softkey menus
  • Field Name: softKeyMenu
  • Type: Object
Reset to Default Values Click here and save to restore default softkey menu values
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.setToDefault
  • Type: Boolean
Conferencing key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.conferencingKeyList
  • Type: String
Connected key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.connectedKeyList
  • Type: String
Connected video key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.connectedVideoKeyList
  • Type: String
Dialling input key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.dialingInputKeyList
  • Type: String
Hold key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.holdKeyList
  • Type: String
Idle key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.idleKeyList
  • Type: String
Off-hook key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.offHookKeyList
  • Type: String
Progressing key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.progressingKeyList
  • Type: String
Releasing key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.releasingKeyList
  • Type: String
Ringing key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.ringingKeyList
  • Type: String
Shared active key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.sharedActiveKeyList
  • Type: String
Shared held key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.sharedHeldKeyList
  • Type: String
Start conference key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.startConferenceKeyList
  • Type: String
Start transfer key list
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.softKeyLayout.softKeyMenu.startTransferKeyList
  • Type: String
USB ports
  • Field Name: usbPorts
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.usbPorts.enabled
  • 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: Advanced Configuration.deviceConfig.customizations.mpp.usbPorts.rearUsbEnabled
  • 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: Advanced Configuration.deviceConfig.customizations.mpp.usbPorts.sideUsbEnabled
  • Type: Boolean
VLANs
  • Field Name: vlan
  • Type: Object
VLAN Enabled
  • Field Name: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.mpp.vlan.value
  • Type: Integer
PC Port
  • Field Name: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.mpp.wifiNetwork.enabled
  • Type: Boolean
Authentication Method
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.wifiNetwork.authenticationMethod
  • Type: String
  • Choices: ["NONE", "EAP_FAST", "PEAP_GTC", "PEAP_MSCHAPV2", "PSK", "WEP"]
SSID name
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.wifiNetwork.ssidName
  • Type: String
User
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.wifiNetwork.userId
  • Type: String
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: Advanced Configuration.deviceConfig.customizations.mpp.pnacEnabled
  • Type: Boolean
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: Advanced Configuration.deviceConfig.customizations.mpp.voiceFeedbackAccessibilityEnabled
  • Type: Boolean
Active call focus Controls the default screen behaviour when inbound calls are received.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.activeCallFocusEnabled
  • Type: Boolean
Backlight timer Choose the length of time the backlight should stay on in minutes.
  • Field Name: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.mpp.backlightTimer68XX78XX
  • Type: String
  • Choices: ["10 Seconds", "20 Seconds", "30 Seconds", "Always on", "Off"]
Call forward expanded softkey Sets the default call forward softkey behaviour between the multiple menu option and single option versions.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.cfExpandedSoftKey
  • Type: String
  • Choices: ["Only the call forward all", "All call forwards"]
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: Advanced Configuration.deviceConfig.customizations.mpp.callHistory
  • Type: String
  • Choices: ["Webex Unified call history", "Local call history"]
Calls per line limit Controls the number of calls per unique line appearance on the phone.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.callsPerLine
  • Type: Integer
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: Advanced Configuration.deviceConfig.customizations.mpp.cdpEnabled
  • Type: Boolean
Contacts Sets directory services to either use the standard xsi query method from the device or the Webex enterprise directory.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.contacts
  • Type: String
  • Choices: ["Webex Directory", "XSI Directory"]
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: Advanced Configuration.deviceConfig.customizations.mpp.defaultLoggingLevel
  • Type: String
  • Choices: ["Standard", "Debugging"]
Dial assist Sets the availability of the Dial Assist feature on the phone.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.dialAssistEnabled
  • Type: Boolean
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: Advanced Configuration.deviceConfig.customizations.mpp.displayNameFormat
  • Type: String
  • Choices: ["User phone number/Location number", "User Name (First Name Last Name)", "User Name (Last Name First Name)"]
DND services Enable or disable Do-Not-Disturb capabilities for MPP devices.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.dndServicesEnabled
  • 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: Advanced Configuration.deviceConfig.customizations.mpp.userPasswordOverrideEnabled
  • Type: Boolean
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: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.mpp.lldpEnabled
  • Type: Boolean
Missed call notification Controls the option to display a visual indication on the line appearance when a call is missed.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.missedCallNotificationEnabled
  • 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: Advanced Configuration.deviceConfig.customizations.mpp.mppUserWebAccessEnabled
  • Type: Boolean
Multicast
  • Field Name: multicast.[n]
  • Type: Array
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: Advanced Configuration.deviceConfig.customizations.mpp.nightlyResyncEnabled
  • Type: Boolean
Off-hook timer Specify the amount of time a phone can remain off-the-hook.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.offHookTimer
  • Type: Integer
Passthrough port Controls the use of the PC passthrough Ethernet port on supported phone models.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.passThroughPortEnabled
  • Type: Boolean
Peer firmware enabled
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.peerFirmwareEnabled
  • Type: Boolean
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: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.mpp.qosEnabled
  • Type: Boolean
Webex Meetings Sets the availability of the Webex Meetings functionality from the phone.
  • Field Name: Advanced Configuration.deviceConfig.customizations.mpp.webexMeetingsEnabled
  • Type: Boolean
WiFi
  • Field Name: wifi
  • Type: Object
Audio Codec Priority
  • Field Name: audioCodecPriority
  • Type: Object
Use Custom Values Override regional defaults with customised values
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.audioCodecPriority.custom
  • Type: Boolean
Primary
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.audioCodecPriority.primary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Secondary
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.audioCodecPriority.secondary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Tertiary
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.audioCodecPriority.tertiary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
LDAP
  • Field Name: ldap
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.ldap.enabled
  • Type: Boolean
Server address
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.ldap.serverAddress
  • Type: String
Server port
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.ldap.serverPort
  • Type: Integer
Communication security
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.ldap.commSecurityType
  • Type: String
  • Choices: ["StartTLS", "SSL", "None"]
Bind DN
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.ldap.bindDn
  • Type: String
Bind PW
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.ldap.bindPw
  • Type: String
Base DN
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.ldap.baseDn
  • Type: String
Primary email address
  • Field Name: Advanced Configuration.deviceConfig.customizations.wifi.ldap.primaryEmailAttribute
  • Type: String
Alternative email address
  • Field Name: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.wifi.webAccess.enabled
  • Type: Boolean
Set password
  • Field Name: Advanced Configuration.deviceConfig.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: Advanced Configuration.deviceConfig.customizations.wifi.phoneSecurityPwd
  • Type: String
Last Update Time
  • Field Name: Advanced Configuration.deviceConfig.lastUpdateTime
  • Type: String
Update In Progress
  • Field Name: Advanced Configuration.deviceConfig.updateInProgress
  • Type: Boolean
Customisations
  • Field Name: customizations
  • Type: Object
ATA
  • Field Name: ata
  • Type: Object
Audio Codec Priority
  • Field Name: audioCodecPriority
  • Type: Object
Use Custom Values Override regional defaults with customised values
  • Field Name: Advanced Configuration.customizations.ata.audioCodecPriority.custom
  • Type: Boolean
Primary
  • Field Name: Advanced Configuration.customizations.ata.audioCodecPriority.primary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Secondary
  • Field Name: Advanced Configuration.customizations.ata.audioCodecPriority.secondary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Tertiary
  • Field Name: Advanced Configuration.customizations.ata.audioCodecPriority.tertiary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
SNMP
  • Field Name: snmp
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.customizations.ata.snmp.enabled
  • Type: Boolean
Get community
  • Field Name: Advanced Configuration.customizations.ata.snmp.getCommunity
  • Type: String
Set community
  • Field Name: Advanced Configuration.customizations.ata.snmp.setCommunity
  • Type: String
SNMP V3
  • Field Name: Advanced Configuration.customizations.ata.snmp.snmpV3Enabled
  • Type: Boolean
Trusted IP
  • Field Name: Advanced Configuration.customizations.ata.snmp.trustedIP
  • Type: String
VLAN
  • Field Name: vlan
  • Type: Object
VLAN Enabled
  • Field Name: Advanced Configuration.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: Advanced Configuration.customizations.ata.vlan.value
  • Type: Integer
ATA DTMF mode Choose the DTMF mode for Cisco ATA devices. Please note – misconfiguration may cause service impacts.
  • Field Name: Advanced Configuration.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: Advanced Configuration.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: Advanced Configuration.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: Advanced Configuration.customizations.ata.lldpEnabled
  • 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: Advanced Configuration.customizations.ata.nightlyResyncEnabled
  • Type: Boolean
QoS Enable or disable the QOS tagging of packets from the local device to the Webex Calling platform.
  • Field Name: Advanced Configuration.customizations.ata.qosEnabled
  • Type: Boolean
Web access Controls user-level web access to the local device.
  • Field Name: Advanced Configuration.customizations.ata.webAccessEnabled
  • Type: Boolean
MPP
  • Field Name: mpp
  • Type: Object
ACD
  • Field Name: acd
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.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: Advanced Configuration.customizations.mpp.acd.displayCallqueueAgentSoftkeys
  • Type: String
  • Choices: ["Front page", "Last page"]
Audio Codec Priority
  • Field Name: audioCodecPriority
  • Type: Object
Use Custom Values Override regional defaults with customised values
  • Field Name: Advanced Configuration.customizations.mpp.audioCodecPriority.custom
  • Type: Boolean
Primary
  • Field Name: Advanced Configuration.customizations.mpp.audioCodecPriority.primary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Secondary
  • Field Name: Advanced Configuration.customizations.mpp.audioCodecPriority.secondary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Tertiary
  • Field Name: Advanced Configuration.customizations.mpp.audioCodecPriority.tertiary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Background Image
  • Field Name: background
  • Type: Object
Custom URL
  • Field Name: Advanced Configuration.customizations.mpp.background.customUrl
  • Type: String
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: Advanced Configuration.customizations.mpp.background.image
  • Type: String
  • Choices: ["None", "Dark Blue", "Cisco Dark Blue", "Webex Dark Blue", "Custom Background"]
Background Image Choose from the image options for the MPP 8875 phone background.
  • Field Name: Advanced Configuration.customizations.mpp.backgroundImage8875
  • Type: String
  • Choices: ["Dark Cyan", "Dark Purple", "Dark Blue", "Light Blue", "Dark Violet", "Light Violet"]
Bluetooth menu
  • Field Name: bluetooth
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.customizations.mpp.bluetooth.enabled
  • Type: Boolean
Bluetooth mode
  • Field Name: Advanced Configuration.customizations.mpp.bluetooth.mode
  • Type: String
  • Choices: ["Phone", "Hands-free", "Both"]
Default volume settings
  • Field Name: volumeSettings
  • Type: Object
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: Advanced Configuration.customizations.mpp.volumeSettings.allowEndUserOverrideEnabled
  • Type: Boolean
Wireless headset hookswitch control Enable/disable the wireless headset hookswitch control.
  • Field Name: Advanced Configuration.customizations.mpp.volumeSettings.eHookEnabled
  • Type: Boolean
Handset volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: Advanced Configuration.customizations.mpp.volumeSettings.handsetVolume
  • Type: Integer
Headset volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: Advanced Configuration.customizations.mpp.volumeSettings.headsetVolume
  • Type: Integer
Ringer volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: Advanced Configuration.customizations.mpp.volumeSettings.ringerVolume
  • Type: Integer
Speaker volume Select the Ringer volume level through a numeric value between 0 and 15.
  • Field Name: Advanced Configuration.customizations.mpp.volumeSettings.speakerVolume
  • Type: Integer
HTTP Proxy
  • Field Name: httpProxy
  • Type: Object
HTTP mode
  • Field Name: Advanced Configuration.customizations.mpp.httpProxy.mode
  • Type: String
  • Choices: ["Off", "Manual", "Auto"]
Auto discovery
  • Field Name: Advanced Configuration.customizations.mpp.httpProxy.autoDiscoveryEnabled
  • Type: Boolean
PAC URL
  • Field Name: Advanced Configuration.customizations.mpp.httpProxy.packUrl
  • Type: String
Host
  • Field Name: Advanced Configuration.customizations.mpp.httpProxy.host
  • Type: String
Port
  • Field Name: Advanced Configuration.customizations.mpp.httpProxy.port
  • Type: String
Authentication settings
  • Field Name: Advanced Configuration.customizations.mpp.httpProxy.authSettingsEnabled
  • Type: Boolean
Username
  • Field Name: Advanced Configuration.customizations.mpp.httpProxy.username
  • Type: String
Password
  • Field Name: Advanced Configuration.customizations.mpp.httpProxy.password
  • Type: String
Noise cancellation
  • Field Name: noiseCancellation
  • Type: Object
Enabled Controls the local noise cancellation on active calls from the device.
  • Field Name: Advanced Configuration.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: Advanced Configuration.customizations.mpp.noiseCancellation.allowEndUserOverrideEnabled
  • Type: Boolean
Screensaver
  • Field Name: screenTimeout
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.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: Advanced Configuration.customizations.mpp.screenTimeout.value
  • Type: Integer
SoftKey layouts
  • Field Name: softKeyLayout
  • Type: Object
Customise PSK
  • Field Name: psk
  • Type: Object
Reset to Default Values Click here and save to restore default psk values
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.setToDefault
  • Type: Boolean
PSK 1
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk1
  • Type: String
PSK 2
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk2
  • Type: String
PSK 3
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk3
  • Type: String
PSK 4
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk4
  • Type: String
PSK 5
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk5
  • Type: String
PSK 6
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk6
  • Type: String
PSK 7
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk7
  • Type: String
PSK 8
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk8
  • Type: String
PSK 9
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk9
  • Type: String
PSK 10
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk10
  • Type: String
PSK 11
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk11
  • Type: String
PSK 12
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk12
  • Type: String
PSK 13
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk13
  • Type: String
PSK 14
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk14
  • Type: String
PSK 15
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk15
  • Type: String
PSK 16
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.psk.psk16
  • Type: String
Customise softkey menus
  • Field Name: softKeyMenu
  • Type: Object
Reset to Default Values Click here and save to restore default softkey menu values
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.setToDefault
  • Type: Boolean
Conferencing key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.conferencingKeyList
  • Type: String
Connected key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.connectedKeyList
  • Type: String
Connected video key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.connectedVideoKeyList
  • Type: String
Dialling input key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.dialingInputKeyList
  • Type: String
Hold key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.holdKeyList
  • Type: String
Idle key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.idleKeyList
  • Type: String
Off-hook key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.offHookKeyList
  • Type: String
Progressing key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.progressingKeyList
  • Type: String
Releasing key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.releasingKeyList
  • Type: String
Ringing key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.ringingKeyList
  • Type: String
Shared active key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.sharedActiveKeyList
  • Type: String
Shared held key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.sharedHeldKeyList
  • Type: String
Start conference key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.startConferenceKeyList
  • Type: String
Start transfer key list
  • Field Name: Advanced Configuration.customizations.mpp.softKeyLayout.softKeyMenu.startTransferKeyList
  • Type: String
USB ports
  • Field Name: usbPorts
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.customizations.mpp.usbPorts.enabled
  • 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: Advanced Configuration.customizations.mpp.usbPorts.rearUsbEnabled
  • 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: Advanced Configuration.customizations.mpp.usbPorts.sideUsbEnabled
  • Type: Boolean
VLANs
  • Field Name: vlan
  • Type: Object
VLAN Enabled
  • Field Name: Advanced Configuration.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: Advanced Configuration.customizations.mpp.vlan.value
  • Type: Integer
PC Port
  • Field Name: Advanced Configuration.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: Advanced Configuration.customizations.mpp.wifiNetwork.enabled
  • Type: Boolean
Authentication Method
  • Field Name: Advanced Configuration.customizations.mpp.wifiNetwork.authenticationMethod
  • Type: String
  • Choices: ["NONE", "EAP_FAST", "PEAP_GTC", "PEAP_MSCHAPV2", "PSK", "WEP"]
SSID name
  • Field Name: Advanced Configuration.customizations.mpp.wifiNetwork.ssidName
  • Type: String
User
  • Field Name: Advanced Configuration.customizations.mpp.wifiNetwork.userId
  • Type: String
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: Advanced Configuration.customizations.mpp.pnacEnabled
  • Type: Boolean
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: Advanced Configuration.customizations.mpp.voiceFeedbackAccessibilityEnabled
  • Type: Boolean
Active call focus Controls the default screen behaviour when inbound calls are received.
  • Field Name: Advanced Configuration.customizations.mpp.activeCallFocusEnabled
  • Type: Boolean
Backlight timer Choose the length of time the backlight should stay on in minutes.
  • Field Name: Advanced Configuration.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: Advanced Configuration.customizations.mpp.backlightTimer68XX78XX
  • Type: String
  • Choices: ["10 Seconds", "20 Seconds", "30 Seconds", "Always on", "Off"]
Call forward expanded softkey Sets the default call forward softkey behaviour between the multiple menu option and single option versions.
  • Field Name: Advanced Configuration.customizations.mpp.cfExpandedSoftKey
  • Type: String
  • Choices: ["Only the call forward all", "All call forwards"]
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: Advanced Configuration.customizations.mpp.callHistory
  • Type: String
  • Choices: ["Webex Unified call history", "Local call history"]
Calls per line limit Controls the number of calls per unique line appearance on the phone.
  • Field Name: Advanced Configuration.customizations.mpp.callsPerLine
  • Type: Integer
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: Advanced Configuration.customizations.mpp.cdpEnabled
  • Type: Boolean
Contacts Sets directory services to either use the standard xsi query method from the device or the Webex enterprise directory.
  • Field Name: Advanced Configuration.customizations.mpp.contacts
  • Type: String
  • Choices: ["Webex Directory", "XSI Directory"]
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: Advanced Configuration.customizations.mpp.defaultLoggingLevel
  • Type: String
  • Choices: ["Standard", "Debugging"]
Dial assist Sets the availability of the Dial Assist feature on the phone.
  • Field Name: Advanced Configuration.customizations.mpp.dialAssistEnabled
  • Type: Boolean
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: Advanced Configuration.customizations.mpp.displayNameFormat
  • Type: String
  • Choices: ["User phone number/Location number", "User Name (First Name Last Name)", "User Name (Last Name First Name)"]
DND services Enable or disable Do-Not-Disturb capabilities for MPP devices.
  • Field Name: Advanced Configuration.customizations.mpp.dndServicesEnabled
  • 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: Advanced Configuration.customizations.mpp.userPasswordOverrideEnabled
  • Type: Boolean
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: Advanced Configuration.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: Advanced Configuration.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: Advanced Configuration.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: Advanced Configuration.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: Advanced Configuration.customizations.mpp.lldpEnabled
  • Type: Boolean
Missed call notification Controls the option to display a visual indication on the line appearance when a call is missed.
  • Field Name: Advanced Configuration.customizations.mpp.missedCallNotificationEnabled
  • 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: Advanced Configuration.customizations.mpp.mppUserWebAccessEnabled
  • Type: Boolean
Multicast
  • Field Name: multicast.[n]
  • Type: Array
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: Advanced Configuration.customizations.mpp.nightlyResyncEnabled
  • Type: Boolean
Off-hook timer Specify the amount of time a phone can remain off-the-hook.
  • Field Name: Advanced Configuration.customizations.mpp.offHookTimer
  • Type: Integer
Passthrough port Controls the use of the PC passthrough Ethernet port on supported phone models.
  • Field Name: Advanced Configuration.customizations.mpp.passThroughPortEnabled
  • Type: Boolean
Peer firmware enabled
  • Field Name: Advanced Configuration.customizations.mpp.peerFirmwareEnabled
  • Type: Boolean
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: Advanced Configuration.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: Advanced Configuration.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: Advanced Configuration.customizations.mpp.qosEnabled
  • Type: Boolean
Webex Meetings Sets the availability of the Webex Meetings functionality from the phone.
  • Field Name: Advanced Configuration.customizations.mpp.webexMeetingsEnabled
  • Type: Boolean
WiFi
  • Field Name: wifi
  • Type: Object
Audio Codec Priority
  • Field Name: audioCodecPriority
  • Type: Object
Use Custom Values Override regional defaults with customised values
  • Field Name: Advanced Configuration.customizations.wifi.audioCodecPriority.custom
  • Type: Boolean
Primary
  • Field Name: Advanced Configuration.customizations.wifi.audioCodecPriority.primary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Secondary
  • Field Name: Advanced Configuration.customizations.wifi.audioCodecPriority.secondary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
Tertiary
  • Field Name: Advanced Configuration.customizations.wifi.audioCodecPriority.tertiary
  • Type: String
  • Choices: ["G711u", "G711a", "G729a", "OPUS", "G722"]
LDAP
  • Field Name: ldap
  • Type: Object
Enabled
  • Field Name: Advanced Configuration.customizations.wifi.ldap.enabled
  • Type: Boolean
Server address
  • Field Name: Advanced Configuration.customizations.wifi.ldap.serverAddress
  • Type: String
Server port
  • Field Name: Advanced Configuration.customizations.wifi.ldap.serverPort
  • Type: Integer
Communication security
  • Field Name: Advanced Configuration.customizations.wifi.ldap.commSecurityType
  • Type: String
  • Choices: ["StartTLS", "SSL", "None"]
Bind DN
  • Field Name: Advanced Configuration.customizations.wifi.ldap.bindDn
  • Type: String
Bind PW
  • Field Name: Advanced Configuration.customizations.wifi.ldap.bindPw
  • Type: String
Base DN
  • Field Name: Advanced Configuration.customizations.wifi.ldap.baseDn
  • Type: String
Primary email address
  • Field Name: Advanced Configuration.customizations.wifi.ldap.primaryEmailAttribute
  • Type: String
Alternative email address
  • Field Name: Advanced Configuration.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: Advanced Configuration.customizations.wifi.webAccess.enabled
  • Type: Boolean
Set password
  • Field Name: Advanced Configuration.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: Advanced Configuration.customizations.wifi.phoneSecurityPwd
  • Type: String
Last Update Time
  • Field Name: Advanced Configuration.lastUpdateTime
  • Type: String
Update In Progress
  • Field Name: Advanced Configuration.updateInProgress
  • Type: Boolean