Webex · Schema

GenerateTtsRequest

Request payload for generating a text-to-speech audio prompt.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
voice	string	The voice ID used to generate the audio prompt. Use the List Text-to-Speech Voices API to retrieve available voices.
text	string	The text to convert to speech.
languageCode	string	The language code used to generate the audio prompt. Use the Read the List of Announcement Languages API to retrieve supported language codes.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GenerateTtsRequest",
  "title": "GenerateTtsRequest",
  "type": "object",
  "description": "Request payload for generating a text-to-speech audio prompt.",
  "required": [
    "voice",
    "text",
    "languageCode"
  ],
  "properties": {
    "voice": {
      "type": "string",
      "example": "ashley",
      "description": "The voice ID used to generate the audio prompt. Use the List Text-to-Speech Voices API to retrieve available voices."
    },
    "text": {
      "type": "string",
      "example": "Welcome to our service. Please hold while we connect you.",
      "description": "The text to convert to speech."
    },
    "languageCode": {
      "type": "string",
      "example": "en_us",
      "description": "The language code used to generate the audio prompt. Use the Read the List of Announcement Languages API to retrieve supported language codes."
    }
  }
}