查询弹幕列表
更新时间:2025-01-14 15:59:20
接口描述
1、分页查询用户下所有的弹幕信息
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
接口URL
http://api.polyv.net/v2/danmu/{userid}
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| ptime | true | Long | 当前时间的毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| vid | false | String | 视频id,传入则查询该视频下所有弹幕,不传则查询用户所有弹幕 |
| numPerPage | false | Integer | 单页显示的记录条数 |
| pageNum | false | Integer | 查询的页数 |
示例
http://api.polyv.net/v2/danmu/1b448be323?vid=1b448be323b68b2999802799a98dba54_1&sign=F6254A68BF8AC6570848D86CDB7F57BB3989638A&numPerPage=1&ptime=1617241038467&pageNum=1
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Object | 响应成功时返回视频弹幕详细信息【详见data字段说明】 |
data字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| pageNumber | Integer | 当前页 |
| totalItems | Integer | 总的记录数 |
| totalPages | Integer | 总的页数 |
| endRow | Integer | 当前页最后一个记录在总记录中的位置 |
| startRow | Integer | 当前页第一条记录在总记录中的位置 |
| activePageNum | Integer | 实际页码 |
| firstPage | Boolean | 是否为第一页,值为:true/false |
| lastPage | Boolean | 是否为最后一页,值为:true/false |
| nextPageNumber | Integer | 下一页编号 |
| prePageNumber | Integer | 上一页编号 |
| limit | Integer | 当前页记录个数 |
| offset | Integer | 分页起始记录 |
| contents | Object | 上传者信息 【详见contents字段说明】 |
contents字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | Integer | 弹幕信息的唯一标识 |
| vid | String | 视频id |
| userid | String | 保利威点播账户id |
| msg | String | 弹幕信息内容 |
| time | String | 弹幕出现的时间点,格式:HH:mm:ss,例:00:00:10 |
| fontsize | String | 弹幕内容的字体大小 |
| fontmode | String | 弹幕内容滚动方式 roll:滚动 top:顶部 bottom:底部 |
| fontcolor | String | 弹幕内容字体颜色 |
| timestamp | Long | 弹幕内容出现的时间,13位毫秒级时间戳 |
| sessionid | String | 自定义参数(不能超过64位的字符串),添加弹幕传入的自定义参数(例如客户自己的用户id资料等) |
| param2 | String | 自定义参数(不能超过64位的字符串),添加弹幕传入的自定义参数(例如客户自己的用户id资料等) |
| msgtype | String | 直播回放转存到点播时会把聊天记录转为点播弹幕信息,直播聊天室消息类型 speak:发言 chatImg:发图片 |
| user | String | 直播回放转存到点播的数据,登录直播聊天的用户信息,数据格式:json对象【详见user参数描述】 |
| origin | String | 弹幕来源 vod:点播 playback:直播回放的聊天数据 chat:直播过程的聊天数据 |
| viewerId | String | 自定义参数(不能超过64位的字符串),添加弹幕传入的自定义参数(例如客户自己的用户id资料等) |
user参数描述
| 字段 | 类型 | 说明 |
|---|---|---|
| actor | String | 头衔 |
| banned | Boolean | 是否禁言,true/false |
| channelId | String | 频道id |
| clientIp | String | 用户ip |
| nick | String | 用户昵称 |
| pic | String | 用户头像 |
| roomId | String | 房间号 |
| sessionId | String | 直播的场次id |
| uid | String | 聊天室socketid |
| userId | String | POLYV用户ID,和保利威官网一致,获取路径:官网->登录->点播(API接口) |
| userType | String | 用户类型,默认为student,三分屏场景下学员需设置为slice student:普通学员 slice:云课堂学员 teacher:讲师 manager:管理员 assistant:助教 guest:嘉宾 |
返回错误代码列表
| 错误代码 | message | 说明 |
|---|---|---|
| 400 | sign can not be empty. | 加密串为空 |
| 400 | ptime is too old. | 时间戳过期 |
| 400 | ptime is illegal. | 时间戳参数格式不对或者超过当前时间3分钟 |
| 400 | Could not find user by userid. | userid不存在 |
| 400 | the sign is not right. | 加密串不正确 |
| 500 | query failed. | 后台程序抛异常 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。
强烈建议您使用点播Java SDK完成API的功能对接,点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(VodVideoManagementTest.class);
/**
* 查询弹幕
*/
@Test
public void testGetDanmu() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userId = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String url = String.format("http://api.polyv.net/v2/danmu/%s", userId);
String vid = "1b448be323b68b2999802799a98dba54_1";
String numPerPage = "1";
String pageNum = "1";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("ptime", ptime);
requestMap.put("vid", vid);
requestMap.put("numPerPage", numPerPage);
requestMap.put("pageNum", pageNum);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.get(url, requestMap);
log.debug("测试查询弹幕,{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "success",
"data": {
"pageNumber": 1,
"totalItems": 7,
"contents": [{
"id": 17252332,
"vid": "1b448be323b68b2999802799a98dba54_1",
"userid": "1b448be323",
"msg": "测试获取弹幕信息",
"time": "00:00:01",
"fontsize": "24",
"fontmode": "roll",
"fontcolor": "0xFFFFFF",
"timestamp": 1617176768000,
"sessionid": null,
"param2": null,
"msgtype": "speak",
"user": "",
"origin": "vod",
"viewerId": null
}],
"totalPages": 1,
"endRow": 7,
"startRow": 1,
"nextPageNumber": 1,
"prePageNumber": 1,
"activePageNum": 1,
"firstPage": true,
"lastPage": true,
"limit": 1,
"offset": 0
}
}
异常示例
{
"code": 400,
"status": "error",
"message": "ptime is too old.",
"data": ""
}
