创建单条弹幕

接口描述

1、通过视频id创建弹幕信息，弹幕暂不支持特殊字符与表情符号
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

接口URL

http://api.polyv.net/v2/danmu/{userid}/add

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
userId	true	String	保利威点播账户id，可以参考【获取密钥】获取，获取路径：官网->登录->点播（API接口）
ptime	true	Long	当前时间的毫秒级时间戳，3分钟内有效
sign	true	String	签名，为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
vid	true	String	视频id
msg	true	String	弹幕信息
time	true	String	弹幕出现的时间，格式：HH:mm:ss，例：00:00:20
sessionId	false	String	场次号，自定义参数，比如：表示学员信息的学员id
param2	false	String	自定义参数
fontSize	false	Integer	字体大小，默认：18
fontMode	false	String	出现位置，默认为roll roll：滚动 top：顶部 bottom：底部
fontColor	false	String	字体颜色，格式：0xFFFFFF，默认：0xFFFFFF（白色）

示例

http://api.polyv.net/v2/danmu/1b448be323/add

表单参数：

vid=1b448be323b68b2999802799a98dba54_1&msg=测试添加弹幕~&sign=49BBCBC672DF778CE6C6DE8EB1F4BB7BE9B2C395&time=00:00:05&userid=1b448be323&ptime=1617173648080

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Object	成功返回弹幕id，失败返回空【详见data字段说明】

data字段说明

参数名	类型	说明
Id	Integer	弹幕id

返回错误代码列表

错误代码	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.	签名不正确
400	vid doesn't exist.	视频vid为空
400	vid, msg and time should not be empty.	必传参数为空
400	Wrong time format.	弹幕时间格式不对
400	font size illegal	字体格式非法

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。

强烈建议您使用点播Java SDK完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

 private static final Logger log = LoggerFactory.getLogger(VodVideoManagementTest.class);
/**
 * 创建弹幕
 */
@Test
public void testAddDanmu() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v2/danmu/"+userId+"/add";
    String vid =  "1b448be323b68b2999802799a98dba54_1";
    String msg =  "测试添加弹幕";
    String time =  "00:00:05";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userid", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("msg", msg);
    requestMap.put("time", time);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));

    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试创建弹幕，{}", response);
    //do somethings
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
	"code": 200,
	"status": "success",
	"message": "success",
	"data": {
		"Id": 17251132
	}
}

异常示例

时间戳过期：

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}

签名报错

{
    "code": 400,
    "status": "error",
    "message": "the sign is not right.",
    "data": ""
}

必须参数为空

{
    "code": 400,
    "status": "error",
    "message": "vid, msg and time should not be empty.",
    "data": ""
}

弹幕时间格式不对

{
    "code": 400,
    "status": "error",
    "message": "Wrong time format.",
    "data": ""
}

非法参数

{
    "code": 400,
    "status": "error",
    "message": "font size illegal",
    "data": ""
}

视频不存在

{
    "code": 400,
    "status": "error",
    "message": "vid doesn't exist.",
    "data": ""
}