批次新增音訊審核詞

介面描述

1、批量新增账号的音频审核词库词条（敏感词或严禁词），词库为账号级配置，账号下所有频道共用同一份词库
2、管理后台和开放API读写同一份词库，任一入口保存成功后，另一入口查询到相同结果
3、已开通直播音频消音的账号保存词库时，系统将敏感词和严禁词的合集同步到腾讯消音词库，同步成功后新增的词最迟在10分钟内对直播消音生效
4、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/audio-moderation/word/add

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

2、需開通音訊審核功能，未開通時回傳錯誤碼 1041；介面根據簽名中的 appId 確定目標帳號，不接收使用者ID或頻道號

3、詞條限制：每個帳號最多保存5000個敏感詞和5000個嚴禁詞；單個詞不超過20個漢字；單次批次提交最多2000個詞。新增後超過5000個、或請求中存在空詞、超長詞等不合規內容時，整批請求失敗，原詞庫保持不變

4、系統保存詞條前去除前後空格，判斷重複詞時忽略英文字母大小寫，同一請求內的重複詞按一個詞處理；重複新增已存在的詞按成功處理並計入 existedCount，相同參數重複請求不會產生重複詞

5、請設定請求頭contentType:application/json，JSON請求體參數不參與簽名，簽名僅使用URL參數

請求參數描述

請求體參數描述

範例

http://api.polyv.net/live/v4/user/audio-moderation/word/add?appId=frlr1zazn3&sign=49428741C1D7BEE8BE1EE545F066ECC7&timestamp=1677167340447

請求體json參數：

{
    "wordType": "keyword",
    "words": [
        "示例敏感词一",
        "示例敏感词二"
    ]
}

回應參數描述

Error參數描述

data參數描述

words參數描述

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼， 點擊下載原始碼 ，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 批量新增音频审核词
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testAudioModerationWordAdd() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/user/audio-moderation/word/add";
    String wordType = "keyword";
    List<String> words = Arrays.asList("示例敏感词一", "示例敏感词二");

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);

    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("wordType", wordType);
    jsonMap.put("words", words);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);

    log.info("测试批量新增音频审核词，返回值：{}", response);
    //do somethings

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "414afeb28f1c4f0ca17e1c3c1e39d247.71.16771673423081591",
    "data": {
        "wordType": "keyword",
        "requestedCount": 2,
        "addedCount": 1,
        "existedCount": 1,
        "totalCount": 320,
        "muteEffectiveWithinMinutes": 10,
        "words": [
            {
                "word": "示例敏感词一",
                "id": 10001,
                "existed": false
            },
            {
                "word": "示例敏感词二",
                "id": 10002,
                "existed": true
            }
        ]
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 1041,
        "desc": "audio moderation is not enabled."
    },
    "success": false
}