云点播查询可用音色

1. 接口描述

接口请求域名： vod.tencentcloudapi.com 。

查询当前账号下可用音色列表，支持按音色 ID、类型、名称、性别、年龄、语言、标签、场景等可选条件过滤。

注意：新设计、克隆的音色未被激活前无法被查询到，需首次使用该新建音色执行一次TTS后才被激活。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeVoices。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
SubAppId	否	String	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：260***028
VoiceId	否	String	音色ID 示例值：v1_aBbiY3aN7tm7ff3S1gBZa****plXzQDwNTiJQp2aYilZGv0=
VoiceType	否	String	音色类别枚举值： system：系统音色 clone：克隆音色 design：设计音色 all：所有音色（默认）示例值：clone
VoiceName	否	String	音色名示例值：音色
Description	否	String	音色描述示例值：音色
Gender	否	String	性别枚举值： male：男 female：女 unknown：未知示例值：male
Age	否	String	年龄枚举值： child：儿童 teenager：少年 youth：青年 middle_aged：中年 senior：老年 unknown：未知示例值：child
Languages.N	否	Array of String	语言示例值：["zh"]
Labels.N	否	Array of String	标签示例值：["磁性"]
Scenes.N	否	Array of String	场景示例值：["解说"]
ExtParam	否	String	扩展参数，json字符串其他筛选条件voiceName String 音色名，模糊匹配labels Array of String 标签，匹配包含这些标签的音色示例值：{ "labels": ["温柔"] }

3. 输出参数

参数名称	类型	描述
Voices	Array of VoiceInfo	可用音色列表
TotalCount	Integer	可用音色总数示例值：2
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询克隆音色

查询克隆音色

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVoices
<公共请求参数>

{
    "SubAppId": "260***028",
    "VoiceType": "clone",
    "VoiceId": "v1_aBbiY3aN7tm7ff3S1gBZa************************plXzQDwNTiJQp2aYilZGv0="
}

输出示例

{
    "Response": {
        "Voices": [
            {
                "Age": "unknown",
                "AudioUrl": "",
                "Category": "clone",
                "Description": "克隆音色",
                "Gender": "male",
                "Labels": [
                    "磁性"
                ],
                "Languages": [
                    "zh"
                ],
                "Name": "克隆音色",
                "Scenes": [
                    "解说"
                ],
                "VoiceId": "v1_aBbiY3aN7tm7ff3S1gBZamsLQyEsQswXoEpreGEStjnx2plXzQDwNTiJQp2aYilZGv0="
            }
        ],
        "RequestId": "3e71a833-176c-418c-a515-c14a43b5f8b8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询可用音色

本页目录：