批量导入严禁词

接口描述

1、批量导入频道或者通用的严禁词
2、接口支持https协议
3、接口URL中的{userId}为"直播账号ID"

接口URL

http://api.polyv.net/live/v2/chat/{userId}/addBadWords

在线API调用

请求方式

POST

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
words	true	String[]	严禁词，json的数组格式，例如["forbiddenWords1","forbiddenWords2"] 如果严禁词含有特殊字符，需要先encode一下，例：["&#@"]需要encode为["%26%23%40"]
channelId	false	String	频道号，非必填，不提交或者传-1则设置为账号级的严禁词，对该账号的所有频道都生效

示例

http://api.polyv.net/live/v2/chat/1b448be323/addBadWords

表单参数：

appId=frlr1zazn3&words=["严禁词1","严禁词2"]&sign=8B10AC4F3379994635A0188730049A9C&channelId=2191569&timestamp=1616638938499

响应参数描述

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

data字段说明

参数名	类型	说明
userId	String	直播账户id
count	String	为该频道严禁词的数量，如果修改全部频道，count为该该账户严禁词的全部数量

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChatBannedTest.class);
/**
 * 批量导入严禁词
 * @throws IOException
 */
@Test
public void testAddBadWords() 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/v2/chat/"+userId+"/addBadWords";
        String words = "[\"严禁词1\",\"严禁词2\"]";
        String channelId = "2191569";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("words",words);
        requestMap.put("channelId",channelId);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试批量导入严禁词接口返回值：{}",response);

}

响应示例

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

成功示例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": {
    "userId": "1b448be323",
    "count": 2
  }
}

异常示例

{
  "code": 400,
  "status": "error",
  "message": "invalid signature.",
  "data": ""
}