查詢素材庫分類

更新時間：2025-05-23 17:48:57

介面描述

1、查询账号下的素材库分类列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/material/category/list

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
materialType	true	String	素材類型 video：影片 image：圖片 document：文件 text：圖文
parentId	false	Long	父分類節點id，此參數用於查詢子分類

範例

http://api.polyv.net/live/v4/material/category/list?materialType=video&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參數描述

參數名	類型	說明
contents	Array	分類列表內容【詳見contents欄位說明】

Contents參數描述

參數名	類型	說明
id	Long	分類ID
title	String	分類名稱
type	String	分類類型 DEFAULT：預設分類 CUSTOM：自訂分類 PLAYBACK：影片回放 AI：AI影片 DISK_VIDEO：偽直播影片 TEMP_STORE：暫存儲存 PRODUCT_EXPLAIN：商品講解
subCount	Integer	子分類數量

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
  "code": 200,
  "status": "success",
  "requestId": "cb237e0e77bc49b59dda283638837d45.82.17479826520942187",
  "data": {
    "contents": [
      {
        "id": 454,
        "title": "默认",
        "type": "DEFAULT",
        "subCount": 0
      },
      {
        "id": 455,
        "title": "自定义",
        "type": "CUSTOM",
        "subCount": 1
      },
      {
        "id": 456,
        "title": "视频回放",
        "type": "PLAYBACK",
        "subCount": 0
      },
      {
        "id": 457,
        "title": "AI视频",
        "type": "AI",
        "subCount": 0
      },
      {
        "id": 458,
        "title": "伪直播视频",
        "type": "DISK_VIDEO",
        "subCount": 0
      },
      {
        "id": 459,
        "title": "临时存储",
        "type": "TEMP_STORE",
        "subCount": 0
      },
      {
        "id": 810,
        "title": "测试新建素材库分类",
        "type": "CUSTOM",
        "subCount": 0
      },
      {
        "id": 1530,
        "title": "商品讲解",
        "type": "PRODUCT_EXPLAIN",
        "subCount": 0
      }
    ]
  },
  "success": true
}

異常範例

{
  "code": 400,
  "status": "error",
  "error": {
    "code": 10003,
    "desc": "时间戳过期"
  },
  "success": false
}