长文本语音合成结果查询
最近更新时间:2023-08-17 14:53:47 前往 Coding 编辑 导出文档
1. 接口描述
接口请求域名:winner-api.neunit.com:18053
接口请求路径: GET /cloud/tts/v1/describe_tts_task_status
在调用长文本语音合成请求接口后,有回调和轮询两种方式获取合成结果。
- 当采用回调方式时,合成完毕后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL,请求参数为当前接口输出参数中的task_id和result_url。
- 当采用轮询方式时,需要提交任务ID来轮询合成结果,共有任务成功、等待、执行中和失败四种结果,具体信息请参见下文说明。
2. 输入参数
以下请求参数列表仅列出了接口请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
task_id | 是 | String | 任务ID |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
task_id | String | 任务ID |
status | Integer | 任务状态码,0:任务等待,1:任务执行中,2:任务成功,3:任务失败 |
result_url | String | 合成音频URL地址(链接有效期1天) |
error_msg | String | 任务失败原因 |
4. 示例
示例1 轮询结果——任务成功
用户通过轮询方式获取识别结果,任务成功,并返回识别结果。
输入示例
GET / HTTP/1.1
Host: winner-api.neunit.com:18053
path: /cloud/tts/v1/describe_tts_task_status
{
"task_id": "ed461a019355c5cd1ce31ab4dfb8cb12"
}
输出示例
{
"code": 0,
"msg": "OK",
"rid": "ab8a260e-3ffe-598a-bbcb-32324bb760d3",
"data": {
"task_id": "ed461a019355c5cd1ce31ab4dfb8cb12",
"status": 2,
"result_url": "fileurl/voice.wav",
"error_msg": ""
}
}
5. 开发者资源
SDK
云 API 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
10103001 | tts 转译失败,请稍后重试。 |
10103002 | 字符超过限制。 |