ListScriptVoiceConfigs-阿里云帮助中心

Lists the audio in a legacy canvas scene.

Operation description

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:ListScriptVoiceConfigs

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	af81a389-91f0-4157-8d82-720edd02b66a
ScriptId	string	Yes	The ID of the script.	f95c7ca6-872c-4765-8493-165a8dfc682d
PageNumber	integer	Yes	The page number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	20

Response elements

Element	Type	Description	Example
	object	The returned data.
HttpStatusCode	integer	The HTTP status code.	200
Code	string	The API status code.	OK
Message	string	The returned message.	Success
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request succeeded.	true
ScriptVoiceConfigs	object	The paginated list of script voice configurations.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	100
List	array<object>	An array of script voice configuration objects.
	object	The details of a script voice configuration.
Type	string	The voice type.	TTS
ScriptVoiceConfigId	string	The ID of the voice configuration.	2c8fa91f-9856-4145-90f2-08252f09bc18
ScriptContent	string	The text content of the script.	请问你是 @name 吗
InstanceId	string	The instance ID.	bdd49242-114c-4045-b1d1-25ccc1756c75
ScriptId	string	The script ID.	a7441a05-43bb-4a2d-acb0-365f245d7a5b
ScriptWaveformRelation	string	The relationship between the script and the audio file.	""
Source	string	The source of the script.	DIALOGUE_FLOW

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "ScriptVoiceConfigs": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "List": [
      {
        "Type": "TTS",
        "ScriptVoiceConfigId": "2c8fa91f-9856-4145-90f2-08252f09bc18",
        "ScriptContent": "请问你是 @name 吗",
        "InstanceId": "bdd49242-114c-4045-b1d1-25ccc1756c75",
        "ScriptId": "a7441a05-43bb-4a2d-acb0-365f245d7a5b",
        "ScriptWaveformRelation": "\"\"",
        "Source": "DIALOGUE_FLOW"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404	NotExist.Instance	The specified Instance does not exist.
404	NotExist.Script	The specified Script does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.