内容过滤API
<p>[TOC]</p>
<h2>简介</h2>
<p>本文档提供了文本、图片过滤的API接口，开发者需要 <a href="https://www.showdoc.cc/mssdk?page_id=2615409307929897">联系我们</a> 获取相关的参数才能使用该API。</p>
<p>该文档所提供的API接口，客户端和服务端都可以使用。</p>
<h2>文本过滤</h2>
<ul>
<li>请求URL：<a href="http://goonie.uu.cc/v2/saas/anti_fraud/text">http://goonie.uu.cc/v2/saas/anti_fraud/text</a></li>
<li>完整文档（可不看）：<a href="https://idreamsky.feishu.cn/space/file/boxcnGwXbhN7nQ5OitjClpl2srg">https://idreamsky.feishu.cn/space/file/boxcnGwXbhN7nQ5OitjClpl2srg</a></li>
<li>请求方式：POST</li>
<li>请求参数：</li>
</ul>
<table class="relative-table wrapped confluenceTable"><colgroup><col style="width: 10.7226%;" /><col style="width: 13.8695%;" /><col style="width: 7.22611%;" /><col style="width: 10.373%;" /><col style="width: 57.8089%;" /></colgroup><thead><tr><th class="confluenceTh"><p>参数名称</p></th><th class="confluenceTh" colspan="1">二级参数</th><th class="confluenceTh"><p>类型</p></th><th class="confluenceTh" colspan="1"><p>是否必选</p></th><th class="confluenceTh"><p>说明</p></th></tr></thead><tbody><tr><td class="confluenceTd" colspan="1"><p>accessKey</p></td><td class="confluenceTd" colspan="1"><br /></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>权限认证的key，<span style="color: #003366;">此值为固定值：</span> <span style="color: #003366;">5a2VHw5BBAyM0oJGNLzT</span></p></td></tr><tr><td class="confluenceTd" colspan="1"><p>type</p></td><td class="confluenceTd" colspan="1"><br /></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>平台业务类型， 填写 GAME 这个值即可</p></td></tr><tr><td class="confluenceTd" colspan="1">appId</td><td class="confluenceTd" colspan="1"><br /></td><td class="confluenceTd" colspan="1">String</td><td class="confluenceTd" colspan="1">Y</td><td class="confluenceTd" colspan="1">应用标识，需要找BP提供</td></tr><tr><td class="confluenceTd" colspan="1"><p>data</p></td><td class="confluenceTd" colspan="1"><br /></td><td class="confluenceTd" colspan="1"><p>Object</p></td><td class="confluenceTd" colspan="1"><p><span>Y</span></p></td><td class="confluenceTd" colspan="1"><p>数组，请求内容，最长1MB</p></td></tr><tr><td class="confluenceTd" colspan="1"><p><br /></p></td><td class="confluenceTd" colspan="1"><span>text</span></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>内容</p></td></tr><tr><td class="confluenceTd" colspan="1"><p><br /></p></td><td class="confluenceTd" colspan="1"><span>tokenId</span></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>用户唯一标识，如：sdk的uid、player_id和游戏的用户id</p></td></tr><tr><td class="confluenceTd" colspan="1"><p><br /></p></td><td class="confluenceTd" colspan="1"><span>ip</span></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>用户ip地址</p></td></tr><tr><td class="confluenceTd" colspan="1"><p><br /></p></td><td class="confluenceTd" colspan="1"><span>channel</span></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>渠道类型，COMMENT适配大多情况<br />NICKNAME：昵称<br />GROUP_CHAT：群聊<br />ARTICLE：文章<br />DYNAMIC：动态<br />COMMENT：评论<br />TITLE：标题<br />THEME：主题/话题<br />PRODUCT：商品描述<br />MESSAGE：私聊<br />BARRAGE：弹幕</p></td></tr></tbody></table>
<ul>
<li>请求示例</li>
</ul>
<pre><code class="language-json">{
"accessKey":"5a2VHw5BBAyM0oJGNLzT",
"type":"GAME",
"appId":"default",
"data": {
"text":"sb1111",
"tokenId":"123456",
"ip":"192.168.1.1",
"channel":"COMMENT"
}
}</code></pre>
<ul>
<li>返回数据说明：</li>
</ul>
<table class="relative-table wrapped confluenceTable"><colgroup><col style="width: 15.3471%;" /><col style="width: 7.55177%;" /><col style="width: 13.0329%;" /><col style="width: 64.0682%;" /></colgroup><thead><tr><th class="confluenceTh"><p>参数名称</p></th><th class="confluenceTh"><p>类型</p></th><th class="confluenceTh" colspan="1"><p>是否必选</p></th><th class="confluenceTh"><p>说明</p></th></tr></thead><tbody><tr><td class="confluenceTd" colspan="1"><p>code</p></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>返回码，code 等于 1100，riskLevel 等于 <span>REJECT 时为敏感，否则为不敏感</span></p><p>1100：成功</p><p>1902：参数不合法</p><p>1903：服务失败</p><p>9100：余额不足</p><p>9101：无权限操作</p></td></tr><tr><td class="confluenceTd" colspan="1"><p>message</p></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>N</p></td><td class="confluenceTd" colspan="1"><p>返回消息</p></td></tr><tr><td class="confluenceTd" colspan="1"><p>requestId</p></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>N</p></td><td class="confluenceTd" colspan="1"><p>请求唯一标识</p></td></tr><tr><td class="confluenceTd" colspan="1"><p>riskLevel</p></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>风险级别，为<span>REJECT时必须拦截</span></p><p>PASS：正常内容</p><p>REVIEW：可疑内容，可不处理</p><p>REJECT：违规内容，直接拦截</p></td></tr><tr><td class="confluenceTd"><p>score</p></td><td class="confluenceTd"><p>String</p></td><td class="confluenceTd"><p>N</p></td><td class="confluenceTd"><p>风险分数，最大1000，分数越高风险越大</p></td></tr><tr><td class="confluenceTd" colspan="1"><p>detail</p></td><td class="confluenceTd" colspan="1"><p>Object</p></td><td class="confluenceTd" colspan="1"><p>N</p></td><td class="confluenceTd" colspan="1"><p>数组，风险详情</p><p><span>description：<span>风险原因描述</span></span></p><p><span>filteredText：<span>敏感词替换成*后的文本</span></span></p><p><span>riskType：<span>标识风险类型：0=正常、100=●●、110=小语种、200=色情、210=辱骂、300=广告、400=灌水、500=无意义、700=黑名单、710=白名单、800=高位账号、900=自定义</span></span></p></td></tr><tr><td class="confluenceTd" colspan="1"><p>status</p></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>N</p></td><td class="confluenceTd" colspan="1"><p>服务是否超时</p><p>0：正常</p><p>501：超时</p></td></tr></tbody></table>
<ul>
<li>返回示例：</li>
</ul>
<pre><code class="language-json">{
"code": 1100,
"message": "成功",
"requestId": "fd337a7313f30925810498558f54bc27",
"score": 998,
"riskLevel": "REJECT",
"detail": "{\"description\":\"色情内容\",\"filteredText\":\"**1111\",\"hitPosition\":\"0,1\",\"matchedField\":\"text\",\"matchedItem\":\"SB,sb\",\"matchedList\":\"英文切词黑名单\",\"model\":\"M1020_20\",\"riskType\":200}",
"status": 0
}</code></pre>
<ul>
<li>判断Demo：</li>
</ul>
<pre><code class="language-php">if ( code == 1100 && riskLevel == 'REJECT') {
return "属于敏感内容";
}</code></pre>
<h2>图片过滤</h2>
<ul>
<li>请求URL：<a href="http://goonie-img.uu.cc/v2/saas/anti_fraud/img">http://goonie-img.uu.cc/v2/saas/anti_fraud/img</a></li>
<li>完整文档（可不看）：<a href="https://idreamsky.feishu.cn/space/file/boxcnygOngkCP3frsooIXuX6CDd">https://idreamsky.feishu.cn/space/file/boxcnygOngkCP3frsooIXuX6CDd</a></li>
<li>请求方式：POST</li>
<li>请求参数：</li>
</ul>
<table class="relative-table wrapped confluenceTable"><colgroup><col style="width: 0.0px;" /><col style="width: 0.0px;" /><col style="width: 0.0px;" /><col style="width: 0.0px;" /><col style="width: 0.0px;" /></colgroup><thead><tr><th class="confluenceTh"><p>参数名称</p></th><th class="confluenceTh" colspan="1">二级参数</th><th class="confluenceTh"><p>类型</p></th><th class="confluenceTh" colspan="1"><p>是否必选</p></th><th class="confluenceTh"><p>说明</p></th></tr></thead><tbody><tr><td class="confluenceTd" colspan="1"><p>accessKey</p></td><td class="confluenceTd" colspan="1"><br /></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>权限认证的key，<span style="color: #003366;">此值为固定值： </span> <span style="color: #003366;">5a2VHw5BBAyM0oJGNLzT</span></p></td></tr><tr><td class="confluenceTd" colspan="1"><p>type</p></td><td class="confluenceTd" colspan="1"><br /></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>平台业务类型，默认：GAME 游戏</p></td></tr><tr><td class="confluenceTd" colspan="1">appId</td><td class="confluenceTd" colspan="1"><br /></td><td class="confluenceTd" colspan="1">String</td><td class="confluenceTd" colspan="1">Y</td><td class="confluenceTd" colspan="1">应用标识，需要找BP提供</td></tr><tr><td class="confluenceTd" colspan="1"><p>data</p></td><td class="confluenceTd" colspan="1"><br /></td><td class="confluenceTd" colspan="1"><p>Object</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>数组，请求内容，最长1MB</p></td></tr><tr><td class="confluenceTd" colspan="1"><p><br /></p></td><td class="confluenceTd" colspan="1">img</td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>要检测的图片，可使用base64编码或者图片的url链</p><p>支持格式： jpg，jpeg，jp2，png，webp， gif，bmp ，tiff，tif，dib，ppm ，pgm ，pbm ，hdr，pic<br />建议图片像素不小于 256*256，图片不请求会影响识别</p><p>图片大小不超过10MB</p></td></tr><tr><td class="confluenceTd" colspan="1"><p><br /></p></td><td class="confluenceTd" colspan="1">tokenId</td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>用户唯一标识，如：sdk的uid、player_id和游戏的用户id</p></td></tr><tr><td class="confluenceTd" colspan="1"><p><br /></p></td><td class="confluenceTd" colspan="1">ip</td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>用户ip</p></td></tr><tr><td class="confluenceTd" colspan="1"><p><br /></p></td><td class="confluenceTd" colspan="1">channel</td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>渠道类型</p><p>HEAD_IMG：用户头像<br />IMGS：用户相册<br />DYNAMIC：社交平台的动态配图<br />ARTICLE：博客、文章中的配图<br />COMMENT：评论里面的配图<br />COVER：封面图片</p></td></tr></tbody></table>
<ul>
<li>请求示例例（Json）：</li>
</ul>
<pre><code class="language-json">{
"accessKey":"5a2VHw5BBAyM0oJGNLzT",
"type":"DEFAULT",
"appId":"default",
"data":{
"img":"https://ss3.bdstatic.com/70cFv8Sh_Q1YnxGkpoWK1HF6hhy/it/u=3523651091,31350478&fm=26&gp=0.jpg",
"tokenId":"123456",
"ip":"192.168.1.1",
"channel":"COVER"
}
}</code></pre>
<ul>
<li>返回数据说明：</li>
</ul>
<table class="relative-table wrapped confluenceTable active-resizable"><colgroup><col style="width: 0.0px;" /><col style="width: 0.0px;" /><col style="width: 0.0px;" /><col style="width: 0.0px;" /></colgroup><thead><tr><th class="confluenceTh"><p>参数名称</p></th><th class="confluenceTh"><p>类型</p></th><th class="confluenceTh" colspan="1"><p>是否必选</p></th><th class="confluenceTh"><p>说明</p></th></tr></thead><tbody><tr><td class="confluenceTd" colspan="1"><p>code</p></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>返回码，code 等于 1100，riskLevel 等于 REJECT 时为敏感，否则为不敏感</p><p>1100：成功</p><p>1902：参数不合法</p><p>1903：服务失败</p><p>9100：余额不足</p><p>9101：无权限操作</p></td></tr><tr><td class="confluenceTd" colspan="1"><p>message</p></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>N</p></td><td class="confluenceTd" colspan="1"><p>返回消息</p></td></tr><tr><td class="confluenceTd" colspan="1"><p>requestId</p></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>N</p></td><td class="confluenceTd" colspan="1"><p>请求唯一标识</p></td></tr><tr><td class="confluenceTd" colspan="1"><p>riskLevel</p></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>Y</p></td><td class="confluenceTd" colspan="1"><p>风险级别，为REJECT时必须拦截</p><p>PASS：正常内容</p><p>REVIEW：可疑内容，可不处理</p><p>REJECT：违规内容，直接拦截</p></td></tr><tr><td class="confluenceTd"><p>score</p></td><td class="confluenceTd"><p>String</p></td><td class="confluenceTd"><p>N</p></td><td class="confluenceTd"><p>风险分数，最大1000，分数越高风险越大</p></td></tr><tr><td class="confluenceTd" colspan="1"><p>detail</p></td><td class="confluenceTd" colspan="1"><p>Object</p></td><td class="confluenceTd" colspan="1"><p>N</p></td><td class="confluenceTd" colspan="1"><p>数组，风险详情</p><p>description：风险原因描述</p><p><span>riskType：<span>标识风险类型：0=正常、100=●●、200=色情、210=性感、300=广告、310=二维码、320=水印、400=暴恐、500=违规、700=黑名单、710=白名单、800=高位账号、900=自定义</span></span></p></td></tr><tr><td class="confluenceTd" colspan="1"><p>status</p></td><td class="confluenceTd" colspan="1"><p>String</p></td><td class="confluenceTd" colspan="1"><p>N</p></td><td class="confluenceTd" colspan="1"><p>服务是否超时</p><p>0：正常</p><p>501：超时</p></td></tr></tbody></table>
<ul>
<li>返回示例：</li>
</ul>
<pre><code class="language-json">{
"code": 1100,
"message": "成功",
"requestId": "217210a9634c85d8358a5f0e82d648ca",
"taskId": "a839f112-938a8ddf-8a86d388-f12c2de9",
"score": 500,
"riskLevel": "REJECT",
"detail": {
"description": "性感图片",
"hits": [
{
"description": "性感图片",
"model": "M04302",
"riskLevel": "REJECT",
"score": 500
}
],
"model": "M04302",
"riskType": 210
},
"status": 0
}</code></pre>
<ul>
<li>判断Demo：</li>
</ul>
<pre><code class="language-php">if ( code == 1100 && riskLevel == 'REJECT') {
return "属于敏感内容";
}</code></pre>
<h2>FAQ</h2>
<p>1、文本过滤时，text参数值为json怎么办？
答：如果为json的时候必须要转义，不然接口会报错。（服务供应商不推荐传值json）</p>