Query Timbre List

Description

Through this API, you can retrieve the list of available timbres.

Request prototype

Request method: POST
Request body format: JSON
Request URL: https://aigc-digitalhuman-api.zegotech.cn?Action=GetTimbreList
Transmission protocol: HTTPS
QPS limit: 10 times/second

Request Parameters

The following request parameter list only shows the API request parameters and some common parameters. For the complete list of common parameters, please refer to Accessing Server APIs - Common Request Parameters.

Parameter	Type	Required	Description
DigitalHumanId	String	No	Digital human ID. If not filled or empty, it means to query all public timbres. If a valid digital human ID is passed, it means to query private timbres bound to this digital human.
Offset	Number	No	Indicates from which record to start fetching, with a range of [0, 1000000]. If not specified, the default value is 0. If the value is less than 0 or greater than 1000000, the API call will fail.
Limit	Number	No	Number of timbre records to fetch. Range is [1, 20]. If not specified, the default value is 20. If the value is less than 1 or greater than 20, the API call will fail.

Sample request

Request URL:

https://aigc-digitalhuman-api.zegotech.cn?Action=GetTimbreList
&<Common Request Parameters>

https://aigc-digitalhuman-api.zegotech.cn?Action=GetTimbreList
&<Common Request Parameters>

Request body:

{
    "DigitalHumanId": "42f97c28-1124-4cb2-800a-44d028497027",
    "Offset": 0,
    "Limit": 20
}

{
    "DigitalHumanId": "42f97c28-1124-4cb2-800a-44d028497027",
    "Offset": 0,
    "Limit": 20
}

Response parameters

Parameter	Type	Description
Code	Number	Return code. 0 indicates success, other values indicate failure. For error codes and response handling suggestions, please refer to Return Codes.
Message	String	Description of the request result.
RequestId	String	Request ID.
Data	Object	Return data.
└Total	Number	Total number of timbres matching the query criteria.
└Timbres	Array of Object	Timbre list. For details, please refer to Timbre.

Timbre

Parameter	Type	Description
TimbreId	String	Timbre ID.
Name	String	Timbre name.
AvatarUrl	String	Timbre image URL, valid for 24 hours.

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "aa62cf9f-2797-4bd0-9cbf-e461b82d75a5",
    "Data": {
        "Total": 1,
        "Timbres": [
            {
                "TimbreId": "xxx",
                "Name": "xxx",
                "AvatarUrl": "https://xxx.com/xxx.png"
            }
        】
    }
}

{
    "Code": 0,
    "Message": "success",
    "RequestId": "aa62cf9f-2797-4bd0-9cbf-e461b82d75a5",
    "Data": {
        "Total": 1,
        "Timbres": [
            {
                "TimbreId": "xxx",
                "Name": "xxx",
                "AvatarUrl": "https://xxx.com/xxx.png"
            }
        】
    }
}