Webex · Schema

mppObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
pnacEnabled boolean Indicates whether the PNAC of MPP object is enabled or not.
audioCodecPriority object Choose up to three predefined codec priority options available for your region.
backlightTimer object Choose the length of time (in minutes) for the phone's backlight to remain on.
background object
displayNameFormat object The display name that appears on the phone screen.
cdpEnabled boolean Allows you to enable/disable CDP for local devices.
defaultLoggingLevel object Choose the desired logging level for an MPP devices.
dndServicesEnabled boolean Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones.
acd object Holds the Acd object value.
shortInterdigitTimer number Indicates the short inter digit timer value.
longInterdigitTimer number Indicates the long inter digit timer value..
lineKeyLabelFormat object Line key labels define the format of what's shown next to line keys.
lineKeyLEDPattern object LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875
lldpEnabled boolean Enable/disable Link Layer Discovery Protocol for local devices.
mppUserWebAccessEnabled boolean Enable/disable user-level access to the web interface of Multi-Platform Phones.
multicast array Select up to 10 Multicast Group URLs (each with a unique Listening Port).
enhancedMulticast object Specify the enhanced multicast settings for the MPP device.
offHookTimer number Specify the amount of time (in seconds) that a phone can remain off-hook.
phoneLanguage object Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location.
poeMode object Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones.
qosEnabled boolean Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform.
screenTimeout object Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates.
usbPortsEnabled boolean Enable/disable the use of the USB ports on Multi-Platform phones.
vlan object Specify a numeric Virtual LAN ID for devices.
wifiNetwork object Specify the Wi-Fi SSID and password for wireless-enabled MPP phones.
callHistory object Specify the call history information to use. Only applies to user devices.
contacts object Specify the directory services to use.
webexMeetingsEnabled boolean Enable/disable the availability of the webex meetings functionality from the phone.
volumeSettings object Specify all volume level values on the phone.
cfExpandedSoftKey object Specify the call forward expanded soft key behavior.
httpProxy object Specify HTTP Proxy values.
bluetooth object Enable/disable the visibility of the bluetooth menu on the MPP device.
passThroughPortEnabled boolean Enable/disable the use of the PC passthrough ethernet port on supported phone models.
userPasswordOverrideEnabled boolean Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device.
activeCallFocusEnabled boolean Enable/disable the default screen behavior when inbound calls are received.
peerFirmwareEnabled boolean Enable/disable peer firmware sharing.
noiseCancellation object Enable/disable local noise cancellation on active calls from the device.
voiceFeedbackAccessibilityEnabled boolean Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device.
dialAssistEnabled boolean Enable/disable availability of dial assist feature on the phone.
callsPerLine number Specify the number of calls per unique line appearance on the phone.
nightlyResyncEnabled boolean Enable/disable automatic nightly configuration resync of the MPP device.
missedCallNotificationEnabled boolean Enable/disable the visual indication of missed calls.
softKeyLayout object Specify the softkey layout per phone menu state.
backgroundImage8875 object Specify the image option for the MPP 8875 phone background.
backlightTimer68XX78XX object Specify the use of the backlight feature on 6800 nad 7800 series devices.
allowMonitorLinesEnabled boolean Enable/disable monitoring for MPP non-primary device.
iceEnabled boolean Enable/disable SIP media streams to go directly between phones on the same local network.
View JSON Schema on GitHub

JSON Schema

webex-mppobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/mppObject",
  "title": "mppObject",
  "type": "object",
  "required": [
    "pnacEnabled",
    "audioCodecPriority",
    "backlightTimer",
    "background",
    "cdpEnabled",
    "defaultLoggingLevel",
    "dndServicesEnabled",
    "acd",
    "shortInterdigitTimer",
    "longInterdigitTimer",
    "lineKeyLabelFormat",
    "lineKeyLEDPattern",
    "lldpEnabled",
    "mppUserWebAccessEnabled",
    "multicast",
    "enhancedMulticast",
    "offHookTimer",
    "phoneLanguage",
    "poeMode",
    "qosEnabled",
    "screenTimeout",
    "usbPortsEnabled",
    "vlan",
    "wifiNetwork",
    "callHistory",
    "contacts",
    "webexMeetingsEnabled",
    "volumeSettings",
    "cfExpandedSoftKey",
    "httpProxy",
    "bluetooth",
    "passThroughPortEnabled",
    "userPasswordOverrideEnabled",
    "activeCallFocusEnabled",
    "peerFirmwareEnabled",
    "noiseCancellation",
    "voiceFeedbackAccessibilityEnabled",
    "dialAssistEnabled",
    "callsPerLine",
    "nightlyResyncEnabled",
    "missedCallNotificationEnabled",
    "softKeyLayout",
    "backgroundImage8875",
    "backlightTimer68XX78XX",
    "allowMonitorLinesEnabled"
  ],
  "properties": {
    "pnacEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates whether the PNAC of MPP object is enabled or not."
    },
    "audioCodecPriority": {
      "$ref": "#/components/schemas/MppAudioCodecPriorityObject",
      "description": "Choose up to three predefined codec priority options available for your region."
    },
    "backlightTimer": {
      "$ref": "#/components/schemas/BacklightTimerObject",
      "description": "Choose the length of time (in minutes) for the phone's backlight to remain on."
    },
    "background": {
      "type": "object",
      "properties": {
        "image": {
          "$ref": "#/components/schemas/BackgroundImage"
        },
        "customUrl": {
          "type": "string"
        }
      }
    },
    "displayNameFormat": {
      "$ref": "#/components/schemas/DisplayNameSelection",
      "description": "The display name that appears on the phone screen."
    },
    "cdpEnabled": {
      "type": "boolean",
      "description": "Allows you to enable/disable CDP for local devices."
    },
    "defaultLoggingLevel": {
      "$ref": "#/components/schemas/DefaultLoggingLevelObject",
      "description": "Choose the desired logging level for an MPP devices."
    },
    "dndServicesEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones."
    },
    "acd": {
      "$ref": "#/components/schemas/AcdObject",
      "description": "Holds the Acd object value."
    },
    "shortInterdigitTimer": {
      "type": "number",
      "example": 14,
      "description": "Indicates the short inter digit timer value."
    },
    "longInterdigitTimer": {
      "type": "number",
      "example": 16,
      "description": "Indicates the long inter digit timer value.."
    },
    "lineKeyLabelFormat": {
      "$ref": "#/components/schemas/LineKeyLabelSelection",
      "description": "Line key labels define the format of what's shown next to line keys."
    },
    "lineKeyLEDPattern": {
      "$ref": "#/components/schemas/LineKeyLEDPattern",
      "description": "LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875"
    },
    "lldpEnabled": {
      "type": "boolean",
      "description": "Enable/disable Link Layer Discovery Protocol for local devices."
    },
    "mppUserWebAccessEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable user-level access to the web interface of Multi-Platform Phones."
    },
    "multicast": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "[\"192.86.108.226:22\"]"
      },
      "description": "Select up to 10 Multicast Group URLs (each with a unique Listening Port)."
    },
    "enhancedMulticast": {
      "$ref": "#/components/schemas/EnhancedMulticastObject",
      "description": "Specify the enhanced multicast settings for the MPP device."
    },
    "offHookTimer": {
      "type": "number",
      "example": 30,
      "description": "Specify the amount of time (in seconds) that a phone can remain off-hook."
    },
    "phoneLanguage": {
      "$ref": "#/components/schemas/PhoneLanguage",
      "description": "Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location."
    },
    "poeMode": {
      "$ref": "#/components/schemas/PoeMode",
      "description": "Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones."
    },
    "qosEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform."
    },
    "screenTimeout": {
      "$ref": "#/components/schemas/ScreenTimeoutObject",
      "description": "Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates."
    },
    "usbPortsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable the use of the USB ports on Multi-Platform phones."
    },
    "vlan": {
      "$ref": "#/components/schemas/MppVlanObject",
      "description": "Specify a numeric Virtual LAN ID for devices."
    },
    "wifiNetwork": {
      "$ref": "#/components/schemas/WifiNetworkObject",
      "description": "Specify the Wi-Fi SSID and password for wireless-enabled MPP phones."
    },
    "callHistory": {
      "$ref": "#/components/schemas/CallHistoryMethod",
      "description": "Specify the call history information to use. Only applies to user devices."
    },
    "contacts": {
      "$ref": "#/components/schemas/DirectoryMethod",
      "description": "Specify the directory services to use."
    },
    "webexMeetingsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable the availability of the webex meetings functionality from the phone."
    },
    "volumeSettings": {
      "$ref": "#/components/schemas/VolumeSettingsObject",
      "description": "Specify all volume level values on the phone."
    },
    "cfExpandedSoftKey": {
      "$ref": "#/components/schemas/CallForwardExpandedSoftKey",
      "description": "Specify the call forward expanded soft key behavior."
    },
    "httpProxy": {
      "$ref": "#/components/schemas/HttpProxyObject",
      "description": "Specify HTTP Proxy values."
    },
    "bluetooth": {
      "$ref": "#/components/schemas/BluetoothObject",
      "description": "Enable/disable the visibility of the bluetooth menu on the MPP device."
    },
    "passThroughPortEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable the use of the PC passthrough ethernet port on supported phone models."
    },
    "userPasswordOverrideEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device."
    },
    "activeCallFocusEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable the default screen behavior when inbound calls are received."
    },
    "peerFirmwareEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable peer firmware sharing."
    },
    "noiseCancellation": {
      "$ref": "#/components/schemas/NoiseCancellationObject",
      "description": "Enable/disable local noise cancellation on active calls from the device."
    },
    "voiceFeedbackAccessibilityEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device."
    },
    "dialAssistEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable availability of dial assist feature on the phone."
    },
    "callsPerLine": {
      "type": "number",
      "example": 9,
      "description": "Specify the number of calls per unique line appearance on the phone."
    },
    "nightlyResyncEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable automatic nightly configuration resync of the MPP device."
    },
    "missedCallNotificationEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable the visual indication of missed calls."
    },
    "softKeyLayout": {
      "$ref": "#/components/schemas/SoftKeyLayoutObject",
      "description": "Specify the softkey layout per phone menu state."
    },
    "backgroundImage8875": {
      "$ref": "#/components/schemas/BackgroundImageColor",
      "description": "Specify the image option for the MPP 8875 phone background."
    },
    "backlightTimer68XX78XX": {
      "$ref": "#/components/schemas/BacklightTimer68XX",
      "description": "Specify the use of the backlight feature on 6800 nad 7800 series devices."
    },
    "allowMonitorLinesEnabled": {
      "type": "boolean",
      "description": "Enable/disable monitoring for MPP non-primary device."
    },
    "iceEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable SIP media streams to go directly between phones on the same local network."
    }
  }
}