查询频道的关联音视频文件详情

接口描述

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

接口URL

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

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

当前13位毫秒级时间戳,3分钟内有效

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

channelId

true

String

频道号

pageNumber

false

Integer

分页页码,默认1

pageSize

false

Integer

分页大小,默认10, 每页不能超过100条

示例

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

表单参数:

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

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

Object

请求失败时为空,请求成功时为频道直播场次信息 【详见data字段描述

data字段描述

参数名类型说明

pageSize

Integer

每页数据条数

pageNumber

Integer

当前页数

totalPages

Integer

总页

totalItems

Integer

总条数

contents

Array

查询的结果列表【详见Contents参数描述

Contents参数描述

参数名类型说明

id

Long

记录ID

channelId

Integer

频道ID

vid

String

音视频ID

title

String

资源名称

status

Integer

状态,参考点播的视频状态码

url

String

视频URL

Java请求示例

快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

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";
    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

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "e2f2c093987542af8d124c326b1b08cf.57.16528693927270281",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "id": 3,
                "channelId": 3095420,
                "vid": "cf7f07e096141ebb5d47a92d9bf01352_c",
                "title": "测试",
                "status": 61,
                "url": "https://mpv.videocc.net/cf7f07e096/2/cf7f07e096141ebb5d47a92d9bf01352_1.mp4"
            }
        ]
    },
    "success": true
}

异常示例

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

Last updated