DescribeTTSConfig-阿里云帮助中心

Query the text-to-speech (TTS) configuration information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

outboundbot:DescribeTTSConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	0ec0c897-b92c-40e4-9ad7-e6e4f5ce13bb
ScriptId	string	Yes	Script ID	d7fbd0a0-27bc-49c4-a456-ecb75e79122b

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code	200
Code	string	API status code	OK
Message	string	API message	Success
RequestId	string	Request ID	f765d3ee-ec03-4765-b235-6877501d99d1
Success	boolean	Indicates whether the operation was successful.	true
TTSConfig	object	TTS configuration
Voice	string	TTS model	xiaoyun
SpeechRate	string	Speech rate	-150
Volume	string	Volume	100
InstanceId	string	Instance ID	947e0875-b5d4-4b33-b18c-7b2cf85bcb4f
NlsServiceType	string	Service type	Managed
AppKey	string	AppKey for invoking TTS	p2SjSj4zxxxxxxxx

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "f765d3ee-ec03-4765-b235-6877501d99d1",
  "Success": true,
  "TTSConfig": {
    "Voice": "xiaoyun",
    "SpeechRate": "-150",
    "Volume": "100",
    "InstanceId": "947e0875-b5d4-4b33-b18c-7b2cf85bcb4f",
    "NlsServiceType": "Managed",
    "AppKey": "p2SjSj4zxxxxxxxx"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.