接口URL
https://api.polyv.net/live/v3/channel/statistics/get-session-stats
接口说明
(接口调用有频率限制，详细请查看)
1、接口用于统计直播间内多场次的直播和观看数据
2、接口支持https
返回结果支持格式
JSON
请求方式
GET
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取，在直播系统登记的appId |
| timestamp | 是 | long | 13位当前毫秒级时间戳 |
| sign | 是 | string | 签名值 |
| channelId | 是 | int | 频道号 |
| sessionIds | 否 | string | 场次ID,多个场次使用','分隔，场次ID和直播开始结束时间必填一项,场次ID和直播开始结束时间同时存在时，使用场次ID进行查询 |
| startTime | 否 | long | 直播开始时间13位毫秒级时间戳，开始时间和结束时间相隔不可以超过30天,场次ID和直播开始结束时间必填一项 |
| endTime | 否 | long | 直播结束时间13位毫秒级时间戳，场次ID和直播开始结束时间必填一项 |
响应成功JSON示例：
{
"code": 200,
"status": "success",
"message": "",
"data": {
"list": [
{
"channelId": 1947328,
"sessionId": "fvipafupmh",
"name": "test",
"startTime": 1612319385000,
"duration": 595,
"liveUV": 1,
"livePV": 6,
"playbackPV": 6,
"playbackUV": 2
},
{
"channelId": 1947328,
"sessionId": "fw82mayhuy",
"name": "test",
"startTime": 1614307485000,
"duration": 49,
"liveUV": 1,
"livePV": 1,
"playbackPV": 2,
"playbackUV": 1
}
]
}
}
响应字段说明
| 参数名 | 说明 |
|---|---|
| code | 状态码,成功为200，签名失败为403，参数错误为400，服务端错误为500 |
| status | 成功为success,错误时为error |
| message | 成功为""，错误时为错误描述信息 |
| data | 响应数据 |
| data.list.channelId | 频道ID |
| data.list.sessionId | 场次ID |
| data.list.name | 场次名称 |
| data.list.startTime | 场次开始时间,时间戳 |
| data.list.duration | 直播时长,单位秒 |
| data.list.livePV | 直播观看人次 |
| data.list.liveUV | 直播观看人数 |
| data.list.playbackPV | 回看观看人次 |
| data.list.playbackUV | 回看观看人数 |
响应失败JSON示例：
参数错误
{
"code": 400,
"status": "error",
"message": "param validate error",
"data": ""
}
未输入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": 403,
"status": "error",
"message": "illegal channel id: %s",
"data": ""
}
java请求示例
public void testAddRecordTask() {
String url = "https://api.polyv.net/live/v3/channel/pptRecord/get-setting";
// appId和加密串
String appId = "xxxxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxx";
int channelId = 123;
Map<String, String> params = new HashMap<>();
params.put("channelId", String.valueOf(channelId));
params.put("sessionIds", "fw82mayhuy,fvipafupmh");
// 调用Polyv的工具类方法设置sign
PolyvTool.setLiveSign(params, appId, appSecret);
String content = HttpClientUtil.getInstance()
.sendHttpPost(url, params);
System.out.println(content);
}
签名规则及工具文件代码
https://dev.polyv.net/2020/liveproduct/l-api/rule/live-api-java-detail/
Loading...