根据人员获取观看时长变化数据
更新时间:2022-09-02 18:08:07
接口描述
1、根据人员获取观看时长变化数据
2、接口支持https协议
接口URL
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道号 |
| sessionId | true | String | 场次Id |
| viewerId | true | String | 学员观众Id |
示例
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 响应结果,由业务决定,成功返回true,失败返回false |
| data | Object | 成功响应时返回分发列表信息【详见Data字段说明】 |
| error | Object | 状态码非200时的错误信息【详见Error字段说明】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| viewerId | String | 学员观众Id |
| channelId | String | 频道号 |
| sessionId | String | 场次号 |
| shouldStudyTime | Integer | 应学时长 |
| grandTotalTime | Integer | 已学时长 |
| studyStatus | String | 学习状态,如果学习时长不低于90%,则学习状态为已完成 Y:已完成 N:未完成 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "",
"data": {
"viewerId": "",
"channelId": "",
"sessionId": "",
"shouldStudyTime": 0,
"grandTotalTime": 0,
"studyStatus": "N"
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
