批量匯入禁止詞

更新時間：2022-09-02 18:08:07

介面描述

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": ""
}