# 删除弹幕

### 接口描述

```
1、通过弹幕id批量删除弹幕信息
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
```

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/v2/danmu/%7Buserid%7D/delete/README.md)

### 请求方式

```
POST
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/limit/README.md)

### 请求参数描述

| 参数名      | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| -------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| userId   | true | String | 保利威点播账户id，可以参考【[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/getSecretKey/README.md)】获取，获取路径：官网->登录->点播（API接口）                                                           |
| ptime    | true | Long   | 当前时间的毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign     | true | String | 签名，为40位大写的SHA1值,`生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/buildSign/README.md)】 |
| danmuIds | true | String | 弹幕id，多个用英文逗号隔开，参数获取自【[查询弹幕](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/video_management/danmu/get_danmu.md)】                                                                 |

### 示例

```requestUrl
http://api.polyv.net/v2/danmu/1b448be323/delete
```

表单参数：

```requestUrl
danmuIds=17251132&sign=E7149C694CEEC06D12E421B595A1D14A07D26A67&userid=1b448be323&ptime=1617244337042
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                              |
| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)】 |
| status  | String  | 响应状态文本信息                                                                                                                        |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                               |
| data    | String  | 响应成功返回success，响应失败返回空                                                                                                           |

**返回错误代码列表**

| 错误代码 | 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请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 VodSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[点播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/vod/java/README.md)完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
 private static final Logger log = LoggerFactory.getLogger(VodVideoManagementTest.class);
/**
 * 删除弹幕
 */
@Test
public void testDeleteDanmu() 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 + "/delete";
    String danmuIds =  "17251132";

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

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

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)

成功示例

```json
{
	"code": 200,
	"status": "success",
	"message": "success",
	"data": "success"
}
```

异常示例

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