Webex · Schema

AnnouncementsListResponse

Response containing announcement summary details for list operations.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier of the announcement.
name	string	Name of the announcement.
fileName	string	File name of the uploaded binary announcement greeting.
fileSize	string	Size of the file in kilobytes.
mediaFileType	string	Media file type of the announcement file.
lastUpdated	string	LastUpdated timestamp (in UTC format) of the announcement.
level	string	The level at which this announcement exists.
location	object	The details of location at which this announcement exists.
isTextToSpeech	boolean	Indicates whether the announcement is text-to-speech.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AnnouncementsListResponse",
  "title": "AnnouncementsListResponse",
  "type": "object",
  "description": "Response containing announcement summary details for list operations.",
  "required": [
    "id",
    "name",
    "fileSize",
    "mediaFileType",
    "lastUpdated",
    "level",
    "location"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
      "description": "Unique identifier of the announcement."
    },
    "name": {
      "type": "string",
      "example": "Public_Announcement",
      "description": "Name of the announcement."
    },
    "fileName": {
      "type": "string",
      "example": "Sample_Greetings_file.wav",
      "description": "File name of the uploaded binary announcement greeting."
    },
    "fileSize": {
      "type": "string",
      "example": "356",
      "description": "Size of the file in kilobytes."
    },
    "mediaFileType": {
      "type": "string",
      "example": "WAV",
      "description": "Media file type of the announcement file."
    },
    "lastUpdated": {
      "type": "string",
      "example": "2023-06-13T18:39:53.651Z",
      "description": "LastUpdated timestamp (in UTC format) of the announcement."
    },
    "level": {
      "type": "string",
      "enum": [
        "LOCATION"
      ],
      "description": "The level at which this announcement exists."
    },
    "location": {
      "$ref": "#/components/schemas/LocationObject",
      "description": "The details of location at which this announcement exists."
    },
    "isTextToSpeech": {
      "type": "boolean",
      "example": false,
      "description": "Indicates whether the announcement is text-to-speech."
    }
  }
}