ListAudioFiles - 获取音频文件列表

更新时间:
复制为 MD 格式

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

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

ccc-test

PageNumber

integer

分页序号,范围 1-100。

1

PageSize

integer

分页大小,范围 1-100。

10

Status

string

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

Completed

Usage

string

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

General

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 状态码。

200

RequestId

string

请求 ID。

53223330-EBF1-586B-A2CB-93C3B711FDA0

Code

string

响应码。

OK

Message

string

响应信息。

Data

object

数据。

PageNumber

integer

分页序号,范围 1-100。

1

PageSize

integer

分页大小,范围 1-100。

10

TotalCount

integer

总数。

10

List

array<object>

音频文件列表。

object

音频文件信息。

AudioFileName

string

音频文件名称。

test-file.wav

OssFileKey

string

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

ccc-test/test-file.wav

UpdatedTime

string

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

2021-03-08 15:34:49.0

AudioResourceId

string

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

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

InstanceId

string

实例 ID。

ccc-test

Name

string

音频资源的展示名。

欢迎语

CreatedTime

string

音频资源的创建时间。

2021-03-05 17:35:45.0

Status

string

音频文件状态。

Completed

Usage

string

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

General

AuditResult

string

音频内容风险审核结果。

示例

正常返回示例

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

错误码

错误信息

描述

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. 指定的呼叫中心实例不存在。

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

变更历史

更多信息,参考变更详情