You need to enable JavaScript to run this app.
导航
语音服务
  • 文档首页
    • /
  • 语音服务

获取可用语音资源

最近更新时间：2023.08.17 21:00:08

首次发布时间：2023.02.28 20:31:38

我的收藏

获取账户下可用的语音资源文件信息。

1. 接口说明

  • 请求方式：POST

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

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

Authorization

String

是

HMAC-SHA256 Credential***

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

ServiceName

String

是

vms

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

RegionString是cn-north-1区域名称，固定值cn-north-1。

Query

参数数据类型是否必填示例值描述
ActionString是QueryUsableResource接口名称。该接口固定值为QueryUsableResource。
VersionString是2022-01-01接口版本。语音服务接口默认版本为2022-01-01。
TypeInteger是0语音资源类型(0语音通知文件 1文本转语音模板 2语音交互文件)
3. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

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

Result

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

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。
4. 示例

请求示例

curl --location --request POST 'http://cloud-vms.volcengineapi.com?Action=QueryUsableResource&Version=2022-01-01&Type=0' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "2022122916090830725048BB2D1676BCB5",
        "Action": "QueryUsableResource",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": [
        {
            "ID": 1,
            "ResourceKey": "6037c85f7f5644fc921b00000",
            "Suffix": ".wav",
            "Name": "ceshi",
            "Duration": 9,
            "State": 1,
            "CreateTime": "2022-02-24 23:13:35",
            "Type": 0,
            "Remark": ""
        },
        {
            "ID": 2,
            "ResourceKey": "0f299353da3343e5830000000",
            "Suffix": ".mp3",
            "Name": "e7737a12667f4373000000.mp3",
            "Duration": 17,
            "State": 1,
            "CreateTime": "2022-12-29 15:27:46",
            "Type": 0,
            "Remark": ""
        }
    ]
}
  • 错误返回示例
{
    "ResponseMetadata": {
        "RequestId": "20221229161157D9833997E4D6A3798FBB",
        "Action": "QueryUsableResource",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "RequestParametersError",
            "Message": "请求参数错误"
        }
    }
}