DescribeTTSDemo
TTS preview.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
outboundbot:DescribeTTSDemo |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
Instance ID. |
a8eccb3c-2b26-4b6d-a54f-696b953e33a6 |
| ScriptId |
string |
No |
Script ID. |
5ab2d935-306c-478a-88bf-d08e4e25c1b7 |
| Voice |
string |
No |
Voice information, such as aixia, siyue, or xiaoyun. For the complete list of available voices, refer to the voice list below. Note
Because the Voice value of a cloned voice is a unique, non-fixed value generated during voice cloning, the specific Voice value cannot be provided at this stage. You must obtain the specific VoiceID from the voice cloning page by calling the ListVoiceClone API. |
aixia |
| Text |
string |
Yes |
Text content. |
测试 |
| SpeechRate |
integer |
No |
Speech rate. An integer between [-500, 500]. Default value: 0. A value greater than 0 indicates a faster speech rate. A value less than 0 indicates a slower speech rate. |
0 |
| Volume |
integer |
No |
Volume. An integer between [0, 100]. Default value: 50. A value greater than 50 indicates a higher volume. A value less than 50 indicates a lower volume. |
50 |
| PitchRate |
integer |
No |
Pitch. An integer between [-500, 500]. Default value: 0. A value greater than 0 indicates a higher pitch. A value less than 0 indicates a lower pitch. |
0 |
| AppKey |
string |
No |
Voice service type.
|
xusi*******RnP7 |
| SecretKey |
string |
No |
The AccessKey Secret (SK) for this namespace. Note
When the engine is set to xunfei, you must enter the SK. |
OTdhNDE3Z********zQ**** |
| AccessKey |
string |
No |
The AccessKey (AK) for this namespace. Note
When the engine is set to xunfei, you must enter the AK. |
5d0f37**********ef56db601**** |
| Engine |
string |
No |
Storage engine. Valid values: ali, volc, and xunfei.
Valid values:
|
ali |
| NlsServiceType |
string |
No |
Service type. Managed: The default Intelligent Speech Interaction product service of the Outbound Bot product (public service). Authorized: The Intelligent Speech Interaction product service purchased by the public cloud customer (customer's private service), authorized through Script Management > Edit > Call Service > Custom Service. Note
When using Alibaba Cloud Intelligent Speech Interaction, that is, when using Alibaba Cloud as the custom service provider, set this parameter to Authorized. |
Authorized |
| AliCustomizedVoice |
string |
No |
Alibaba Cloud customized voice, which is the voice call ID. |
voice-e1be3a6 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
HTTP status code. |
200 |
| RequestId |
string |
Request ID. |
254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Code |
string |
API status code. |
OK |
| Message |
string |
API response message. |
Success |
| AuditionUrl |
string |
URL of the preview audio file. |
http://XXX/XXX |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Success": true,
"Code": "OK",
"Message": "Success",
"AuditionUrl": "http://XXX/XXX"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.