查询直播间用户进出记录
更新时间:2022-12-28
接口描述
根据开发者账号、直播间ID、时间范围等查询直播间用户记录
说明:时间范围查询跨度不能超过31天
请求地址
https://ccapi.csslcloud.net/openapi/collect/room/user-in-out-records
请求方式
GET
请求参数
接口统一权限认证方式请参考THQS认证方式。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
accountId | String | 是 | 开发者账号 |
roomId | String | 是 | 直播间ID |
liveId | String | 否 | 直播ID |
userId | Integer | 否 | 用户ID |
startTime | String | 否 | 查询的开始时间, 按该直播间下直播的结束时间大于等于该时间过滤. 直播ID非空时此参数无意义,格式:"yyyy-MM-dd ",示例:"2022-12-01" |
endTime | String | 否 | 查询的结束时间, 按该直播间下直播的结束时间小于等于该时间过滤. 直播ID非空时此参数无意义,格式:"yyyy-MM-dd ",示例:"2022-12-01" |
pageNum | Integer | 否 | 分页页码,默认1,取值范围:大于1的整数 |
pageSize | Integer | 否 | 每页条数,默认200,取值范围:1~200之前的任意整数 |
请求示例
GET https://ccapi.csslcloud.net/openapi/collect/room/user-in-out-records?accountId=140193A9554CED9D&roomId=EEABA9A502C8118E9C33DC5901307461&startTime=2022-12-07&endTime=2022-12-08&time=${time}&hash=${hash}
返回数据
公共返回数据结构请参考 公共返回数据说明。
名称 | 类型 | 描述 |
---|---|---|
result | String | 返回状态,"OK":成功,"FAIL":失败 |
total | Integer | 总的记录条数 |
list | Array | 进出记录列表,返回数据:JSON Array字符串 |
list说明
名称 | 类型 | 描述 |
---|---|---|
userId | String | 用户 Id |
username | String | 用户名称 |
role | String | 用户角色,取值范围:presenter,talker |
ip | String | 用户访问 Ip |
platform | String | 设备类型, 取值范围:ios,android,web,未知 |
enterTime | String | 进入直播间时间,格式:"yyyy-MM-dd HH:mm:ss" |
exitTime | String | 离开直播间时间,格式:"yyyy-MM-dd HH:mm:ss" |
返回示例
{
"result": "OK",
"data": {
"total": 7,
"list": [
{
"username": "1",
"role": "talker",
"ip": "192.168.100.182",
"platform": "web",
"userId": "hxdbRLWZhBZ7X6wr",
"enterTime": "2022-12-07 11:34:27",
"exitTime": "2022-12-07 11:57:44"
}
]
}
}