Domain name for API request: vod.intl.tencentcloudapi.com.
Queries the list of available timbres under the current account, supporting filtering by optional conditions such as voice ID, type, name, gender, age, language, tag, and scenario.
Note: Newly designed or cloned voice types cannot be queried before activation. They are activated only after the new voice type is used for TTS once.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeVoices. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | String | VOD app ID. For customers who activate on-demand services after December 25, 2023, this field must be filled with the app ID when accessing resources in on-demand applications (whether the default application or a newly created application). |
| VoiceId | No | String | Voice ID. |
| VoiceType | No | String | Voice type. Enumeration values:
|
| VoiceName | No | String | Voice name. |
| Description | No | String | Voice description. |
| Gender | No | String | Gender. Enumeration values:
|
| Age | No | String | Age. Enumeration values:
|
| Languages.N | No | Array of String | Language. |
| Labels.N | No | Array of String | Tag. |
| Scenes.N | No | Array of String | Scenario. |
| ExtParam | No | String | Extended parameters in the format of a JSON string. Other filter criteria: |
| Parameter Name | Type | Description |
|---|---|---|
| Voices | Array of VoiceInfo | Available voice list. |
| TotalCount | Integer | Total number of available voices |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Querying a Cloned Voice
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVoices
<Common request parameters>
{
"SubAppId": "260***028",
"VoiceType": "clone",
"VoiceId": "v1_aBbiY3aN7tm7ff3S1gBZa************************plXzQDwNTiJQp2aYilZGv0="
}{
"Response": {
"Voices": [
{
"Age": "unknown",
"AudioUrl": "",
"Category": "clone",
"Description": "Clone voice",
"Gender": "male",
"Labels": [
magnetic
],
"Languages": [
"zh"
],
"Name": "Clone voice type",
"Scenes": [
commentate
],
"VoiceId": "v1_aBbiY3aN7tm7ff3S1gBZamsLQyEsQswXoEpreGEStjnx2plXzQDwNTiJQp2aYilZGv0="
}
],
"RequestId": "3e71a833-176c-418c-a515-c14a43b5f8b8"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
文档反馈