Query Smart Voice Groups via ListSmartVoiceGroups API - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Retrieves a list of available smart voices, including their names, genders, and sample audio. The voices are grouped by scenario.

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

ice:ListSmartVoiceGroups

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VoiceType	string	No	The voice type. If you do not specify this parameter, the operation returns voices from the small model by default. Set this parameter to `CosyVoice` to retrieve voices from the Cosyvoice large model.	CosyVoice

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	627B30EB-1D0A-5C6D-8467-431626E0FA10
VoiceGroups	array<object>	An array of voice groups.
	array<object>	A voice group.
Type	string	The name of the voice group.	Ultra HD
VoiceList	array<object>	The voice list.
	object	A voice.
Name	string	The name of the voice.	Zhi Tian
VoiceType	string	The voice type. Valid values: Male : A male voice. Female : A female voice. Boy : A boy's voice. Girl : A girl's voice.	Female
Voice	string	The voice ID.	zhitian
Desc	string	The description of the voice.	甜美女声
Tag	string	The tag for the voice category.	General scenario
Remark	string	Notes for the voice.	中文及中英文混合场景
VoiceUrl	string	The URL of the sample audio.	https://***.com/zhitian.mp3
SupportSampleRate	string	The sample rates supported by the voice.	48000
VoiceSource	string

Examples

Success response

JSON format

{
  "RequestId": "627B30EB-1D0A-5C6D-8467-431626E0FA10",
  "VoiceGroups": [
    {
      "Type": "Ultra HD",
      "VoiceList": [
        {
          "Name": "Zhi Tian",
          "VoiceType": "Female",
          "Voice": "zhitian",
          "Desc": "甜美女声",
          "Tag": "General scenario",
          "Remark": "中文及中英文混合场景",
          "VoiceUrl": "https://***.com/zhitian.mp3",
          "SupportSampleRate": "48000",
          "VoiceSource": ""
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.