查詢音訊審核詞庫

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

介面描述

1、分页查询账号的音频审核词库（敏感词或严禁词），词库为账号级配置，账号下所有频道共用同一份词库
2、管理后台和开放API读写同一份词库，任一入口保存成功后，另一入口查询到相同结果
3、接口支持https协议

介面URL

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

請求方式

GET

介面限制

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

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

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
wordType	true	String	詞條類型 keyword：敏感詞 badword：嚴禁詞
pageNumber	false	Integer	頁碼，從1開始，預設為1
pageSize	false	Integer	每頁數量，1-100，預設為20

範例

http://api.polyv.net/live/v4/user/audio-moderation/word/list?appId=frlr1zazn3&sign=49428741C1D7BEE8BE1EE545F066ECC7&timestamp=1677167340447&wordType=keyword&pageNumber=1&pageSize=20

回應參數描述

參數名	類型	說明
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：嚴禁詞
pageNumber	Integer	當前頁碼
pageSize	Integer	每頁數量
totalItems	Long	當前分類的詞條總數，每個帳號最多儲存5000個敏感詞和5000個嚴禁詞
totalPages	Long	總頁數
contents	Array	當前頁的詞條

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 testAudioModerationWordList() 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/list";
    String wordType = "keyword";
    Integer pageNumber = 1;
    Integer pageSize = 20;

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("wordType", wordType);
    requestMap.put("pageNumber", String.valueOf(pageNumber));
    requestMap.put("pageSize", String.valueOf(pageSize));
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试查询音频审核词库，返回值：{}", response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "414afeb28f1c4f0ca17e1c3c1e39d247.71.16771673423081591",
    "data": {
        "wordType": "keyword",
        "pageNumber": 1,
        "pageSize": 20,
        "totalItems": 2,
        "totalPages": 1,
        "contents": [
            "示例敏感词一",
            "示例敏感词二"
        ]
    },
    "success": true
}

異常範例

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