Query Material Library Tag List
Updated: 2026-02-26 17:32:15
API Description
1、分页查询账号下的素材库标签列表。
2、接口支持https协议
API URL
https://api.polyv.net/live/v4/material/label/list
Request Method
GET
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls are subject to rate limits. See details
Request Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId See details on obtaining the key |
| timestamp | true | Long | Current 13-digit millisecond timestamp, valid within 3 minutes |
| sign | true | String | Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data. See signature generation rules |
| pageNumber | true | Integer | Page number |
| pageSize | true | Integer | Number of items per page |
| keyword | false | String | Keyword query, supports fuzzy search by tag name |
Example
https://api.polyv.net/live/v4/material/label/list?pageNumber=1&pageSize=10&keyword=重要&appId=frlr1zazn3&sign=A69559D6EBF130B9C0F60807459FC311×tamp=1642733791590
Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Response status code, 200 for success, non-200 for failure |
| status | String | Response result, determined by business logic, returns "success" on success, "error" on failure |
| success | Boolean | Whether the request was successful |
| requestId | String | Request ID, a unique UUID generated for each request, used only for troubleshooting and debugging, not for business logic |
| error | Object | Error information when status code is non-200 See Error field description |
| data | Object | See data field description |
Error Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Error code, used to identify the specific error |
| desc | String | Error description, corresponding to error.code |
Data Parameter Description
| Parameter | Type | Description |
|---|---|---|
| pageNumber | Integer | Current page number |
| pageSize | Integer | Number of items per page |
| totalPages | Long | Total number of pages |
| totalItems | Long | Total number of items |
| contents | Array | Content of the current page See contents field description |
Contents Parameter Description
| Parameter | Type | Description |
|---|---|---|
| id | Long | Tag ID |
| name | String | Material library tag name |
| userId | String | User ID |
Response Example
For global system error descriptions, see Global Error Description
Success Example
{
"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
}
Error Example
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
