保利威文档中心

帮助中心

查询频道场次信息

更新时间:2022-09-02 18:08:07

接口描述

1、查询频道直播场次信息
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/session/list

在线API调用

请求方式

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 频道号
startDate false String 开始日期,格式:yyyy-MM-dd HH:mm:ss,如果时间为00:00:00也支持格式:yyyy-MM-dd
endDate false String 结束日期,格式:yyyy-MM-dd HH:mm:ss,如果时间为00:00:00也支持格式:yyyy-MM-dd
page false String 页数,默认为1
pageSize false String 每页显示的数据条数,默认20

示例

https://api.polyv.net/live/v3/channel/session/list?endDate=2021-01-01&appId=frlr1zazn3&sign=A7743F8014514A865F73D11A006606C1&pageSize=10&page=1&channelId=2191532&startDate=2020-01-01&timestamp=1621841156849

响应参数描述

参数名 类型 说明
code Integer 响应状态码,200为成功返回,非200为失败【详见全局错误说明
status String 响应状态文本信息
message String 响应描述信息,当code为400或者500的时候,辅助描述错误原因
data Object 请求失败时为空,请求成功时为频道直播场次信息 【详见data字段描述

data字段描述

参数名 类型 说明
pageSize Integer 每页数据条数
pageNumber Integer 当前页数
totalItems Integer 总条数
contents Array 查询的结果列表【详见Contents参数描述
startRow Integer 当前页第一条记录在总结果集中的位置
firstPage Boolean 是否为第一页,值为:true/false
lastPage Boolean 是否为最后一页,值为:true/false
prePageNumber Integer 上一页编号
nextPageNumber Integer 下一页编号
limit Integer 每页数量大小
totalPages Integer 总页数
endRow Integer 当前页最后一条记录在总结果集中的位置
offset Integer 分页起始记录

Contents参数描述

参数名 类型 说明
channelId String 频道号
sessionId String 直播场次ID
userId String POLYV用户ID,和保利威官网一致,获取路径:官网->登录->直播(开发设置)
startTime Long 直播开始时间,13位毫秒级时间戳
endTime Long 直播结束时间,13位毫秒级时间戳

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 查询频道直播场次信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetChannelSessions() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/session/list";
    String channelId = "2191532";
    String startDate = "2020-01-01";
    String endDate = "2021-01-01";
    String page = "1";
    String pageSize = "10";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("startDate", startDate);
    requestMap.put("endDate", endDate);
    requestMap.put("page", page);
    requestMap.put("pageSize", pageSize);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道直播场次信息,返回值:{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "pageSize":20,
        "pageNumber":1,
        "totalItems":1,
        "contents":[
            {
                "sessionId":"fwmnnydr06",
                "channelId":2191532,
                "userId":"1b448be323",
                "startTime":1615450395000,
                "endTime":1615450509000
            }
        ],
        "startRow":1,
        "firstPage":true,
        "lastPage":true,
        "prePageNumber":1,
        "limit":1,
        "endRow":1,
        "nextPageNumber":1,
        "totalPages":1,
        "offset":0
    }
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询