> ## Documentation Index > Fetch the complete documentation index at: https://platform.minimaxi.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # 同步语音合成 WebSocket > 使用本接口，在WebSocket网络通信协议下进行同步语音合成。 ## AsyncAPI ````yaml api-reference/speech/t2a/api/asyncapi.json t2a_v2_websocket id: t2a_v2_websocket title: T2a_v2_websocket description: '' servers: - id: production protocol: wss host: api.minimaxi.com bindings: [] variables: [] address: /ws/v1/t2a_v2 parameters: [] bindings: [] operations: - &ref_2 id: sendMessage title: Send message description: '' type: receive messages: - &ref_4 id: send_task_start contentType: application/json payload: - name: 任务开始 description: |- 发送`任务开始`事件则正式开始合成任务，当服务端返回的 `task_started` 事件时，标志着任务已成功开始。 只有在接收到该事件后，才能向服务器发送 `task_continue` 事件或 `task_finish` 事件。 type: object properties: - name: event type: string description: 控制发送的指令，当前环节应填写： `task_start` enumValues: - task_start required: true - name: model type: string description: 请求的模型版本 enumValues: - speech-2.8-hd - speech-2.8-turbo - speech-2.6-hd - speech-2.6-turbo - speech-02-hd - speech-02-turbo - speech-01-hd - speech-01-turbo required: true - name: voice_setting type: object required: true properties: - name: voice_id type: string description: "合成音频的音色编号。若需要设置混合音色，请设置 timbre_weights 参数，本参数设置为空值。支持系统音色、复刻音色以及文生音色三种类型，以下是部分最新的系统音色（ID），可查看 [系统音色列表](/faq/system-voice-id) 或使用 [查询可用音色 API](/api-reference/voice-management-get) 查询系统支持的全部音色\n\n - **中文**:\n\t- moss_audio_ce44fc67-7ce3-11f0-8de5-96e35d26fb85\n\t- moss_audio_aaa1346a-7ce7-11f0-8e61-2e6e3c7ee85d\n\t- Chinese (Mandarin)_Lyrical_Voice\n\t- Chinese (Mandarin)_HK_Flight_Attendant\n- **英文**:\n\t- English_Graceful_Lady\n\t- English_Insightful_Speaker\n\t- English_radiant_girl\n\t- English_Persuasive_Man\n\t- moss_audio_6dc281eb-713c-11f0-a447-9613c873494c\n\t- moss_audio_570551b1-735c-11f0-b236-0adeeecad052\n\t- moss_audio_ad5baf92-735f-11f0-8263-fe5a2fe98ec8\n\t- English_Lucky_Robot\n- **日文**:\n\t- Japanese_Whisper_Belle\n\t- moss_audio_24875c4a-7be4-11f0-9359-4e72c55db738\n\t- moss_audio_7f4ee608-78ea-11f0-bb73-1e2a4cfcd245\n\t- moss_audio_c1a6a3ac-7be6-11f0-8e8e-36b92fbb4f95" required: false - name: speed type: number description: 合成音频的语速，取值越大，语速越快。取值范围 `[0.5,2]`，默认值为1.0 required: false - name: vol type: number description: 合成音频的音量，取值越大，音量越高。取值范围 `(0,10]`，默认值为 1.0 required: false - name: pitch type: integer description: 合成音频的语调，取值范围 `[-12,12]`，默认值为 0，其中 0 为原音色输出 required: false - name: emotion type: string description: "控制合成语音的情绪，参数范围 `[\"happy\", \"sad\", \"angry\", \"fearful\", \"disgusted\", \"surprised\", \"calm\", \"fluent\", \"whisper\"]`，分别对应 8 种情绪：高兴，悲伤，愤怒，害怕，厌恶，惊讶，中性，生动，低语 \r\n- 模型会根据输入文本自动匹配合适的情绪，一般无需手动指定 \r\n- 该参数仅对 `speech-2.8-hd`, `speech-2.8-turbo`, `speech-2.6-hd`, `speech-2.6-turbo`, `speech-02-hd`, `speech-02-turbo`, `speech-01-hd`, `speech-01-turbo` 模型生效 \r\n- 选项 `fluent`, `whisper` 仅对 `speech-2.6-turbo`, `speech-2.6-hd` 模型生效，`speech-2.8-hd`, `speech-2.8-turbo` 模型不支持 `whisper`" enumValues: - happy - sad - angry - fearful - disgusted - surprised - calm - fluent - whisper required: false - name: english_normalization type: boolean description: 该参数支持英语文本规范化，可提升数字阅读场景的性能，但会略微增加延迟，默认值为 `false` required: false - name: latex_read type: boolean description: >- 控制是否朗读 latex 公式，默认为 `false` **需注意**: - 仅支持中文，开启该参数后，`language_boost` 参数会被设置为 `Chinese` - 请求中的公式需要在公式的首尾加上 `$$` - 请求中公式若有 `"\"`，需转义成 `"\\"`. 示例：一元二次方程根的基本公式 ![The quadratic formula](https://filecdn.minimax.chat/public/d6f62e9a-cd3f-4f55-a237-257eef531683.png) 应表示为 `$$x = \\frac{-b \\pm \\sqrt{b^2 - 4ac}}{2a}$$` required: false - name: audio_setting type: object required: false properties: - name: sample_rate type: integer description: >- 生成音频的采样率。可选范围 `[8000，16000，22050，24000，32000，44100]`，默认为 `32000` required: false - name: bitrate type: integer description: >- 生成音频的比特率。可选范围 `[32000，64000，128000，256000]`，默认值为 `128000`。该参数仅对 `mp3` 格式的音频生效 required: false - name: format type: string description: >- 生成音频的格式。`pcmu_raw` 与 `pcmu_wav` 为 G.711 μ-law 编码（采样率 8 kHz；`pcmu_raw` 为无文件头裸数据，`pcmu_wav` 封装在 WAV 容器中）。`opus` 为 Ogg/Opus 编码；流式模式下音频 chunk 需按到达顺序拼接后再解码 enumValues: - mp3 - pcm - flac - wav - pcmu_raw - pcmu_wav - opus required: false - name: channel type: integer description: 生成音频的声道数。可选范围：`[1,2]`，其中 `1` 为单声道，`2` 为双声道，默认值为 1 required: false - name: pronunciation_dict type: object required: false properties: - name: tone type: array description: |- 定义需要特殊标注的文字或符号对应的注音或发音替换规则。在中文文本中，声调用数字表示： 一声为 1，二声为 2，三声为 3，四声为 4，轻声为 5 示例如下： `["燕少飞/(yan4)(shao3)(fei1)", "omg/oh my god"]` required: false - name: timbre_weights type: object required: false properties: - name: voice_id type: string description: >- 合成音频的音色编号，须和weight参数同步填写。支持系统音色、复刻音色以及文生音色三种类型。系统支持的全部音色可查看 [系统音色列表](/faq/system-voice-id)，也可使用 [查询可用音色 API](/api-reference/voice-management-get) 查询系统支持的全部音色 required: false - name: weight type: integer description: >- 合成音频各音色所占的权重，须与 voice_id 同步填写。可选值范围为[1, 100]，最多支持 4 种音色混合，单一音色取值占比越高，合成音色与该音色相似度越高. ```json dark "timbre_weights": [ { "voice_id": "female-chengshu", "weight": 30 }, { "voice_id": "female-tianmei", "weight": 70 } ] ``` required: false - name: language_boost type: string description: >- 是否增强对指定的小语种和方言的识别能力，设置后可以提升在指定小语种/方言场景下的语音表现。默认值为 `null`，如果不明确小语种类型，可设置为 `auto`，模型将自主判断小语种类型 可选值范围： [`Chinese`, `Chinese,Yue`, `English`, `Arabic`, `Russian`, `Spanish`, `French`, `Portuguese`, `German`, `Turkish`, `Dutch`, `Ukrainian`, `Vietnamese`, `Indonesian`, `Japanese`, `Italian`, `Korean`, `Thai`, `Polish`, `Romanian`, `Greek`, `Czech`, `Finnish`, `Hindi`, `Bulgarian`, `Danish`, `Hebrew`, `Malay`, `Persian`, `Slovak`, `Swedish`, `Croatian`, `Filipino`, `Hungarian`, `Norwegian`, `Slovenian`, `Catalan`, `Nynorsk`, `Tamil`, `Afrikaans`, `auto`] 注意：speech-01 和 speech-02 系列模型暂不支持 Persian、Filipino、Tamil 这三个语种。 enumValues: - Chinese - Chinese,Yue - English - Arabic - Russian - Spanish - French - Portuguese - German - Turkish - Dutch - Ukrainian - Vietnamese - Indonesian - Japanese - Italian - Korean - Thai - Polish - Romanian - Greek - Czech - Finnish - Hindi - Bulgarian - Danish - Hebrew - Malay - Persian - Slovak - Swedish - Croatian - Filipino - Hungarian - Norwegian - Slovenian - Catalan - Nynorsk - Tamil - Afrikaans - auto required: false - name: voice_modify type: object description: 声音效果器设置 required: false properties: - name: pitch type: integer description: >- 音高调整（低沉/明亮），范围 [-100,100]，数值接近 -100，声音更低沉；接近 100，声音更明亮 ![pitch adjustment](https://filecdn.minimax.chat/public/5d210c47-4236-4e81-893b-16cc1ef0302d.png) required: false - name: intensity type: integer description: >- 强度调整（力量感/柔和），范围 [-100,100]，数值接近 -100，声音更刚劲；接近 100，声音更轻柔 ![intensity adjustment](https://filecdn.minimax.chat/public/862d493e-71d5-4d1f-b7c3-9ac51890631b.png) required: false - name: timbre type: integer description: >- 音色调整（磁性/清脆），范围 [-100,100]，数值接近 -100，声音更浑厚；数值接近 100，声音更清脆 ![timbre adjustment](https://filecdn.minimax.chat/public/5f0e6cae-363a-452b-8d42-fbc4ef5a0510.png) required: false - name: sound_effects type: string description: |- 音效设置，单次仅能选择一种，可选值： 1. spacious_echo（空旷回音） 2. auditorium_echo（礼堂广播） 3. lofi_telephone（电话失真） 4. robotic（电音） enumValues: - spacious_echo - auditorium_echo - lofi_telephone - robotic required: false headers: [] jsonPayloadSchema: type: object required: - event - model - voice_setting properties: event: type: string enum: - task_start default: - task_start description: 控制发送的指令，当前环节应填写： `task_start` x-parser-schema-id: model: type: string description: 请求的模型版本 enum: - speech-2.8-hd - speech-2.8-turbo - speech-2.6-hd - speech-2.6-turbo - speech-02-hd - speech-02-turbo - speech-01-hd - speech-01-turbo x-parser-schema-id: voice_setting: type: object required: - voice_id properties: voice_id: type: string description: "合成音频的音色编号。若需要设置混合音色，请设置 timbre_weights 参数，本参数设置为空值。支持系统音色、复刻音色以及文生音色三种类型，以下是部分最新的系统音色（ID），可查看 [系统音色列表](/faq/system-voice-id) 或使用 [查询可用音色 API](/api-reference/voice-management-get) 查询系统支持的全部音色\n\n - **中文**:\n\t- moss_audio_ce44fc67-7ce3-11f0-8de5-96e35d26fb85\n\t- moss_audio_aaa1346a-7ce7-11f0-8e61-2e6e3c7ee85d\n\t- Chinese (Mandarin)_Lyrical_Voice\n\t- Chinese (Mandarin)_HK_Flight_Attendant\n- **英文**:\n\t- English_Graceful_Lady\n\t- English_Insightful_Speaker\n\t- English_radiant_girl\n\t- English_Persuasive_Man\n\t- moss_audio_6dc281eb-713c-11f0-a447-9613c873494c\n\t- moss_audio_570551b1-735c-11f0-b236-0adeeecad052\n\t- moss_audio_ad5baf92-735f-11f0-8263-fe5a2fe98ec8\n\t- English_Lucky_Robot\n- **日文**:\n\t- Japanese_Whisper_Belle\n\t- moss_audio_24875c4a-7be4-11f0-9359-4e72c55db738\n\t- moss_audio_7f4ee608-78ea-11f0-bb73-1e2a4cfcd245\n\t- moss_audio_c1a6a3ac-7be6-11f0-8e8e-36b92fbb4f95" x-parser-schema-id: speed: type: number format: float description: 合成音频的语速，取值越大，语速越快。取值范围 `[0.5,2]`，默认值为1.0 minimum: 0.5 maximum: 2 default: 1 x-parser-schema-id: vol: type: number format: float description: 合成音频的音量，取值越大，音量越高。取值范围 `(0,10]`，默认值为 1.0 exclusiveMinimum: 0 maximum: 10 default: 1 x-parser-schema-id: pitch: type: integer description: 合成音频的语调，取值范围 `[-12,12]`，默认值为 0，其中 0 为原音色输出 minimum: -12 maximum: 12 default: 0 x-parser-schema-id: emotion: type: string description: "控制合成语音的情绪，参数范围 `[\"happy\", \"sad\", \"angry\", \"fearful\", \"disgusted\", \"surprised\", \"calm\", \"fluent\", \"whisper\"]`，分别对应 8 种情绪：高兴，悲伤，愤怒，害怕，厌恶，惊讶，中性，生动，低语 \r\n- 模型会根据输入文本自动匹配合适的情绪，一般无需手动指定 \r\n- 该参数仅对 `speech-2.8-hd`, `speech-2.8-turbo`, `speech-2.6-hd`, `speech-2.6-turbo`, `speech-02-hd`, `speech-02-turbo`, `speech-01-hd`, `speech-01-turbo` 模型生效 \r\n- 选项 `fluent`, `whisper` 仅对 `speech-2.6-turbo`, `speech-2.6-hd` 模型生效，`speech-2.8-hd`, `speech-2.8-turbo` 模型不支持 `whisper`" enum: - happy - sad - angry - fearful - disgusted - surprised - calm - fluent - whisper x-parser-schema-id: english_normalization: type: boolean description: 该参数支持英语文本规范化，可提升数字阅读场景的性能，但会略微增加延迟，默认值为 `false` default: false x-parser-schema-id: latex_read: type: boolean description: >- 控制是否朗读 latex 公式，默认为 `false` **需注意**: - 仅支持中文，开启该参数后，`language_boost` 参数会被设置为 `Chinese` - 请求中的公式需要在公式的首尾加上 `$$` - 请求中公式若有 `"\"`，需转义成 `"\\"`. 示例：一元二次方程根的基本公式 ![The quadratic formula](https://filecdn.minimax.chat/public/d6f62e9a-cd3f-4f55-a237-257eef531683.png) 应表示为 `$$x = \\frac{-b \\pm \\sqrt{b^2 - 4ac}}{2a}$$` default: false x-parser-schema-id: x-parser-schema-id: VoiceSetting audio_setting: type: object properties: sample_rate: type: integer format: int64 description: >- 生成音频的采样率。可选范围 `[8000，16000，22050，24000，32000，44100]`，默认为 `32000` x-parser-schema-id: bitrate: type: integer format: int64 description: >- 生成音频的比特率。可选范围 `[32000，64000，128000，256000]`，默认值为 `128000`。该参数仅对 `mp3` 格式的音频生效 x-parser-schema-id: format: type: string description: >- 生成音频的格式。`pcmu_raw` 与 `pcmu_wav` 为 G.711 μ-law 编码（采样率 8 kHz；`pcmu_raw` 为无文件头裸数据，`pcmu_wav` 封装在 WAV 容器中）。`opus` 为 Ogg/Opus 编码；流式模式下音频 chunk 需按到达顺序拼接后再解码 enum: - mp3 - pcm - flac - wav - pcmu_raw - pcmu_wav - opus default: mp3 x-parser-schema-id: channel: type: integer format: int64 description: 生成音频的声道数。可选范围：`[1,2]`，其中 `1` 为单声道，`2` 为双声道，默认值为 1 x-parser-schema-id: x-parser-schema-id: AudioSetting pronunciation_dict: type: object properties: tone: type: array items: type: string x-parser-schema-id: description: |- 定义需要特殊标注的文字或符号对应的注音或发音替换规则。在中文文本中，声调用数字表示： 一声为 1，二声为 2，三声为 3，四声为 4，轻声为 5 示例如下： `["燕少飞/(yan4)(shao3)(fei1)", "omg/oh my god"]` x-parser-schema-id: x-parser-schema-id: PronunciationDict timbre_weights: type: object properties: voice_id: type: string description: >- 合成音频的音色编号，须和weight参数同步填写。支持系统音色、复刻音色以及文生音色三种类型。系统支持的全部音色可查看 [系统音色列表](/faq/system-voice-id)，也可使用 [查询可用音色 API](/api-reference/voice-management-get) 查询系统支持的全部音色 x-parser-schema-id: weight: type: integer format: int64 description: >- 合成音频各音色所占的权重，须与 voice_id 同步填写。可选值范围为[1, 100]，最多支持 4 种音色混合，单一音色取值占比越高，合成音色与该音色相似度越高. ```json dark "timbre_weights": [ { "voice_id": "female-chengshu", "weight": 30 }, { "voice_id": "female-tianmei", "weight": 70 } ] ``` minimum: 1 maximum: 100 x-parser-schema-id: x-parser-schema-id: TimbreWeights language_boost: type: string description: >- 是否增强对指定的小语种和方言的识别能力，设置后可以提升在指定小语种/方言场景下的语音表现。默认值为 `null`，如果不明确小语种类型，可设置为 `auto`，模型将自主判断小语种类型 可选值范围： [`Chinese`, `Chinese,Yue`, `English`, `Arabic`, `Russian`, `Spanish`, `French`, `Portuguese`, `German`, `Turkish`, `Dutch`, `Ukrainian`, `Vietnamese`, `Indonesian`, `Japanese`, `Italian`, `Korean`, `Thai`, `Polish`, `Romanian`, `Greek`, `Czech`, `Finnish`, `Hindi`, `Bulgarian`, `Danish`, `Hebrew`, `Malay`, `Persian`, `Slovak`, `Swedish`, `Croatian`, `Filipino`, `Hungarian`, `Norwegian`, `Slovenian`, `Catalan`, `Nynorsk`, `Tamil`, `Afrikaans`, `auto`] 注意：speech-01 和 speech-02 系列模型暂不支持 Persian、Filipino、Tamil 这三个语种。 enum: - Chinese - Chinese,Yue - English - Arabic - Russian - Spanish - French - Portuguese - German - Turkish - Dutch - Ukrainian - Vietnamese - Indonesian - Japanese - Italian - Korean - Thai - Polish - Romanian - Greek - Czech - Finnish - Hindi - Bulgarian - Danish - Hebrew - Malay - Persian - Slovak - Swedish - Croatian - Filipino - Hungarian - Norwegian - Slovenian - Catalan - Nynorsk - Tamil - Afrikaans - auto x-parser-schema-id: voice_modify: type: object description: 声音效果器设置 properties: pitch: type: integer description: >- 音高调整（低沉/明亮），范围 [-100,100]，数值接近 -100，声音更低沉；接近 100，声音更明亮 ![pitch adjustment](https://filecdn.minimax.chat/public/5d210c47-4236-4e81-893b-16cc1ef0302d.png) minimum: -100 maximum: 100 x-parser-schema-id: intensity: type: integer description: >- 强度调整（力量感/柔和），范围 [-100,100]，数值接近 -100，声音更刚劲；接近 100，声音更轻柔 ![intensity adjustment](https://filecdn.minimax.chat/public/862d493e-71d5-4d1f-b7c3-9ac51890631b.png) minimum: -100 maximum: 100 x-parser-schema-id: timbre: type: integer description: >- 音色调整（磁性/清脆），范围 [-100,100]，数值接近 -100，声音更浑厚；数值接近 100，声音更清脆 ![timbre adjustment](https://filecdn.minimax.chat/public/5f0e6cae-363a-452b-8d42-fbc4ef5a0510.png) minimum: -100 maximum: 100 x-parser-schema-id: sound_effects: type: string description: |- 音效设置，单次仅能选择一种，可选值： 1. spacious_echo（空旷回音） 2. auditorium_echo（礼堂广播） 3. lofi_telephone（电话失真） 4. robotic（电音） enum: - spacious_echo - auditorium_echo - lofi_telephone - robotic x-parser-schema-id: x-parser-schema-id: VoiceModify x-parser-schema-id: SendTaskStartEvent title: 任务开始 description: |- 发送`任务开始`事件则正式开始合成任务，当服务端返回的 `task_started` 事件时，标志着任务已成功开始。 只有在接收到该事件后，才能向服务器发送 `task_continue` 事件或 `task_finish` 事件。 example: |- { "event": "task_start", "model": "speech-2.8-turbo", "language_boost": "Chinese", "voice_setting": { "voice_id": "male-qn-qingse", "speed": 1, "vol": 1, "pitch": 0 }, "pronunciation_dict": { "tone": [ "处理/(chu3)(li3)", "危险/dangerous" ] }, "audio_setting": { "sample_rate": 32000, "bitrate": 128000, "format": "mp3", "channel": 1 } } bindings: [] extensions: - id: x-parser-unique-object-id value: send_task_start - &ref_5 id: send_task_continue contentType: application/json payload: - name: 任务继续 description: >- 当收到服务端返回的 `task_started` 事件后，任务正式开始，可通过发送 `task_continue` 事件发送要合成的文本，支持顺序发送多个 `task_continue` 事件。 当最后一次收到服务端返回结果后超过 120s 没有发送新事件时，webSocket 连接自动断开。 type: object properties: - name: event type: string description: 表示会话事件类型，当前环节应填写 `task_continue` enumValues: - task_continue required: true - name: text type: string description: >- 需要合成语音的文本，长度限制小于 10,000 字符 - 段落切换用换行符标记 - 停顿控制：支持自定义文本之间的语音时间间隔。使用方式：在文本中增加 `<#x#>` 标记，`x` 为停顿时长（单位：秒），范围 **[0.01, 99.99]**，最多保留两位小数。文本间隔时间需设置在两个可以语音发音的文本之间，不可连续使用多个停顿标记 - 语气词标签：仅当模型选择 `speech-2.8-hd` 或 `speech-2.8-turbo` 时，支持在文本中插入语气词标签。支持的语气词：`(laughs)`（笑声）、`(chuckle)`（轻笑）、`(coughs)`（咳嗽）、`(clear-throat)`（清嗓子）、`(groans)`（呻吟）、`(breath)`（正常换气）、`(pant)`（喘气）、`(inhale)`（吸气）、`(exhale)`（呼气）、`(gasps)`（倒吸气）、`(sniffs)`（吸鼻子）、`(sighs)`（叹气）、`(snorts)`（喷鼻息）、`(burps)`（打嗝）、`(lip-smacking)`（咂嘴）、`(humming)`（哼唱）、`(hissing)`（嘶嘶声）、`(emm)`（嗯）、`(sneezes)`（喷嚏） required: true headers: [] jsonPayloadSchema: type: object required: - event - text properties: event: type: string description: 表示会话事件类型，当前环节应填写 `task_continue` enum: - task_continue default: - task_continue x-parser-schema-id: text: type: string description: >- 需要合成语音的文本，长度限制小于 10,000 字符 - 段落切换用换行符标记 - 停顿控制：支持自定义文本之间的语音时间间隔。使用方式：在文本中增加 `<#x#>` 标记，`x` 为停顿时长（单位：秒），范围 **[0.01, 99.99]**，最多保留两位小数。文本间隔时间需设置在两个可以语音发音的文本之间，不可连续使用多个停顿标记 - 语气词标签：仅当模型选择 `speech-2.8-hd` 或 `speech-2.8-turbo` 时，支持在文本中插入语气词标签。支持的语气词：`(laughs)`（笑声）、`(chuckle)`（轻笑）、`(coughs)`（咳嗽）、`(clear-throat)`（清嗓子）、`(groans)`（呻吟）、`(breath)`（正常换气）、`(pant)`（喘气）、`(inhale)`（吸气）、`(exhale)`（呼气）、`(gasps)`（倒吸气）、`(sniffs)`（吸鼻子）、`(sighs)`（叹气）、`(snorts)`（喷鼻息）、`(burps)`（打嗝）、`(lip-smacking)`（咂嘴）、`(humming)`（哼唱）、`(hissing)`（嘶嘶声）、`(emm)`（嗯）、`(sneezes)`（喷嚏） x-parser-schema-id: x-parser-schema-id: SendTaskContinueEvent title: 任务继续 description: >- 当收到服务端返回的 `task_started` 事件后，任务正式开始，可通过发送 `task_continue` 事件发送要合成的文本，支持顺序发送多个 `task_continue` 事件。 当最后一次收到服务端返回结果后超过 120s 没有发送新事件时，webSocket 连接自动断开。 example: |- { "event": "task_continue", "text": "真正的危险不是计算机开始像人一样思考(sighs)，而是人开始像计算机一样思考。计算机只是可以帮我们处理一些简单事务。" } bindings: [] extensions: - id: x-parser-unique-object-id value: send_task_continue - &ref_6 id: send_task_finish contentType: application/json payload: - name: 任务结束 description: 服务端收到 `task_finish` 事件后，会等待当前队列中所有合成任务完成后，关闭 WebSocket 连接并结束任务。 type: object properties: - name: event type: string description: 表示会话事件类型，当前环节应填写 `task_finish` enumValues: - task_finish required: true headers: [] jsonPayloadSchema: type: object required: - event properties: event: type: string enum: - task_finish default: - task_finish description: 表示会话事件类型，当前环节应填写 `task_finish` x-parser-schema-id: x-parser-schema-id: SendTaskFinishEvent title: 任务结束 description: 服务端收到 `task_finish` 事件后，会等待当前队列中所有合成任务完成后，关闭 WebSocket 连接并结束任务。 example: |- { "event": "task_finish" } bindings: [] extensions: - id: x-parser-unique-object-id value: send_task_finish bindings: [] extensions: &ref_1 - id: x-parser-unique-object-id value: t2a_v2_websocket - &ref_3 id: receiveMessage title: Receive message type: send messages: - &ref_7 id: receive_connected_success contentType: application/json payload: - name: 建连成功 description: 成功建立连接后会返回 `connected_success` 事件 type: object properties: - name: session_id type: string description: 表示整个会话的 id required: false - name: event type: string description: 表示会话事件类型，建连成功后会返回`connected_success` required: false - name: trace_id type: string description: 表示会话中单次请求的 id，用于在咨询/反馈时帮助定位问题 required: false - name: base_resp type: object required: false properties: - name: status_code type: integer description: |- 状态码，`0`代表建连成功. 更多状态码信息请参考 [错误码查询列表](/api-reference/errorcode) required: false - name: status_msg type: string description: 该请求对应的状态码和详情 required: false headers: [] jsonPayloadSchema: type: object properties: session_id: type: string description: 表示整个会话的 id x-parser-schema-id: event: type: string const: connected_success description: 表示会话事件类型，建连成功后会返回`connected_success` x-parser-schema-id: trace_id: type: string description: 表示会话中单次请求的 id，用于在咨询/反馈时帮助定位问题 x-parser-schema-id: base_resp: type: object properties: status_code: type: integer description: |- 状态码，`0`代表建连成功. 更多状态码信息请参考 [错误码查询列表](/api-reference/errorcode) x-parser-schema-id: status_msg: type: string description: 该请求对应的状态码和详情 x-parser-schema-id: x-parser-schema-id: BaseResp x-parser-schema-id: ReceiveConnectedSuccessEvent title: 建连成功 description: 成功建立连接后会返回 `connected_success` 事件 example: |- { "session_id": "xxxx", "event": "connected_success", "trace_id": "0303a2882bf18235ae7a809ae0f3cca7", "base_resp": { "status_code": 0, "status_msg": "success" } } bindings: [] extensions: - id: x-parser-unique-object-id value: receive_connected_success - &ref_8 id: receive_task_started contentType: application/json payload: - name: 任务开始 description: 服务端返回 `task_started` 事件，标志着任务已成功开始 type: object properties: - name: session_id type: string description: 表示整个会话的 id required: false - name: event type: string description: 表示会话事件类型，当前环节成功后会返回 `task_started` required: false - name: trace_id type: string description: 表示会话中单次请求的 id，用于在咨询/反馈时帮助定位问题 required: false - name: base_resp type: object description: 该请求对应的状态码和详情 required: false properties: - name: status_code type: integer description: |- 状态码。 - 0: 表示发送成功 - 2202: 表示非法事件 更多内容可查看 [错误码查询列表](/api-reference/errorcode) 了解详情 required: false - name: status_msg type: string description: 状态详情 required: false headers: [] jsonPayloadSchema: type: object properties: session_id: type: string description: 表示整个会话的 id x-parser-schema-id: event: type: string const: 表示会话事件类型，当前环节成功后会返回 `task_started` x-parser-schema-id: trace_id: type: string description: 表示会话中单次请求的 id，用于在咨询/反馈时帮助定位问题 x-parser-schema-id: base_resp: &ref_0 type: object description: 该请求对应的状态码和详情 properties: status_code: type: integer description: |- 状态码。 - 0: 表示发送成功 - 2202: 表示非法事件 更多内容可查看 [错误码查询列表](/api-reference/errorcode) 了解详情 x-parser-schema-id: status_msg: type: string description: 状态详情 x-parser-schema-id: x-parser-schema-id: TaskStartFinishBaseResp x-parser-schema-id: ReceiveTaskStartedEvent title: 任务开始 description: 服务端返回 `task_started` 事件，标志着任务已成功开始 example: |- { "session_id": "xxxx", "event": "task_started", "trace_id": "0303a2882bf18235ae7a809ae0f3cca7", "base_resp": { "status_code": 0, "status_msg": "success" } } bindings: [] extensions: - id: x-parser-unique-object-id value: receive_task_started - &ref_9 id: receive_task_continued contentType: application/json payload: - name: 任务继续 description: 服务端返回 `task_continued` 事件，标志着任务已成功继续 type: object properties: - name: data type: object description: '`data` 可能返回为 `null`，参考示例代码时，注意进行非空判断' required: false properties: - name: audio type: string description: 合成后的音频片段，采用 `hex` 编码，按照输入定义的格式进行生成（mp3/pcm/flac） required: false - name: trace_id type: string description: 表示会话中单次请求的 id，用于在咨询/反馈时帮助定位问题。 required: false - name: session_id type: string description: 表示整个会话的 id。 required: false - name: event type: string description: 表示会话类型，当前环节成功后会返回 task_continued` required: false - name: is_final type: boolean description: 该请求返回是否完结 required: false - name: extra_info type: object description: 相关额外信息 required: false properties: - name: audio_length type: integer description: 音频时长，精确到毫秒 required: false - name: audio_sample_rate type: integer description: 音频采样率 required: false - name: audio_size type: integer description: 音频文件大小，单位为字节 required: false - name: bitrate type: integer description: 音频比特率 required: false - name: audio_format type: string description: 生成音频文件的格式。取值范围 mp3/pcm/flac required: false - name: audio_channel type: integer description: 生成音频声道数。1：单声道，2：双声道 required: false - name: invisible_character_ratio type: integer description: 非法字符占比。非法字符不超过 10%（包含 10%），音频会正常生成并返回非法字符占比，超过进行报错 required: false - name: usage_characters type: integer description: 计费字符数。本次语音生成的计费字符数 required: false - name: word_count type: integer description: 已发音的字数统计，包含汉字、数字、字母，不包含标点符号 required: false - name: base_resp type: object description: 本次请求的状态码和详情 required: false properties: - name: status_code type: integer description: |- 状态码 - 0: 请求结果正常 - 1000: 未知错误 - 1001: 请求超时 - 1002: 触发限流 - 1004: 鉴权失败 - 1039: 触发 TPM 限流 - 1042: 非法字符超过 10% - 2013: 输入参数信息不正常 - 2201: 超时断开连接 - 2202: 非法事件 - 2203: 空文本，跳过 - 2204: 超出字符限制，跳过 - 2205: 请求超限 更多内容可查看 [错误码查询列表](/api-reference/errorcode) 了解详情 required: false - name: status_msg type: string description: 状态详情 required: false headers: [] jsonPayloadSchema: type: object properties: data: type: object description: '`data` 可能返回为 `null`，参考示例代码时，注意进行非空判断' properties: audio: type: string description: 合成后的音频片段，采用 `hex` 编码，按照输入定义的格式进行生成（mp3/pcm/flac） x-parser-schema-id: x-parser-schema-id: trace_id: type: string description: 表示会话中单次请求的 id，用于在咨询/反馈时帮助定位问题。 x-parser-schema-id: session_id: type: string description: 表示整个会话的 id。 x-parser-schema-id: event: type: string description: 表示会话类型，当前环节成功后会返回 task_continued` x-parser-schema-id: is_final: type: boolean description: 该请求返回是否完结 x-parser-schema-id: extra_info: type: object description: 相关额外信息 properties: audio_length: type: integer format: int64 description: 音频时长，精确到毫秒 x-parser-schema-id: audio_sample_rate: type: integer format: int64 description: 音频采样率 x-parser-schema-id: audio_size: type: integer format: int64 description: 音频文件大小，单位为字节 x-parser-schema-id: bitrate: type: integer format: int64 description: 音频比特率 x-parser-schema-id: audio_format: type: string description: 生成音频文件的格式。取值范围 mp3/pcm/flac x-parser-schema-id: audio_channel: type: integer format: int64 description: 生成音频声道数。1：单声道，2：双声道 x-parser-schema-id: invisible_character_ratio: type: integer format: float description: 非法字符占比。非法字符不超过 10%（包含 10%），音频会正常生成并返回非法字符占比，超过进行报错 x-parser-schema-id: usage_characters: type: integer format: int64 description: 计费字符数。本次语音生成的计费字符数 x-parser-schema-id: word_count: type: integer format: int64 description: 已发音的字数统计，包含汉字、数字、字母，不包含标点符号 x-parser-schema-id: x-parser-schema-id: ExtraInfo base_resp: type: object description: 本次请求的状态码和详情 properties: status_code: type: integer description: |- 状态码 - 0: 请求结果正常 - 1000: 未知错误 - 1001: 请求超时 - 1002: 触发限流 - 1004: 鉴权失败 - 1039: 触发 TPM 限流 - 1042: 非法字符超过 10% - 2013: 输入参数信息不正常 - 2201: 超时断开连接 - 2202: 非法事件 - 2203: 空文本，跳过 - 2204: 超出字符限制，跳过 - 2205: 请求超限 更多内容可查看 [错误码查询列表](/api-reference/errorcode) 了解详情 x-parser-schema-id: status_msg: type: string description: 状态详情 x-parser-schema-id: x-parser-schema-id: TaskContinueBaseResp x-parser-schema-id: ReceiveTaskContinuedEvent title: 任务继续 description: 服务端返回 `task_continued` 事件，标志着任务已成功继续 example: |- { "data": { "audio": "xxx" }, "extra_info": { "audio_channel": 1, "audio_format": "mp3", "audio_length": 9914, "audio_sample_rate": 32000, "audio_size": 157869, "bitrate": 128000, "invisible_character_ratio": 0, "usage_characters": 158, "word_count": 158 }, "is_final": true, "session_id": "301871346491491", "trace_id": "04ee3794e2c9e4a6d5f99e77742f06fd", "base_resp": { "status_code": 0, "status_msg": "success" } } bindings: [] extensions: - id: x-parser-unique-object-id value: receive_task_continued - &ref_10 id: receive_task_finished contentType: application/json payload: - name: 任务结束 description: 服务端返回 `task_finished` 事件，标志着任务已成功结束 type: object properties: - name: trace_id type: string description: 表示会话中单次请求的 id，用于在咨询/反馈时帮助定位问题 required: false - name: session_id type: string description: 表示整个会话的 id required: false - name: event type: string description: 表示会话类型，当前环节成功后会返回 `task_finished` required: false - name: base_resp type: object description: 该请求对应的状态码和详情 required: false properties: - name: status_code type: integer description: |- 状态码。 - 0: 表示发送成功 - 2202: 表示非法事件 更多内容可查看 [错误码查询列表](/api-reference/errorcode) 了解详情 required: false - name: status_msg type: string description: 状态详情 required: false headers: [] jsonPayloadSchema: type: object properties: trace_id: type: string description: 表示会话中单次请求的 id，用于在咨询/反馈时帮助定位问题 x-parser-schema-id: session_id: type: string description: 表示整个会话的 id x-parser-schema-id: event: type: string description: 表示会话类型，当前环节成功后会返回 `task_finished` x-parser-schema-id: base_resp: *ref_0 x-parser-schema-id: ReceiveTaskFinishedEvent title: 任务结束 description: 服务端返回 `task_finished` 事件，标志着任务已成功结束 example: |- { "session_id": "xxxx", "event": "task_finished", "trace_id": "0303a2882bf18235ae7a809ae0f3cca7", "base_resp": { "status_code": 0, "status_msg": "success" } } bindings: [] extensions: - id: x-parser-unique-object-id value: receive_task_finished - &ref_11 id: receive_task_failed contentType: application/json payload: - name: 任务失败 description: 如果接收到 `task_failed` 事件，表示任务失败。此时需要关闭 WebSocket 连接并处理错误。 type: object properties: - name: trace_id type: string description: 表示会话中单次请求的 id，用于在咨询/反馈时帮助定位问题 required: false - name: session_id type: string description: 表示整个会话的 id required: false - name: event type: string description: 表示会话类型，任务失败会返回 `task_failed` required: false - name: base_resp type: object description: 本次请求的状态码和详情 required: false properties: - name: status_code type: integer description: |- 状态码 - `1000`: 未知错误 - `1001`: 超时 - `1002`: 触发限流 - `1004`: 鉴权失败 - `1039`: 触发 TPM 限流 - `1042`: 非法字符超过 10% - `2013`: 输入参数信息不正常 - `2201`: 超时断开连接 更多内容可查看 [错误码查询列表](/api-reference/errorcode) 了解详情 required: false - name: status_msg type: string description: 状态详情 required: false headers: [] jsonPayloadSchema: type: object properties: trace_id: type: string description: 表示会话中单次请求的 id，用于在咨询/反馈时帮助定位问题 x-parser-schema-id: session_id: type: string description: 表示整个会话的 id x-parser-schema-id: event: type: string description: 表示会话类型，任务失败会返回 `task_failed` x-parser-schema-id: base_resp: type: object description: 本次请求的状态码和详情 properties: status_code: type: integer description: |- 状态码 - `1000`: 未知错误 - `1001`: 超时 - `1002`: 触发限流 - `1004`: 鉴权失败 - `1039`: 触发 TPM 限流 - `1042`: 非法字符超过 10% - `2013`: 输入参数信息不正常 - `2201`: 超时断开连接 更多内容可查看 [错误码查询列表](/api-reference/errorcode) 了解详情 x-parser-schema-id: status_msg: type: string description: 状态详情 x-parser-schema-id: x-parser-schema-id: TaskFailedBaseResp x-parser-schema-id: ReceiveTaskFailedEvent title: 任务失败 description: 如果接收到 `task_failed` 事件，表示任务失败。此时需要关闭 WebSocket 连接并处理错误。 example: |- { "session_id": "xxxx", "event": "task_failed", "trace_id": "0303a2882bf18235ae7a809ae0f3cca7", "base_resp": { "status_code": 1004, "status_msg": "XXXXXXX" } } bindings: [] extensions: - id: x-parser-unique-object-id value: receive_task_failed bindings: [] extensions: *ref_1 sendOperations: - *ref_2 receiveOperations: - *ref_3 sendMessages: - *ref_4 - *ref_5 - *ref_6 receiveMessages: - *ref_7 - *ref_8 - *ref_9 - *ref_10 - *ref_11 extensions: - id: x-parser-unique-object-id value: t2a_v2_websocket securitySchemes: [] ````