Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to update the profile information of a voice type by voice ID, including name, description, gender, age, language, tag, and scenario. It returns the complete voice type information after the update. Only voice types for this account can be updated. System preset voice types do not support update.
Note: Newly designed or cloned voice types cannot be updated 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: UpdateVoice. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| VoiceId | Yes | String | Voice ID. |
| VoiceFields | Yes | VoiceUpdateFields | Fields of the updated voice. |
| 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). |
| ExtParam | No | String | Extended parameters in the format of a JSON string. |
| Parameter Name | Type | Description |
|---|---|---|
| Voice | VoiceInfo | Voice information after the update. |
| 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. |
This API is used to update the voice information.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateVoice
<Common request parameters>
{
"SubAppId": "260***028",
"VoiceId": "v1_aBbiY3aN7tm7ff3S1gBZa************************plXzQDwNTiJQp2aYilZGv0=",
"VoiceFields": {
"Name": "Timbre",
"Description": "Voice type introduction"
"Gender": "male",
"Age": "middle_aged",
"Languages": [
"zh"
],
"Labels": [
"Intellectual"
],
"Scenes": [
General
],
"AudioUrl": "https://laurie-tmp-1300828900.cos.ap-nanjing.myqcloud.com/sync_dubbing/27111c32-93e3-476e-8ab5-e7fb5838f994.wav"
},
"ExtParam": "{\"engine\": \"auto\"}"
}{
"Response": {
"Voice": {
"Age": "middle_aged",
"AudioUrl": "",
"Category": "clone",
"Description": "Voice type description"
"Gender": "male",
"Labels": [
"Intellectual"
],
"Languages": [
"zh"
],
"Name": "Timbre",
"Scenes": [
common
],
"VoiceId": "v1_aBbiY3aN7tm7ff3S1gBZamsLQyEsQswXoEpreGEStjnx2plXzQDwNTiJQp2aYilZGv0="
},
"RequestId": "83593c53-3379-4359-a25b-815bb562bf37"
}
}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.
フィードバック