Webex · Schema

GetMusicOnHoldObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
mohEnabled boolean Music on hold enabled or disabled for the workspace.
mohLocationEnabled boolean Music on hold enabled or disabled for the location. The music on hold setting returned in the response is used only when music on hold is enabled at the location level. When `mohLocationEnabled` is fa
greeting string Greeting type for the workspace. * `DEFAULT` - Play music configured at location level. * `CUSTOM` - Play previously uploaded custom music when call is placed on hold or parked.
audioAnnouncementFile object Announcement Audio File details when greeting is selected to be `CUSTOM`.
View JSON Schema on GitHub

JSON Schema

webex-getmusiconholdobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetMusicOnHoldObject",
  "title": "GetMusicOnHoldObject",
  "type": "object",
  "required": [
    "mohEnabled",
    "mohLocationEnabled",
    "greeting"
  ],
  "properties": {
    "mohEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Music on hold enabled or disabled for the workspace."
    },
    "mohLocationEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Music on hold enabled or disabled for the location. The music on hold setting returned in the response is used only when music on hold is enabled at the location level. When `mohLocationEnabled` is false and `mohEnabled` is true, music on hold is disabled for the workspace. When `mohLocationEnabled` is true and `mohEnabled` is false, music on hold is turned off for the workspace. In both cases, music on hold will not be played."
    },
    "greeting": {
      "type": "string",
      "enum": [
        "DEFAULT",
        "CUSTOM"
      ],
      "description": "Greeting type for the workspace.\n * `DEFAULT` - Play music configured at location level.\n * `CUSTOM` - Play previously uploaded custom music when call is placed on hold or parked.\n"
    },
    "audioAnnouncementFile": {
      "$ref": "#/components/schemas/AudioAnnouncementFileGetObject",
      "description": "Announcement Audio File details when greeting is selected to be `CUSTOM`."
    }
  }
}