查询音频审核词库

更新时间：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
}