查询频道签到成功记录
接口描述
1、查询频道号下,某天或某场直播的签到记录(仅返回已签到记录)
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/checkin/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
timestamp
true
Long
当前13位毫秒级时间戳,3分钟内有效
sign
true
String
签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据
【详见签名生成规则】
channelId
true
String
频道号
page
false
Integer
页码,默认为1
pageSize
false
Integer
每一页的大小,默认为20
date
false
String
查询的指定日期,格式为yyyy-MM-dd,默认查询当天签到记录
sessionId
false
String
场次id 如果传sessionId,date无效 如果不传sessionId,date有效
示例
http://api.polyv.net/live/v3/channel/checkin/list?date=2021-03-10&appId=frlr1zazn3&sign=97E7B161075A9E52ABEBC202DD25E2E5&pageSize=20&page=1&sessionId=&channelId=2191569×tamp=1621845152183
响应参数描述
data字段说明
content字段说明
id
Integer
自增主键
indate
String
签到日期,yyyy-MM-dd格式
nickname
String
昵称
userid
String
用户id
channelId
String
频道号
time
Long
签到的具体时间戳
timeFormat
String
签到的格式化详细日期,yyyy-MM-dd HH:mm 格式
sessionId
String
场次号
startTime
String
该场次直播开始时间 如果不传sessionId,startTime为空 如果传sessionId,startTime显示
checkinid
String
签到id,一场签到一个id
param4
String
在外部授权、直接(独立)授权情况下传过来的自定义参数
param5
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 testGetCheckinList() 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/checkin/list";
Integer channelId = 2191569;
Integer page = 1;
Integer pageSize = 20;
String date = "2021-03-10";
String sessionId = "";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId",channelId.toString());
requestMap.put("page",page.toString());
requestMap.put("pageSize",pageSize.toString());
requestMap.put("date",date);
requestMap.put("sessionId",sessionId);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询频道签到结果接口返回值:{}",response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"pageNumber": 1,
"totalPages": 1,
"pageSize": 20,
"contents": [
{
"id": 48010860,
"indate": "2021-03-10",
"userid": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
"channelId": 2191569,
"sessionId": "",
"time": 1615391652916,
"timeFormat": "2021-03-10 23:54",
"startTime": "",
"param4": "oi_ubswUnFt8QQFAAEJbKmd8W9BE",
"param5": "",
"nickname": "卉",
"checkinid": "db14ef80-81b8-11eb-b114-e7477b"
}
]
}
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Last updated
Was this helpful?