设置过滤关键字

设置过滤关键字

API 地址

api.vhallyun.com/api/v2/channel/set-keyword

描述

根据应用app_id,设置聊天关键字过滤

场景描述

例如有些客户存在特殊关键词,并非是市场上通用的敏感词,即可调用该接口,设置需要过滤掉的关键字,设置好后即可在聊天SDK使用的过程中,将特殊关键词过滤从而不展示给频道内的用户。

注意

  • 关键字配置为全量配置,即一次接口调用,全量配置参数,覆盖之前配置内容,非增量更新。
  • 白名单优先级高于黑名单,关键字最多配置1000个。

入参

关于公共请求参数详细内容,请参考 公共请求参数。

参数 类型 是否必选 含义
black_list string 否 黑名单关键字,多个关键字以逗号分割
white_list string 否 白名单关键字,多个关键字以逗号分割

出参

参数 类型 是否必选 含义
app_id string 是 应用ID
black_list string 是 黑名单关键字
white_list string 是 白名单关键字

错误码

错误码 类型 含义
50017 int 设置自定义过滤关键字失败

响应格式

{
    "code": 200,
    "msg": null,
    "data":{
        "app_id":"app_sdfewfwe2e12321",//应用ID
        "black_list":"暴力的,不健康的",//黑名单关键字
        "white_list":"微吼,微吼直播"//白名单关键字
    }
}