Domain name for API request: trtc.intl.tencentcloudapi.com.
This API is used to perform text to speech.
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: TextToSpeech. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore. |
| Text | Yes | String | Text to be converted to speech. length range: [1, 255]. |
| Voice | Yes | Voice | Audio configuration for text-to-speech. |
| SdkAppId | Yes | Integer | Specifies the SdkAppId of TRTC. |
| AudioFormat | No | AudioFormat | Specifies the output audio format for text-to-speech. |
| Model | No | String | TTS model, current fixed value: flow_01_turbo. |
| Language | No | String | Language to be synthesised (ISO 639-1). supports zh (chinese), en (english), yue (cantonese), ja (japanese), and ko (korean). defaults to auto-identification. |
| PronunciationDict.N | No | Array of PronunciationDict | |
| AlignmentMode | No | Integer |
| Parameter Name | Type | Description |
|---|---|---|
| Audio | String | Base64-Encoded audio data. |
| Alignments | Array of AlignmentItem | |
| TotalDurationMs | Integer | |
| 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. |
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TextToSpeech
<Common request parameters>
{
"Text": "hello",
"Voice": {
"VoiceId": "v-female-R2s4N9qJ"
},
"SdkAppId": 160001234,
"AlignmentMode": 1
}
{
"Response": {
"Alignments": [
{
"TextBegin": 0,
"TextEnd": 2,
"TimeBeginMs": 0,
"TimeEndMs": 760
}
],
"Audio": "base64audio",
"RequestId": "9b9b5959-8d17-46f2-a216-8a0ce219f92f"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameter.Pitch | Invalid tone. |
| InvalidParameter.PronunciationDict | |
| InvalidParameter.SampleRate | Invalid sampling rate. |
| InvalidParameter.Speed | Invalid speed of sound. |
| InvalidParameter.TextLength | Invalid text length. |
| InvalidParameter.VoiceId | Invalid VoiceId. |
| InvalidParameter.Volume | Invalid volume. |
| MissingParameter.APIKey | Invalid api key. |
| UnsupportedOperation.InternalError | Unsupported operation. |
| UnsupportedOperation.NotAllowed | Not allowed to use. contact technical personnel. |
피드백