用户指南：关于模型介绍和选型建议请参见语音合成。
task-started
当客户端发送 run-task 指令后，服务端返回 task-started 事件，标志任务已成功开启。
header.task_idstring 客户端生成的任务 ID。 header.eventstring 事件类型，固定为 task-started。 payloadobject 无内容，为空对象。 | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "task-started",
"attributes": {}
},
"payload": {}
}
|
result-generated
客户端发送文本后，服务端持续返回 result-generated 事件。该事件在 output.sentence 中直接返回完整的时间戳信息，包括字级别和音素级别时间戳（需启用相应参数）。
header.task_idstring 客户端生成的任务 ID。 header.eventstring 事件类型，固定为 result-generated。 payload.outputobject 输出信息。 属性 sentence.begin_timeinteger 句子开始时间戳，单位：毫秒。 sentence.end_timeinteger 句子结束时间戳，单位：毫秒。 sentence.wordsarray 字级别时间戳信息数组。 words 元素属性 textstring 字的文本内容。 begin_timeinteger 字对应音频的开始时间戳，单位：毫秒。 end_timeinteger 字对应音频的结束时间戳，单位：毫秒。 phonemesarray（需启用 phoneme_timestamp_enabled） 音素级别时间戳信息数组。 phonemes 元素属性 textstring 音素文本。 toneinteger 音调。 begin_timeinteger 音素开始时间戳，单位：毫秒。 end_timeinteger 音素结束时间戳，单位：毫秒。 payload.usageobject 计费信息。 属性 charactersinteger 截止当前累计的计费字符数。 | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "result-generated",
"attributes": {}
},
"payload": {
"output": {
"sentence": {
"begin_time": 0,
"end_time": 1162,
"words": [
{
"text": "床",
"begin_time": 0,
"end_time": 263,
"phonemes": [
{
"begin_time": 0,
"end_time": 119,
"text": "ch_c",
"tone": 2
}
]
}
]
}
},
"usage": {
"characters": 6
}
}
}
|
task-finished
服务端返回 task-finished 事件，标志任务已结束。客户端可以关闭 WebSocket 连接或复用连接开启新任务。
header.task_idstring 客户端生成的任务 ID。 header.eventstring 事件类型，固定为 task-finished。 payload.usage.charactersinteger 截止当前累计的计费字符数。 | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "task-finished",
"attributes": {
"request_uuid": "0a9dba9e-d3a6-45a4-be6d-xxxxxxxxxxxx"
}
},
"payload": {
"usage": {
"characters": 13
}
}
}
|
task-failed
当任务失败时，服务端返回 task-failed 事件。客户端需要关闭 WebSocket 连接并处理错误。
header.task_idstring 客户端生成的任务 ID。 header.eventstring 事件类型，固定为 task-failed。 header.error_codestring 错误码。 header.error_messagestring 具体错误信息。 | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "task-failed",
"error_code": "InvalidParameter",
"error_message": "[tts:]Engine return error code: 418",
"attributes": {}
},
"payload": {}
}
|
