内容安全识别

文本内容安全识别

接口说明

用于文本内容安全识别，即敏感词校验（2.1.0 版本新增）。

sdkInstance.checkMsgSecurity(options);

最低基础库版本要求

当用户的客户端基础库版本过低时，调用 sdkInstance.checkMsgSecurity(options) 接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）！

参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
msg	string	是	--	待检测的文本内容
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 0 时表示接口调用成功，其他非 0 状态码均表示接口调用失败
data	object / null	接口调用成功时返回校验结果，接口调用失败时返回 null
data.result	number	校验结果，0 表示不包含敏感词，1 表示包含敏感词
data.msg	string	返回处理后的文本，若包含敏感词则将敏感词替换为 *，若不包含敏感词则返回原文本
message	string	接口调用成功或失败时的相应描述信息

示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 当用户的客户端基础库版本过低时，调用此接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）
sdkInstance.checkMsgSecurity({
  msg: "特3456书yuuo莞6543李zxcz蒜7782法fgnv级",
  success: function(response) {
    console.log(response.data.result); // 0 表示不包含敏感词，1 表示包含敏感词
    console.log(response.data.msg); // 返回处理后的文本
  },
  fail: function(error) {
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});