{ "$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`." } } }