Query Timbre Info
2026-03-20
Description
Through this API, you can obtain available timbre information.
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 includes API request parameters and some common parameters. For the complete list of common parameters, please refer to API Calling Methods - Common Request Parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
| DigitalHumanId | String | No | Digital Human ID. If not specified or empty, all public timbres will be queried. If a valid Digital Human ID is provided, private timbres bound to this Digital Human will be queried. |
| Offset | Number | No | Specifies the starting position for fetching, ranging from [0, 1000000]. If not specified, defaults to 0. If the value is less than 0 or greater than 1000000, the API call will return an error. |
| Limit | Number | No | Number of timbre entries to fetch. Ranges from [1, 20]. If not specified, defaults to 20. If the value is less than 1 or greater than 20, the API call will return an error. |
Request Example
-
Request URL:
https://aigc-digitalhuman-api.zegotech.cn?Action=GetTimbreList &<common-request-parameters> -
Request body:
{ "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 recommendations, please refer to Return Codes. |
| Message | String | Description of the request result. |
| RequestId | String | Request ID. |
| Data | Object | Response data. |
| └Total | Number | Total number of timbres matching the query conditions. |
| └Timbres | Array of Object | Timbre list. For details, refer to Timbre. |
Timbre
| Parameter | Type | Description |
|---|---|---|
| TimbreId | String | Timbre ID. |
| Name | String | Timbre name. |
| AvatarUrl | String | Timbre avatar image URL. The access validity period is 24 hours. |
Response Example
{
"Code": 0,
"Message": "success",
"RequestId": "aa62cf9f-2797-4bd0-9cbf-e461b82d75a5",
"Data": {
"Total": 1,
"Timbres": [
{
"TimbreId": "xxx",
"Name": "xxx",
"AvatarUrl": "https://xxx.com/xxx.png"
}
]
}
}