Query Associated Audio/Video Files of a Channel

Updated: 2022-09-02 18:08:07

Interface Description

1、查询频道的关联音视频文件
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v4/channel/multimedia/resource/list-vids

Request Method

GET

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls are subject to frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details: Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 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 saved or used directly on the client. All APIs must be called through your own server to relay requests to the POLYV server and retrieve response data.` See details: Signature Generation Rules
channelId	true	String	Channel ID
pageNumber	false	Integer	Page number, default is 1
pageSize	false	Integer	Page size, default is 10

Example

http://api.polyv.net/live/v4/channel/multimedia/resource/list-vids

Form Parameters:

appId=fso8gzbxlr&timestamp=1652869392000&pageNumber=1&pageSize=10&channelId=3095420&sign=0FD66B7FFB735F9FA593503C68FC5534

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See details: Global Error Description
status	String	Response status text
message	String	Response description message. When code is 400 or 500, it provides additional error details
data	Object	Empty on failure. On success, contains channel live session information. See details: data field description

data Field Description

Parameter	Type	Description
pageSize	Integer	Number of items per page
pageNumber	Integer	Current page number
totalPages	Integer	Total pages
totalItems	Integer	Total items
contents	Array	List of audio/video IDs

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test case files HttpUtil.java and LiveSignUtil.java are included in the download package.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(ChannelDocTest.class);
/**
 * 查询频道的关联音视频文件
 * @throws IOException
 */
@Test
public void testGetChannelMultimediaResource() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/multimedia/resource/list-vids";
    String channelId = "3095420";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFile(url, requestMap,fileMap,"utf-8");
    log.info("查询频道的关联音视频文件：{}",response);
    //do somethings

}

Response Example

For system global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "e2f2c093987542af8d124c326b1b08cf.57.16528700543290335",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            "cf7f07e096141ebb5d47a92d9bf01352_c"
        ]
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

Live Streaming Server API