批量新增音频审核词

接口描述

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
}