Batch Add Audio Moderation Words

API Description

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

API URL

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

Request Method

POST

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have a frequency limit. See details

2. The audio moderation feature must be enabled. If not, error code 1041 is returned. The API determines the target account based on appId in the signature. User ID or channel number is not accepted.

3. Word limits: Each account can store up to 5,000 sensitive words and 5,000 prohibited words. A single word cannot exceed 20 Chinese characters. A single batch submission can contain up to 2,000 words. If the total exceeds 5,000 after addition, or if the request contains empty words, overly long words, or other non-compliant content, the entire batch request fails and the original word library remains unchanged.

4. The system trims leading and trailing spaces before saving words. Case is ignored when checking for duplicate words. Duplicate words within the same request are treated as a single word. Adding an existing word again is treated as successful and counted in existedCount. Repeated requests with identical parameters will not create duplicate words.

5. Set the request header Content-Type: application/json. JSON request body parameters are not included in the signature. The signature only uses URL parameters.

Request Parameter Description

Request Body Parameter Description

Example

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

Request body JSON parameters:

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

Response Parameter Description

Error Parameter Description

Data Parameter Description

Words Parameter Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

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

}

Response Example

For global error descriptions, see Global Error Description

Success Example

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

Error Example

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