接口描述
1、通过直播场次id,查询签到发起记录
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/chat/checkin-by-sessionId
请求方式
GET
请求参数描述
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | true | String | 账号appId |
timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据 |
channelId | true | String | 频道号 |
sessionId | true | String | 场次号,该参数获取 |
示例
http://api.polyv.net/live/v3/channel/chat/checkin-by-sessionId?appId=frlr1zazn3&sign=B47C2E7B6EC0C17F62A6E47D62635006&sessionId=fwly13xczv&channelId=2191569×tamp=1621845186924
响应参数描述
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应状态码,200为成功返回,非200为失败 |
status | String | 响应状态文本信息 |
message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
data | Array | 签到记录的数据 |
data字段说明
参数名 | 类型 | 说明 |
---|---|---|
sessionId | String | 场次号 |
roomid | String | 房间号 |
checkinid | String | 签到id,一场签到一个id |
createtime | String | 签到时间 |
Java请求示例 快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(InteractionCheckinTest.class);
/**
* 查询频道发起的签到记录
* @throws IOException
*/
@Test
public void testGetCheckinBySessionId() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "https://api.polyv.net/live/v3/channel/chat/checkin-by-sessionId";
String channelId = "2191569";
String sessionId = "fwly13xczv";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId",channelId);
requestMap.put("sessionId",sessionId);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询频道发起的签到记录接口返回值:{}",response);
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"createtime": "2021-03-11 00:43:59",
"checkinid": "d0476a90-81bf-11eb-b114-e7477b",
"sessionId": "fwly13xczv",
"roomid": "2191569"
},
{
"createtime": "2021-03-11 00:44:51",
"checkinid": "eed2a150-81bf-11eb-b114-e7477b",
"sessionId": "fwly13xczv",
"roomid": "2191569"
}
]
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
我的文章推荐:
- [视频+图文] 线上研讨会是什么,企业对内对外培训可以用线上研讨会吗?
- [图文] 企业直播对网络带宽有什么要求?
- [图文]OBS如何实现毫秒级超低延时直播
- 直播播放器API(播放器调用方法、参数、接口和事件)
- 企业内训课程视频加密防下载是如何做的?10种思路
- 超低延迟/无延迟直播(PRTC Web SDK移动端)兼容性说明