You need to enable JavaScript to run this app.
导航
查询语音资源列表
最近更新时间:2024.06.13 14:53:06首次发布时间:2023.02.28 20:31:38

查询账户下的语音资源列表信息。

1. 接口说明
  • 请求方式:POST

  • 接口地址:http://cloud-vms.volcengineapi.com?Action=QueryOpenGetResource&Version=2022-01-01

2. 请求参数
参数数据类型是否必填示例值描述
X-DateString20201103T104027Z鉴权字段。请参考文档中心-火山引擎

Authorization

String

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎

ServiceName

String

vms

服务名称。语音服务的服务名称是vms

RegionStringcn-north-1区域名称,固定值cn-north-1

Content-Type

String

application/json

指定请求消息体的结构化格式。语音服务的 Content-Type 为application/json

Query

参数数据类型是否必填示例值描述
ActionStringQueryOpenGetResource接口名称。该接口固定值为QueryOpenGetResource
VersionString2022-01-01接口版本。语音服务接口默认版本为2022-01-01

Body

参数数据类型是否必填示例值描述
TypeInteger0(0 语音通知文件 1文本转语音模板 2 智能语音交互文件)语音资源类型
KeywordStringtest语音资源名称或者key
StateInteger0语音资源状态(0代表审核中, 1代表审核通过, 2代表审核未通过)
LimitInteger10每页大小,默认值10,最小为1,最大100
OffsetInteger0偏移量,默认为0,第一页偏移量为0,第二页偏移量为Limit的数值,以此类推
3. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数数据类型描述
RequestIdString请求 ID。
ActionString请求的接口名称。
VersionString请求的版本号。
ServiceString请求的服务名称。
RegionString请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error

Result

参数数据类型示例值描述
RecordsList语音资源记录
TotalInteger2总数量
LimitInteger10每页大小
OffsetInteger0偏移量

Record

参数数据类型示例值描述
ResourceKeyStringe6eaa926a2ed41df8f52d63c046b7d78语音资源唯一标识符
NameStringtest语音资源名称
SuffixString.wav语音资源后缀
DurationInteger4时长(S)
StateInteger1状态(0代表审核中, 1代表审核通过, 2代表审核未通过)
CreateTimeDate2021-05-19 11:07:13创建时间
TypeInteger0语音资源类型(0语音通知文件 1文本转语音模板 2语音交互文件)
RemarkString测试备注
TtsTemplateContentStringtts模板内容仅tts有该字段
TtsOptionsStringtts配置仅tts有该字段

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。

4. 示例

请求示例

curl --location --request POST 'http://cloud-vms.volcengineapi.com?Action=QueryOpenGetResource&Version=2022-01-01' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'Content-Type: application/json' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--data-raw '{
    "Type":0,
    "Keyword":"0f299353da3343e5837310000"
}'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "2022122916224212DFB47AFC1F0179A250",
        "Action": "QueryOpenGetResource",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "Records": [
            {
                "ID": 3419,
                "ResourceKey": "0f299353da3343e5837300000",
                "Suffix": ".mp3",
                "Name": "e7737a12667f4373a56200000.mp3",
                "Duration": 17,
                "State": 1,
                "CreateTime": "2022-12-29 15:27:46",
                "Type": 0,
                "Remark": ""
            }
        ],
        "Total": 1,
        "Limit": 10,
        "Offset": 0
    }
}
  • 错误返回示例
{
    "ResponseMetadata": {
        "RequestId": "202212291628587CA24F54ACD4A677C431",
        "Action": "QueryOpenGetResource",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "RequestParametersError",
            "Message": "[type:must not be null]"
        }
    }
}