查询报名观看记录
更新时间:2024-12-13 15:32:04
接口描述
1、查询报名观看记录
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/enroll/list
请求方式
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 | 频道号 |
| viewerIds | false | String | 观众id列表用逗号隔开,上限20个 |
示例
http://api.polyv.net/live/v3/channel/enroll/list?appId=frlr1zazn3&sign=68A98C385C45853A5C273D2145575BC5&channelId=2453970×tamp=1629969811503
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Object | 响应成功时返回报名观看记录【详见data字段描述】 |
data字段描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| auditEnabled | String | 频道报名审核开关 Y:开启 N:关闭 |
| list | Array | 报名观看记录【详见list字段描述】 |
list字段描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| viewerId | String | 观众ID |
| mobile | String | 手机号 |
| createTime | Long | 报名时间,13位毫秒级时间戳 |
| hasWatched | String | 是否已观看 Y:是 N:否 |
| promoteId | String | 推广渠道ID |
| promoteName | String | 推广渠道名称 |
| auditStatus | String | 审核结果 W:未审核 P:已通过 F:已拒绝 |
| fields | Array | 报名信息【详见fields字段描述】 |
fields字段描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| name | String | 报名信息名称 |
| value | String | 报名信息值 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTestLive.class);
/**
* 查询报名观看记录
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void enrollTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v3/channel/enroll/list";
String channelId = "2453970";
String viewerIds = "1,2,3";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("viewerIds", viewerIds);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询报名观看记录:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"auditEnabled": "N",
"list": [{
"viewerId": "1628213504323",
"mobile": "133",
"createTime": 1628213514000,
"hasWatched": "N",
"promoteId": null,
"promoteName": null,
"auditStatus": "P",
"fields": [{
"name": "邮箱",
"value": ""
}, {
"name": "1518406",
"value": "ces"
}, {
"name": "姓名",
"value": "liiii"
}, {
"name": "手机号码",
"value": "133"
}]
}]
}
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
