保利威文档中心

幫助中心

批次刪除音訊審核詞

更新時間:2026-08-28 09:56:21

介面描述

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

介面URL

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

請求方式

POST

介面限制

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

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

3、單次批次提交最多2000個詞,請求中存在不合規內容時整批請求失敗,原詞庫保持不變

4、批次刪除不存在的詞按成功處理並計入 notFoundCount,相同參數重複請求不會誤刪其他詞

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

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 當前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則

請求體參數描述

參數名 必選 類型 說明
wordType true String 詞條類型
keyword:從敏感詞刪除
badword:從嚴禁詞刪除
words true Array 需要刪除的詞,最多2000個

範例

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

請求體json參數:

{
    "wordType": "badword",
    "words": [
        "示例严禁词一",
        "示例严禁词二"
    ]
}

回應參數描述

參數名 類型 說明
code Integer 狀態碼,與http狀態碼相同,用於確定基本的回應狀態
status String 回應結果,由業務決定,成功回傳success,失敗回傳error
success Boolean 是否成功回應
requestId String 請求ID,每次請求產生的唯一的UUID,僅可用於排查、除錯,不應該和業務掛鉤
error Object 狀態碼非200時的錯誤資訊【詳見Error參數描述
data Object 成功回應的資料【詳見data參數描述

Error參數描述

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因,如1041表示帳號未開通音訊審核
desc String 錯誤描述,與error.code對應

data參數描述

參數名 類型 說明
wordType String 本次操作的詞條類型
keyword:敏感詞
badword:嚴禁詞
requestedCount Integer 請求去重後的詞條數量
deletedCount Integer 實際刪除數量
notFoundCount Integer 原本不存在的數量
totalCount Long 操作後當前分類的詞條總數
muteEffectiveWithinMinutes Integer 已開通直播音訊消音時回傳最遲生效分鐘數(10),未開通消音時不回傳
words Array 詞條明細【詳見words參數描述

words參數描述

參數名 類型 說明
word String 詞條內容
id Long 詞條id
existed Boolean 操作時詞庫中是否已存在該詞

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 testAudioModerationWordDelete() 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/delete";
    String wordType = "badword";
    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": "badword",
        "requestedCount": 2,
        "deletedCount": 1,
        "notFoundCount": 1,
        "totalCount": 180,
        "muteEffectiveWithinMinutes": 10,
        "words": [
            {
                "word": "示例严禁词一",
                "id": 10001,
                "existed": true
            },
            {
                "word": "示例严禁词二",
                "id": 10002,
                "existed": false
            }
        ]
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 1041,
        "desc": "audio moderation is not enabled."
    },
    "success": false
}
联系客服,在线咨询
在线咨询