查詢素材庫標籤列表

更新時間：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&timestamp=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
}