查询频道连麦详情数据

更新时间：2024-11-27 11:06:41

接口描述

1、接口用于查询某个频道的一段时间区间内的连麦详情数据，支持分页
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/mic/log/list-detail

在线API调用

请求方式

GET

接口约束

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

2、该接口查询的数据并不是实时的，当日数据需在次日下午才开始生产数据，不同RTC厂商处理、生产数据耗时不同，生产数据耗时约为6~48小时

3、startDate和endDate相隔不可以超过30天

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
channelId	true	String	频道号
startDate	true	String	开始日期，格式：yyyy-MM-dd，如2020-10-01，时间范围不能超过30天
endDate	true	String	结束日期，格式：yyyy-MM-dd，如2020-10-01，时间范围不能超过30天
page	false	Integer	当前页码，默认为1
pageSize	false	Integer	每页数据大小，默认500条，最大5000条，超过5000条可以分多批拉取，每次page加1，直到返回列表contents为空为止

示例

http://api.polyv.net/live/v3/channel/mic/log/list-detail?endDate=2020-12-03&appId=frlr1zazn3&sign=F8ABBFE2C714CE6601D2551928EA704A&pageSize=2&page=1&userId=1b448be323&channelId=1965681&startDate=2020-12-01&timestamp=1621842680333

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Object	请求成功时为连麦详情信息【详见Data参数描述】，请求失败时为空

Data参数描述

参数名	类型	说明
page	Integer	当前页码，默认为1
pageSize	Integer	每页记录大小，默认500条，最大5000条，超过5000条可以分多批拉取，每次page加1，直到返回列表contents为空为止
contents	Array	查询的结果列表【详见Contents参数描述】

Contents参数描述

参数名	类型	说明
channelId	String	频道号
sessionId	String	场次号
viewerId	String	观众ID
identity	String	身份 guest：嘉宾 student：学员
nickname	String	昵称
joinTime	Long	进入 rtc 的时间，13位毫秒时间戳
leaveTime	Long	离开 rtc 的时间，13位毫秒时间戳
duration	Integer	连麦时长(分钟数)

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelViewDataTest.class);
/**
 * 查询频道连麦详情数据
 * @throws IOException
 */
@Test
public void testLinkMicDetailList() 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/mic/log/list-detail";
    String channelId = "1965681";
    String startDate = "2020-12-01";
    String endDate = "2020-12-03";
    String page = "1";
    String pageSize = "2";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("userId",userId);
    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":{
        "page":1,
        "pageSize":2,
        "contents":[
            {
                "channelId":"1965681",
                "identity":"student",
                "viewerId":"1606986299073",
                "nickname":"",
                "joinTime":1606986326000,
                "leaveTime":1606986413000,
                "sessionId":"ftmnaan4l3"
            }
        ]
    }
}

异常示例

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

直播服务端 API