1. 接口描述
接口请求域名: wav.tencentcloudapi.com 。
通过接口按类型拉取租户当前的素材列表及关键信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:QueryMaterialList。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-29。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
MaterialType | 是 | Integer | 素材类型:0-图片,1-视频,3-文章,10-车型,11-名片 示例值:0 |
Cursor | 否 | String | 用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填 示例值:2Kgdu51quLaeNJSlwb79im883bftBE9d9Emju5I2MVw= |
Limit | 否 | Integer | 返回的最大记录数,整型,最大值100,默认值50,超过最大值时取最大值 示例值:100 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NextCursor | String | 分页游标,再下次请求时填写以获取之后分页的记录,如果已经没有更多的数据则返回空 注意:此字段可能返回 null,表示取不到有效值。 示例值:2Kgdu51quLaeNJSlwb79im883bftBE9d9Emju5I2MVw= |
PageData | Array of MaterialInfo | 企业素材列表响应数据 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取企业素材列表接口
输入示例
POST / HTTP/1.1
Host: wav.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryMaterialList
<公共请求参数>
{
"Cursor": "+1H24tK0tELjSiTOR10DzA==",
"Limit": 100,
"MaterialType": 0
}
输出示例
{
"Response": {
"NextCursor": "+1H24tK0tELjSiTOR10DzA==",
"PageData": [
{
"MaterialId": 0,
"MaterialName": "素材名称",
"Status": 0
}
],
"RequestId": "4d48312c-a062-4875-a5d5-69f0f11baf96"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.InvalidAuthorizationCode | 授权码无效。 |
AuthFailure.MissingAccessToken | 令牌无效。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.TimeSpanLimitExceeded | 参数值时间跨度超出接口限制。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |