保利威文档中心

帮助中心

直播服务端 API

查询素材库分类

更新时间：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
}
联系客服，在线咨询