查询连麦详单

接口URL

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

接口说明

(接口调用有频率限制,详细请查看)

1、接口用于查询连麦详单
2、接口支持https
3、注意:该接口查询的数据并不是实时的,当日数据需在次日下午才能查询到,出数据时间在14:30 ~ 18:00之间

返回结果格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId int 频道号
startDate string 开始日期, 日期格式:yyyy-MM-dd,如2020-10-01,时间范围不能超过30天
endDate string 结束日期, 日期格式:yyyy-MM-dd,如2020-10-01,时间范围不能超过30天
page int 当前页码,默认为1
pageSize int 每页大小,默认500条,最大5000条,超过5000条可以分多批拉取,每次page加1,直到返回列表contents为空

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "page": 1,
        "pageSize": 500,
        "contents": [
            {
                "channelId": "xxxxxxx",
                "identity": "guest",
                "viewerId": "xxxxxxx",
                "nickname": "王老师",
                "joinTime": 1603596135000,
                "leaveTime": 1603596647000,
                "sessionId": "xxxxxxx"
            }
        ]
    }
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

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

签名错误

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

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status 成功为success,失败为error
data 响应结果
message 异常错误信息
channelId 频道号
sessionId 场次号
viewerId 观众ID
identity 身份,嘉宾:guest、学员:student
nickname 昵称
joinTime 进入 rtc 的时间, 13位毫秒时间戳
leaveTime 离开 rtc 的时间, 13位毫秒时间戳

Java请求示例

public void test() {
        String url = "https://api.polyv.net/live/v3/channel/mic/log/list-detail";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", String.valueOf(1234567));
        params.put("startDate", "2020-10-22");
        params.put("enddate", "2020-10-23");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

https://dev.polyv.net/2020/liveproduct/l-api/rule/live-api-java-detail/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...