Webex · Schema

PutMusicOnHoldObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
mohEnabled boolean Music on hold is enabled or disabled for the workspace.
greeting string Greeting type for the workspace. * `DEFAULT` - Play music configured at location level. * `CUSTOM` - Play custom music when call is placed on hold or parked. An audio file must already have been succe
audioAnnouncementFile object Announcement Audio File details when greeting is selected to be `CUSTOM`.
View JSON Schema on GitHub

JSON Schema

webex-putmusiconholdobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutMusicOnHoldObject",
  "title": "PutMusicOnHoldObject",
  "type": "object",
  "properties": {
    "mohEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Music on hold is enabled or disabled for the workspace."
    },
    "greeting": {
      "type": "string",
      "enum": [
        "DEFAULT",
        "CUSTOM"
      ],
      "description": "Greeting type for the workspace.\n * `DEFAULT` - Play music configured at location level.\n * `CUSTOM` - Play custom music when call is placed on hold or parked. An audio file must already have been successfully uploaded to specify this option.\n"
    },
    "audioAnnouncementFile": {
      "$ref": "#/components/schemas/AudioAnnouncementFileObject",
      "description": "Announcement Audio File details when greeting is selected to be `CUSTOM`."
    }
  }
}