Webex · Schema

AnnouncementResponseWithPlaylist

Response containing announcement details and available playlists.

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	Last updated timestamp (in UTC format) of the announcement.
featureReferenceCount	number	Reference count of the call features this announcement is assigned to.
featureReferences	array	Call features referenced by this announcement.
playlists	array	List of playlist available for selection.
isTextToSpeech	boolean	Indicates whether the announcement is text-to-speech.
voice	string	Voice used for text-to-speech announcement.
language	string	Language code for the text-to-speech announcement.
text	string	Text content for text-to-speech announcement.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AnnouncementResponseWithPlaylist",
  "title": "AnnouncementResponseWithPlaylist",
  "type": "object",
  "description": "Response containing announcement details and available playlists.",
  "required": [
    "id",
    "name",
    "fileSize",
    "mediaFileType",
    "lastUpdated",
    "featureReferenceCount"
  ],
  "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": "Last updated timestamp (in UTC format) of the announcement."
    },
    "featureReferenceCount": {
      "type": "number",
      "example": 1,
      "description": "Reference count of the call features this announcement is assigned to."
    },
    "featureReferences": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FeatureReferenceObject"
      },
      "description": "Call features referenced by this announcement."
    },
    "playlists": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PlaylistObject"
      },
      "description": "List of playlist available for selection."
    },
    "isTextToSpeech": {
      "type": "boolean",
      "example": false,
      "description": "Indicates whether the announcement is text-to-speech."
    },
    "voice": {
      "type": "string",
      "example": "en-US-Neural2-A",
      "description": "Voice used for text-to-speech announcement."
    },
    "language": {
      "type": "string",
      "example": "en-US",
      "description": "Language code for the text-to-speech announcement."
    },
    "text": {
      "type": "string",
      "example": "Welcome to our service. Please hold while we connect you.",
      "description": "Text content for text-to-speech announcement."
    }
  }
}