ListAvailableTts-阿里云帮助中心

Lists the system and custom TTS voices available for large model-based outbound calls.

Operation description

If you have not created and published any custom voices on the Custom Voice page, the operation returns only system voices.

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

aiccs:ListAvailableTts

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TtsVoiceCode	string	No	The voice code for a custom voice. You can find it on the Custom Voice page.	V9A******
VoiceType	string	No	The type of the TTS voice. Valid values: `SYSTEM`: system voice. `COSYCLONE`: cloned voice. `BL-CUSTOM`: premium custom voice.	SYSTEM

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details about the access denial. The system returns this parameter only if a RAM permission check fails.	None
RequestId	string	The request ID generated by Alibaba Cloud. You can use this ID to troubleshoot issues.	5EBAEBE6-0E77-5E1F-99E4-7B20512F22222
Message	string	The description of the status code.	OK
Data	array<object>	A list of available TTS voices.
	object	The details of a TTS voice.
TtsVoiceName	string	The name of the TTS voice.	龙小夏
TtsEngine	string	The voice engine. Valid values: CosyVoice: A custom voice or a system voice. Volcano: A Doubao voice.	CosyVoice
TtsStyle	string	The voice style.	cosyvoice-v2-*******-*****
TtsAuditionFileUrl	string	The URL for the voice audition file.	https://*******/longxiaoxia.mp3
TtsVoiceCode	string	The voice code.	V9A******
VoiceType	string	The type of the TTS voice. Valid values: `SYSTEM`: system voice. `COSYCLONE`: cloned voice. `BL-CUSTOM`: premium custom voice.	COSYCLONE
Code	string	The status code. `OK` indicates that the request was successful.	OK
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "RequestId": "5EBAEBE6-0E77-5E1F-99E4-7B20512F22222",
  "Message": "OK",
  "Data": [
    {
      "TtsVoiceName": "龙小夏",
      "TtsEngine": "CosyVoice",
      "TtsStyle": "cosyvoice-v2-*********-*******",
      "TtsAuditionFileUrl": "https://*******/longxiaoxia.mp3",
      "TtsVoiceCode": "V9A******\n",
      "VoiceType": "COSYCLONE"
    }
  ],
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.