文档中心
数字人 PaaS 服务
服务端 API
查询精品数字人
查询音色列表

查询音色列表

更新时间：2024-07-30 10:28

描述

调用本接口查询数字人形象可用的音色列表。

一个数字人形象可以有多个数字人音色。

接口原型

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

请求参数

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

参数	类型	是否必选	描述
MetaHumanId	String	否	数字人形象 ID，通过查询数字人模特列表获得。（若不填写，将返回全量可用公共音色）

请求示例

请求 URL

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

请求消息体

{
    "MetaHumanId": "your_metahuman_id"
}

响应参数

参数	类型	描述
Code	Int	错误码。
Message	String	错误描述。
Data	Object	响应对象。
Timbres	Array Of Object	音色列表。
TimbreId	String	音色 ID。如需试听音色，请调用创建语音合成任务接口合成语音。
TimbreName	String	音色名称。
AvatarUrl	String	音色头像示意图 URL，访问有效期 24 小时。如果您需要在 App 向用户示意音色的信息，如男女、老少、中外等，可以使用此 URL 下载音色头像示意图。

响应示例

以下是 DescribeTimbreByMetaHuman 接口的响应示例。

{
    "Code": 0,
    "Message": "succeed",
    "Data": {
        "Timbres": [
            {
                "TimbreId": "0b586a13-37d5-42d6-a68e-e094335fca0d",
                "TimbreName": "艾树",
                "AvatarUrl": "https://xxx.xxx.xxx.xxx/xxx.png"
            },
            {
                "TimbreId": "14fac766-56df-4aea-935a-41e6b3abd67c",
                "TimbreName": "数字声音",
                "AvatarUrl": "https://xxx.xxx.xxx.xxx/yyy.jpeg"
            }
        ]
    }
}

返回码

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

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