文档

ListAudioFiles - 获取音频文件列表

更新时间:

调用ListAudioFiles获取指定实例下的音频文件列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

ccc-test
PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

10
Statusstring

Converting(转换中),
Completed(转换完成),
Failed(转换失败); 参数不传,查询所有状态。

Completed
Usagestring

音频文件用途,默认为 General(用于 IVR 等场景), 其他可选值为 HoldMusic(通话保持等待音)。

General

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

请求 ID。

53223330-EBF1-586B-A2CB-93C3B711FDA0
Codestring

响应码。

OK
Messagestring

响应信息。

Dataobject

数据。

PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

10
TotalCountinteger

总数。

10
Listarray<object>

音频文件列表。

object

音频文件信息。

AudioFileNamestring

音频文件名称。

test-file.wav
OssFileKeystring

音频资源文件在 OSS 中的 Key。

ccc-test/test-file.wav
UpdatedTimestring

音频资源的最后修改时间。

2021-03-08 15:34:49.0
AudioResourceIdstring

音频资源 ID,音频文件的唯一标识。

d5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77
InstanceIdstring

实例 ID。

ccc-test
Namestring

音频资源的展示名。

欢迎语
CreatedTimestring

音频资源的创建时间。

2021-03-05 17:35:45.0
Statusstring

音频文件状态。

Completed
Usagestring

音频文件用途,默认为 General(用于 IVR 等场景), 其他可选值为 HoldMusic(通话保持等待音)。

General
AuditResultstring

音频内容风险审核结果。

示例

正常返回示例

JSON格式

{
  "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": "无"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Parameter.MaximumThe parameter %s must be less than or equal to %s.参数必须小于或等于系统规定的最大值。
400Parameter.MinimumThe parameter %s must be greater than or equal to %s.参数必须大于或等于系统规定的最小值。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
500InternalService.CommonAn internal service error occurred. %s内部服务错误。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情