基于课节维度查询用户信息

接口描述

1、基于课节维度查询用户信息
2、接口支持https协议
3、这里的数据只是纯业务统计数据,与计费无关

接口URL

http://api.polyv.net/hi-class-api/open/statistics/v1/list

请求方式

GET

接口约束

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

请求参数描述

参数名
必选
类型
说明

appId

true

String

账号appId【详见获取密钥arrow-up-right

timestamp

true

Long

当前13位毫秒级时间戳,3分钟内有效

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则arrow-up-right

lessonId

true

Long

课节号

pageSize

false

Integer

分页大小,默认10

pageNumber

false

Integer

当前页数,第几页,默认1

示例

响应参数描述

参数名
类型
说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明arrow-up-right

status

String

响应状态文本信息

error

Error

错误对象【详见全局错误说明arrow-up-right

data

Object

请求成功时的有关信息【详见Data参数描述arrow-up-right】,请求失败时为空

Data参数描述

参数名
类型
说明

pageSize

Integer

每页数据大小,默认10

pageNumber

Integer

当前的页数

totalPages

Integer

总页数

totalItems

Integer

总的条数

contents

Array

查询的结果列表【详见Contents参数描述arrow-up-right

Contents参数描述

参数名
类型
说明

viewerId

String

用户ID

name

String

用户昵称

startTime

Date

进入时间,格式:年月日时分秒 yyyy-MM-dd HH:mm:ss

endTime

Date

离开房间,格式:年月日时分秒 yyyy-MM-dd HH:mm:ss

joinDuration

String

连麦时长,格式:时分秒 HH:mm:ss

ip

String

ip

userAgent

String

用户设备

operatingSystem

String

操作系统,是Windows 还是Mac;安卓,iOS;其他

browser

String

浏览器,例如Chrome 93

country

String

国家

province

String

省份

city

String

城市

isp

String

运营商

Java请求示例

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

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

响应示例

系统全局错误说明详见全局错误说明arrow-up-right

成功示例

异常示例

Last updated