文档中心
数字人 PaaS 服务
服务端 API
语音合成
查询语音合成任务

查询异步语音合成任务

更新时间：2024-07-09 15:25

描述

调用本接口查询异步语音合成任务状态，获取合成语音下载地址。

接口原型

请求方法：POST
中国大陆正式环境请求地址：https://aigc-api.zegotech.cn/?Action=DescribeTtsTask
传输协议：HTTPS
调用频率限制：10 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数，公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
TaskId	String	是	语音合成任务 ID，创建语音合成任务后获取。

请求示例

请求 URL

https://aigc-api.zegotech.cn/?Action=DescribeTtsTask
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0

请求消息体
```
{
    "TaskId": "your_task_id"
}
```

响应参数

参数	类型	描述
Code	Int	错误码。
Message	String	错误描述。
Data	Object	响应对象。
Status	Int	语音合成任务状态： 0：TTS 处理中。 1：TTS 处理成功。 2：TTS 处理失败。
AudioUrl	String	合成语音的 URL，访问有效期 24 小时。
Duration	Int	语音时长，单位：秒。
Deduction	Int	抵扣时长，基于语音时长和抵扣系数所得。具体抵扣系数，请联系 ZEGO 商务人员。

响应示例

{
    "Code": 0,
    "Message": "succeed",
    "Data": {
        "Status": 1,
        "AudioUrl": "XXXXXXXXXXXX",
        "Duration": 10,
        "Deduction": 10
    }
}

返回码

以下仅列出了常见的接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
0	成功。	-
100000004	签名过期。	请重新生成签名。
100000005	签名错误。	请确认生成签名的参数是否正确。
400000001	无效的输入参数，请参考返回 Message 排查。	请根据 Message 提示，调整对应参数的取值。
400000002	数字人 PaaS 服务权限未开通。	请联系 ZEGO 技术支持开通服务权限。
400000005	未找到任务。	请确认设置的 TaskId 是否正确。
400010000	系统错误。	请联系 ZEGO 技术支持处理。