Query Material List

Updated: 2026-02-27 11:12:23

API Description

1、查询账号下的素材列表，支持分页，支持按素材类型、分类等条件进行查询。
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/material/list

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details in Get Secret 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 never 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 details in Signature Generation Rules
pageNumber	true	Integer	Page number
pageSize	true	Integer	Number of items per page
type	true	String	Material type image: Image video: Video audio: Audio document: Document
categoryId	false	Long	Material category ID
title	false	String	Material title or channel number, supports fuzzy search
startCreateTime	false	Long	Creation time range query - start value (13-digit timestamp)
endCreateTime	false	Long	Creation time range query - end value (13-digit timestamp)
expireSecond	false	Long	Playback URL signature validity period (in seconds). Default is one day if not provided. Maximum is 30 days (2592000).

Example

http://api.polyv.net/live/v4/material/list?pageNumber=1&pageSize=10&categoryId=123&type=video&appId=frlr1zazn3&sign=A69559D6EBF130B9C0F60807459FC311&timestamp=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 response is successful
requestId	String	Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging purposes, should not be tied to business logic
error	Object	Error information when status code is non-200 See details in Error Field Description
data	Object	See details in Data Field Description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error reason
desc	String	Error description, corresponds 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 details in Contents Field Description

Contents Parameter Description

Parameter	Type	Description
id	String	Material ID
url	String	Material access URL (with validity period)
title	String	Material title
type	String	Material type video: Video image: Image document: Document text: Text & Image
fileSize	Long	File size (bytes)
duration	Long	Duration (seconds), only for video type materials
source	String	Material source upload: Local upload record: Recorded video pptRecord: Courseware remake aiVideo: AI video channelDocument: Channel courseware productExplain: Product explanation
extData	Object	Extended data, different material types contain different extended information firstImg: First image URL screenshotList: Video screenshot list subtitleList: Subtitle list text: Text & Image content (only for text & image type)
categoryId	Long	Category ID
status	String	Material status normal: Normal temp_store: Temporary storage recycle: Recycle bin wait_audit: Pending review auditing: Under review audit_fail: Review failed wait_encode: Pending transcoding encoding: Transcoding encode_fail: Transcoding failed expired: Expired
expireDate	Long	Material expiration timestamp (milliseconds)
createUserId	String	Creator user ID
createUserName	String	Creator user name
channelId	Long	Associated channel ID (only for some materials)
createTime	Long	Creation timestamp (milliseconds)
updateTime	Long	Update timestamp (milliseconds)

Response Example

For system-wide error descriptions, see Global Error Description

Success Example

Query video materials

{
  "code": 200,
  "status": "success",
  "requestId": "cb237e0e77bc49b59dda283638837d45.79.17479908395732399",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalItems": 1,
    "contents": [
      {
        "id": "a7fu823e0297829685d04d48e592a164",
        "url": "https://m-tc.videocc.net/polyvlive/02e830941397757912837685700/recordclip-20250516113833-130254-182f0b20_s.mp4?sign=9cd164c11e74d0331a72752b3328413941a3d1b78b9885b01675aa7cb8d98366&t=1748077239",
        "title": "商品讲解-素材库_商品讲解片段",
        "type": "video",
        "fileSize": 3868757,
        "duration": 74,
        "source": "productExplain",
        "extData": {
          "firstImg": "https://videolib-tc.videocc.net/material/2025-05-16/a7fu823e02/video/a7fu823e0297829685d04d48e592a164/a7fu823e0297829685d04d48e592a164_1.jpg",
          "screenshotList": [
            "https://videolib-tc.videocc.net/material/2025-05-16/a7fu823e02/video/a7fu823e0297829685d04d48e592a164/a7fu823e0297829685d04d48e592a164_1.jpg",
            "https://videolib-tc.videocc.net/material/2025-05-16/a7fu823e02/video/a7fu823e0297829685d04d48e592a164/a7fu823e0297829685d04d48e592a164_2.jpg",
            "https://videolib-tc.videocc.net/material/2025-05-16/a7fu823e02/video/a7fu823e0297829685d04d48e592a164/a7fu823e0297829685d04d48e592a164_3.jpg",
            "https://videolib-tc.videocc.net/material/2025-05-16/a7fu823e02/video/a7fu823e0297829685d04d48e592a164/a7fu823e0297829685d04d48e592a164_4.jpg",
            "https://videolib-tc.videocc.net/material/2025-05-16/a7fu823e02/video/a7fu823e0297829685d04d48e592a164/a7fu823e0297829685d04d48e592a164_5.jpg"
          ],
          "fileSize": null,
          "subtitleList": null,
          "recordFile": null,
          "share": {
            "title": "商品讲解-素材库_商品讲解片段",
            "description": "发现了一个精彩视频，快点击看看吧",
            "icon": "https://videolib-tc.videocc.net/material/2025-05-16/a7fu823e02/video/a7fu823e0297829685d04d48e592a164/a7fu823e0297829685d04d48e592a164_1.jpg"
          },
          "text": null
        },
        "categoryId": 1530,
        "status": "normal",
        "expireDate": null,
        "createUserId": "a7fu823e02",
        "createUserName": "系统生成",
        "channelId": 5859892,
        "createTime": 1747366763000,
        "updateTime": 1747366805000,
        "sourceId": null,
        "inChannelPlayback": false
      }
    ]
  },
  "success": true
}

Query image materials

{
  "code": 200,
  "status": "success",
  "requestId": "cb237e0e77bc49b59dda283638837d45.73.17479910224942443",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalItems": 1,
    "contents": [
      {
        "id": "a7fu823e02a038048f630942fdacc981",
        "url": "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2025/04/h6axa0tk9i.png",
        "title": "红色 128 128.png",
        "type": "image",
        "fileSize": 21868,
        "duration": 0,
        "source": "upload",
        "extData": {
          "firstImg": null,
          "screenshotList": null,
          "fileSize": null,
          "subtitleList": null,
          "recordFile": null,
          "share": null,
          "text": null,
          "encodeTemplateId": "FHD-2"
        },
        "categoryId": 450,
        "status": "normal",
        "expireDate": null,
        "createUserId": "a7fu823e02",
        "createUserName": "欧佩锶",
        "channelId": 0,
        "createTime": 1744302007000,
        "updateTime": 1744302007000,
        "sourceId": null,
        "inChannelPlayback": false
      }
    ]
  },
  "success": true
}

Query document materials

{
  "code": 200,
  "status": "success",
  "requestId": "cb237e0e77bc49b59dda283638837d45.73.17479911121192453",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalItems": 1,
    "contents": [
      {
        "id": "a7fu823e02e492517f80494327b58ad6",
        "url": "https://polyvppt.oss-cn-shenzhen.aliyuncs.com/sources/20250411/a7fu823e02e492517f8043294327b58ad6.pdf",
        "title": "7月体验设计报告.pdf",
        "type": "document",
        "fileSize": 4247512,
        "duration": 0,
        "source": "upload",
        "extData": null,
        "categoryId": 452,
        "status": "normal",
        "expireDate": null,
        "createUserId": "a7fu823e02",
        "createUserName": "欧佩锶",
        "channelId": 0,
        "createTime": 1744301806000,
        "updateTime": 1744301869000,
        "sourceId": null,
        "inChannelPlayback": false
      }
    ]
  },
  "success": true
}

Query text & image materials

{
  "code": 200,
  "status": "success",
  "requestId": "cb237e0e77bc49b59dda283638837d45.74.17479913547392435",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalItems": 1,
    "contents": [
      {
        "id": "a7fu823e022710f7d7d26b4f69aaa6c0",
        "url": "",
        "title": "多图测试图文",
        "type": "text",
        "fileSize": 0,
        "duration": 0,
        "source": "upload",
        "extData": {
          "firstImg": null,
          "screenshotList": null,
          "fileSize": null,
          "subtitleList": null,
          "recordFile": null,
          "share": {
            "title": "多图测试图文",
            "description": "发现了一个精彩内容，快点击看看吧",
            "icon": "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2025/03/h5zardn31m.jpg?plv_mms=1743391043863-350.3742757194408"
          },
          "text": {
            "images": [
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2025/03/h5zardn31m.jpg?plv_mms=1743391043863-350.3742757194408",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2025/03/h5zards08q.jpg?plv_mms=1743391043863-602.6920334225199",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2025/01/h3nqvs8jas.jpeg?plv_mms=1743391043863-751.5467422146664",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2025/01/h3nqtk957b.jpeg?plv_mms=1743391043863-420.29323508747865",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2024/12/h30ix9w7qj.jpg?plv_mms=1743391043863-197.84624565239062",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2024/12/h30iwvyu4r.jpg?plv_mms=1743391043863-922.8547464558876",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2024/12/h30iwlmh6j.jpeg?plv_mms=1743391043863-12.867434730769789",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2024/10/h153sh5jk0.jpg?plv_mms=1743391043863-632.0940623335202",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2024/10/h153sh3vyn.jpg?plv_mms=1743391043863-965.7372635000663",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2024/10/h153shiyd5.jpg?plv_mms=1743391043863-314.0656978590886",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2024/10/h153sge9pg.jpg?plv_mms=1743391058642-460.42600062547456",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2024/10/h153sgf9pu.jpg?plv_mms=1743391058642-614.4276765364893",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2024/10/h153sfr5q5.jpg?plv_mms=1743391058642-217.8931084108091",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2025/03/h5zb7a45id.jpg?plv_mms=1743392053424-313.51302601559826",
              "https://liveimages.videocc.net/uploaded/images/a7fu823e02/2025/03/h5zb5w0dsn.png?plv_mms=1743392240749-654.9400646223855"
            ],
            "description": "多图测试图文22222222222222"
          }
        },
        "categoryId": 1037,
        "status": "normal",
        "expireDate": null,
        "createUserId": "a7fu823e02",
        "createUserName": "欧佩锶",
        "channelId": 0,
        "createTime": 1743391137000,
        "updateTime": 1747991341000,
        "sourceId": null,
        "inChannelPlayback": false
      }
    ]
  },
  "success": true
}

Error Example

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

Live Streaming Server API