Webex · Schema

VolumeSettingsObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
ringerVolume number Specify a ringer volume level through a numeric value between 0 and 15.
speakerVolume number Specify a speaker volume level through a numeric value between 0 and 15.
handsetVolume number Specify a handset volume level through a numeric value between 0 and 15.
headsetVolume number Specify a headset volume level through a numeric value between 0 and 15.
eHookEnabled boolean Enable/disable the wireless headset hookswitch control.
allowEndUserOverrideEnabled boolean Enable/disable to preserve the existing values on the phone and not the values defined for the device settings.
View JSON Schema on GitHub

JSON Schema

webex-volumesettingsobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VolumeSettingsObject",
  "title": "VolumeSettingsObject",
  "type": "object",
  "required": [
    "ringerVolume",
    "speakerVolume",
    "handsetVolume",
    "headsetVolume",
    "eHookEnabled",
    "allowEndUserOverrideEnabled"
  ],
  "properties": {
    "ringerVolume": {
      "type": "number",
      "example": 9,
      "description": "Specify a ringer volume level through a numeric value between 0 and 15."
    },
    "speakerVolume": {
      "type": "number",
      "example": 11,
      "description": "Specify a speaker volume level through a numeric value between 0 and 15."
    },
    "handsetVolume": {
      "type": "number",
      "example": 10,
      "description": "Specify a handset volume level through a numeric value between 0 and 15."
    },
    "headsetVolume": {
      "type": "number",
      "example": 10,
      "description": "Specify a headset volume level through a numeric value between 0 and 15."
    },
    "eHookEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable the wireless headset hookswitch control."
    },
    "allowEndUserOverrideEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable to preserve the existing values on the phone and not the values defined for the device settings."
    }
  }
}