ListAudioFiles-阿里云帮助中心

Invoke ListAudioFiles to obtain the list of audio files under a specified instance.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID.	ccc-test
PageNumber	integer	Yes	The paging ordinal number, ranging from 1 to 100.	1
PageSize	integer	Yes	Page size, ranging from 1 to 100.	10
Status	string	No	Converting (transforming) Completed (transformation completed) Failed (transformation failed) If this parameter is not specified, resources in all statuses are queried.	Completed
Usage	string	No	Purpose of the audio file. The default value is General (used in scenarios such as IVR). Other optional values include HoldMusic (hold music during calls).	General

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	53223330-EBF1-586B-A2CB-93C3B711FDA0
Code	string	Response code.	OK
Message	string	The response message.	无
Data	object	The data.
PageNumber	integer	The page number, ranging from 1 to 100.	1
PageSize	integer	The paging size, ranging from 1 to 100.	10
TotalCount	integer	The total count.	10
List	array<object>	The list of audio files.
	object	The audio file information.
AudioFileName	string	Audio file name.	test-file.wav
OssFileKey	string	The key of the audio resource file in OSS.	ccc-test/test-file.wav
UpdatedTime	string	Last modified time of the audio resource.	2021-03-08 15:34:49.0
AudioResourceId	string	Audio resource ID, which is the UUID of the audio file.	d5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77
InstanceId	string	Instance ID.	ccc-test
Name	string	Display name of the audio resource.	欢迎语
CreatedTime	string	The creation time of the audio resource.	2021-03-05 17:35:45.0
Status	string	The status of the audio file.	Completed
Usage	string	The usage of the audio file. The default value is General (used in scenarios such as IVR). Other optional values include HoldMusic (hold music during call waiting).	General
AuditResult	string	Audio content threat review result.	无

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "53223330-EBF1-586B-A2CB-93C3B711FDA0",
  "Code": "OK",
  "Message": "无",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "List": [
      {
        "AudioFileName": "test-file.wav",
        "OssFileKey": "ccc-test/test-file.wav",
        "UpdatedTime": "2021-03-08 15:34:49.0",
        "AudioResourceId": "d5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77",
        "InstanceId": "ccc-test",
        "Name": "欢迎语",
        "CreatedTime": "2021-03-05 17:35:45.0",
        "Status": "Completed",
        "Usage": "General",
        "AuditResult": "无"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	Parameter.Maximum	The parameter %s must be less than or equal to %s.
400	Parameter.Minimum	The parameter %s must be greater than or equal to %s.
500	InternalService.Common	An internal service error occurred. %s
404	NotExists.InstanceId	The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.