DescribeVoices

Last updated: 2026-05-11 20:08:18Download PDF

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

This synchronous API is used to query available voices. It supports filtering voices by type, tag, language, and other criteria.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
VoiceType	No	String	Voice type. Enumeration value: system: System audio.
ExtParam	No	String	Extended parameters in the format of a JSON string. Other filter criteria: voiceName (String): Voice name, fuzzy matching. labels (Array of String): Tags. Matches voices that contain these tags.

3. Output Parameters

Parameter Name	Type	Description
ErrorCode	Integer	Error code. 0 is returned if the request is successful.
Msg	String	Error message. success is returned if the request is successful.
Voices	Array of VoiceInfo	Available voice list. Note: This field may return null, indicating that no valid values can be obtained.
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.

4. Example

Example1 Querying All Available Voices

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVoices
<Common request parameters>

{}

Output Example

{
    "Response": {
        "ErrorCode": 0,
        "Msg": "success",
        "Voices": [
            {
                "AudioUrl": "https://ie-mps-1258344699.cos.ap-nanjing.myqcloud.com/common/lauriehuang/dubbing/voice/samples/s1_ffgIs_z6m.wav",
                "Category": "system",
                "Description": "A steady and reliable middle-aged male executive voice, in standard Mandarin, conveying a sense of trustworthiness.",
                "Gender": "male",
                "Labels": [
                    "Steady"
                ],
                "Languages": [
                    "zh"
                ],
                "Name": "Steady Executive",
                "Scenes": [
                    "General"
                ],
                "VoiceId": "s1_ffgIs/z6m/4N0fS1/MSotjeSxrtaVMTXMovoBjRATytSYVzhffFMWxq4pnx36Mq75Sh/v6d5smsJaA7z8w=="
            }
        ],
        "RequestId": "885d40d0-328a-429c-8394-527111536784"
    }
}

Example2 Querying Voices by Tag

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVoices
<Common request parameters>

{
    "VoiceType": "system",
    "ExtParam": "{\n    \"labels\": [\"gentle\"]\n}"
}

Output Example

{
    "Response": {
        "ErrorCode": 0,
        "Msg": "success",
        "Voices": [
            {
                "AudioUrl": "https://ie-mps-1258344699.cos.ap-nanjing.myqcloud.com/common/lauriehuang/dubbing/voice/samples/s1_wXuUdY32P.wav",
                "Category": "system",
                "Description": "A gentle and kind middle-aged woman's voice, in standard Mandarin, warm and caring.",
                "Gender": "female",
                "Labels": [
                    "gentle"
                ],
                "Languages": [
                    "zh"
                ],
                "Name": "Kind Auntie",
                "Scenes": [
                    "General"
                ],
                "VoiceId": "s1_wXuUdY32PfFMzV4mcz9qoIK9c4lKMWCzs+bdPaQ4//v+GnH0M9P4lXtue27Z3tCMtNOCYSnffKMmj3Y1gQ=="
            }
        ],
        "RequestId": "1941cce3-628c-4201-93ec-5463750181ff"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.