查询素材库标签列表
更新时间:2026-02-26 17:32:15
接口描述
1、分页查询账号下的素材库标签列表。
2、接口支持https协议
接口URL
https://api.polyv.net/live/v4/material/label/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| pageNumber | true | Integer | 页码 |
| pageSize | true | Integer | 每页数据大小 |
| keyword | false | String | 关键字查询,支持按标签名称模糊查询 |
示例
https://api.polyv.net/live/v4/material/label/list?pageNumber=1&pageSize=10&keyword=重要&appId=frlr1zazn3&sign=A69559D6EBF130B9C0F60807459FC311×tamp=1642733791590
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 是否成功响应 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
| error | Object | 状态码非200时的错误信息【详见Error字段描述】 |
| data | Object | 【详见data字段说明】 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| pageNumber | Integer | 当前页码 |
| pageSize | Integer | 每页数据量 |
| totalPages | Long | 页面总数 |
| totalItems | Long | 总数据量 |
| contents | Array | 当前页内容【详见contents字段说明】 |
Contents参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | Long | 标签ID |
| name | String | 素材库标签名称 |
| userId | String | 用户ID |
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "cb237e0e77bc49b59dda283638837d45.79.17479908395732399",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 2,
"contents": [
{
"id": 1,
"name": "重要",
"userId": "a7fu823e02"
},
{
"id": 2,
"name": "公告",
"userId": "a7fu823e02"
}
]
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
