Webex · Schema

TtsStatusResponse

Response containing text-to-speech generation status and file references.

CallingCollaborationCommunicationsEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier of the text-to-speech generation request.
voice string The voice ID used to generate the audio prompt.
text string The input text used to generate the audio prompt.
languageCode string The language code used to generate the audio prompt.
status string The status of the text-to-speech generation request.
promptUrl string A URL to download the encrypted audio prompt. Only available when status is `SUCCESS`.
kmsKeyUri string The KMS key URI required to decrypt the prompt downloaded from `promptUrl`. Only available when status is `SUCCESS`.
fileUri string A file URI you can use when configuring an announcement. Only available when status is `SUCCESS`.
errorMessage string A detailed message describing why generation failed. Only present when status is `FAILURE`.
View JSON Schema on GitHub

JSON Schema

webex-ttsstatusresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TtsStatusResponse",
  "title": "TtsStatusResponse",
  "type": "object",
  "description": "Response containing text-to-speech generation status and file references.",
  "example": {
    "fileUri": "cmf://customers/bf01164f-ed87-44d9-bc41-f63f26fb9663/media/tmp/af01164f-ed87-44d9-bc41-f63f26fb8663",
    "id": "Y2lzY29zcGFyazovL3VzL1RFWFRfVE9fU1BFRUNILzMyMDE2NGY0LWU1YTMtNDFmZi1hMzI2LTY3YzA5OGU0MWQxZA",
    "kmsKeyUri": "kms://kms-cisco.wbx2.com/keys/b56642f3-d597-420c-8a55-41aaa8c5b6e7",
    "languageCode": "en_us",
    "promptUrl": "https://wxc-int-media-file.ciscospark.com/b535b87e-0994-4387-ace1-56facfba9b75/tmp/af01164f-ed87-44d9-bc41-f63f26fb8663",
    "status": "SUCCESS",
    "text": "Welcome to our service. Please hold while we connect you.",
    "voice": "ashley"
  },
  "required": [
    "id",
    "status",
    "text",
    "voice",
    "languageCode"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1RFWFRfVE9fU1BFRUNILzMyMDE2NGY0LWU1YTMtNDFmZi1hMzI2LTY3YzA5OGU0MWQxZA",
      "description": "Unique identifier of the text-to-speech generation request."
    },
    "voice": {
      "type": "string",
      "example": "ashley",
      "description": "The voice ID used to generate the audio prompt."
    },
    "text": {
      "type": "string",
      "example": "Welcome to our service. Please hold while we connect you.",
      "description": "The input text used to generate the audio prompt."
    },
    "languageCode": {
      "type": "string",
      "example": "en_us",
      "description": "The language code used to generate the audio prompt."
    },
    "status": {
      "type": "string",
      "enum": [
        "IN_PROGRESS",
        "SUCCESS",
        "FAILURE"
      ],
      "example": "SUCCESS",
      "description": "The status of the text-to-speech generation request."
    },
    "promptUrl": {
      "type": "string",
      "example": "https://wxc-int-media-file.ciscospark.com/b535b87e-0994-4387-ace1-56facfba9b75/tmp/af01164f-ed87-44d9-bc41-f63f26fb8663",
      "description": "A URL to download the encrypted audio prompt. Only available when status is `SUCCESS`."
    },
    "kmsKeyUri": {
      "type": "string",
      "example": "kms://kms-cisco.wbx2.com/keys/b56642f3-d597-420c-8a55-41aaa8c5b6e7",
      "description": "The KMS key URI required to decrypt the prompt downloaded from `promptUrl`. Only available when status is `SUCCESS`."
    },
    "fileUri": {
      "type": "string",
      "example": "cmf://customers/bf01164f-ed87-44d9-bc41-f63f26fb9663/media/tmp/af01164f-ed87-44d9-bc41-f63f26fb8663",
      "description": "A file URI you can use when configuring an announcement. Only available when status is `SUCCESS`."
    },
    "errorMessage": {
      "type": "string",
      "example": "Text exceeds maximum allowed length.",
      "description": "A detailed message describing why generation failed. Only present when status is `FAILURE`."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/webex-ttsstatusresponse"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.