Webex · Schema

AudioAnnouncementFileObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the [announcement](/docs/api/v1/features-announcement-repository). `name`, `mediaFileType`, `level` are mandatory if `id` is not provided for uploading an announcement. If all
fileName string Audio announcement file name.
mediaFileType string Audio announcement file type. * `WAV` - WAV File Extension.
level string Audio announcement file type location. * `ORGANIZATION` - Specifies this audio file is configured across the organization. * `LOCATION` - Specifies this audio file is configured across the location.
View JSON Schema on GitHub

JSON Schema

webex-audioannouncementfileobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AudioAnnouncementFileObject",
  "title": "AudioAnnouncementFileObject",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw",
      "description": "A unique identifier for the [announcement](/docs/api/v1/features-announcement-repository). `name`, `mediaFileType`, `level` are mandatory if `id` is not provided for uploading an announcement. If all four fields are provided, file with given `id` is used and other fields are ignored."
    },
    "fileName": {
      "type": "string",
      "example": "AUDIO_FILE.wav",
      "description": "Audio announcement file name."
    },
    "mediaFileType": {
      "type": "string",
      "enum": [
        "WAV"
      ],
      "description": "Audio announcement file type.\n * `WAV` - WAV File Extension.\n"
    },
    "level": {
      "type": "string",
      "enum": [
        "ORGANIZATION",
        "LOCATION"
      ],
      "description": "Audio announcement file type location.\n * `ORGANIZATION` - Specifies this audio file is configured across the organization.\n * `LOCATION` - Specifies this audio file is configured across the location.\n"
    }
  }
}