Webex · Schema

AnnouncementRequestBody

Request payload for uploading or updating an announcement in the repository.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
name string Name of the announcement.
fileUri string URI of the announcement file.
fileName string File name of the announcement.
isTextToSpeech boolean Indicates whether the announcement is text-to-speech.
View JSON Schema on GitHub

JSON Schema

webex-announcementrequestbody-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AnnouncementRequestBody",
  "title": "AnnouncementRequestBody",
  "type": "object",
  "description": "Request payload for uploading or updating an announcement in the repository.",
  "required": [
    "name",
    "fileUri",
    "fileName",
    "isTextToSpeech"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256,
      "example": "Public_Announcement",
      "description": "Name of the announcement."
    },
    "fileUri": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256,
      "example": "https://example.com/announcements/greeting.wav",
      "description": "URI of the announcement file."
    },
    "fileName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "example": "greeting.wav",
      "description": "File name of the announcement."
    },
    "isTextToSpeech": {
      "type": "boolean",
      "example": false,
      "description": "Indicates whether the announcement is text-to-speech."
    }
  }
}