文本识别接口

最近更新时间:2018-09-28 16:38:19

接口描述

用来识别用户产生的文本内容中是否含有政治、色情、广告、恶意竞争等关键词,并进一步根据用户行为判断行为是否存在恶意倾向的接口。

协议:HTTP/HTTPS

域名:csec.api.qcloud.com

接口名:ContentSecurity.Text.AntiSpam

请求参数

注意:
以下每一个参数对于识别恶意都非常重要,缺少任何参数都有可能影响识别效果 。

API 公共字段:

参数名称 类型 描述
Action String 具体操作的指令接口名称,此处 Action 参数为 ContentSecurity.Text.AntiSpam
Region String 地域参数,用来标识希望操作哪个地域的实例。具体可参见 《地域和可用区列表》
Timestamp Uint 当前 UNIX 时间戳,可记录发起 API 请求的时间
Nonce Uint 随机正整数,与 Timestamp 联合起来, 用于防止重放攻击
SecretId String 在云 API 密钥 上申请的标识身份的 SecretId,一个 SecretId 对应唯一的 SecretKey , 而 SecretKey 会用来生成请求签名 Signature。具体可参考 《签名方法》
Signature String 请求签名,用来验证此次请求的合法性,需要用户根据实际的输入参数计算得出。计算方法可参考 《签名方法》

基本字段:

参数名称 是否必须 类型 描述
accountType 必选 UInt 用户账号类型
0:其他账号
1:QQ 开放帐号
2:微信开放帐号
4:手机账号
6:手机动态码
7:邮箱账号
appId 可选 String 表示 QQ 或微信分配给网站或应用的用来唯一标识网站或应用的参数,当 accountType 是 QQ 或微信开放账号时,该参数必填
uid 必选 String 用户ID,不同的 accountType 对应不同的用户ID。如果是 QQ 或微信用户则填入对应的 OpenID
associateAccount 可选 String 当 accountType 是 QQ 或微信开放账号时,associateAccount 是用于标识 QQ 或微信用户登录后关联业务自身的账号 ID
toAccountType 可选 UInt 接收者的账号类型,同 accountType 相类似
toUid 可选 String 接收者的 ID,同 uid 相类似
relationship 可选 UInt 1:C2C 好友
2:C2C 非好友
3:群组
4:公开
5:B2C
6:C2B
messageStruct 必选 String 用户产生的内容,详情请参见下方的 消息结构体介绍
messageId 可选 String 用户产生内容的 ID。如果传入此 ID,则可以通过恶意结果查询接口获取进一步的信息
postIp 必选 String 操作来源的外网 IP
postTime 可选 UInt 用户内容产生时间戳,单位秒
nickName 可选 String 昵称,UTF-8 编码
phoneNumber 可选 String 手机号
国家代码-手机号,如0086 - 15912345687
注意: 0086 前不需要 +
emailAddress 可选 String 用户邮箱地址(非系统自动生成)
registerTime 可选 UInt 注册时间戳,单位秒
registerIp 可选 String 注册来源的外网 IP
loginSource 可选 Int 登录来源
0:其他
1:PC 网页
2:移动页面
3:App
4:微信公众号
loginType 可选 Int 登录方式
0:其他
1:手动帐号密码输入
2:动态短信密码登录
3:二维码扫描登录
macAddress 可选 String MAC 地址或设备唯一标识
vendorId 可选 String 手机制造商 ID,如果手机注册,请带上此信息
imei 可选 String 手机设备号
businessId 可选 UInt 业务 ID,网站或应用在多个业务中使用此服务时,通过此 ID 区分统计数据
sceneId 可选 UInt 场景 ID,网站或应用的业务下有多个场景使用此服务时,通过此 ID 区分统计数据

响应参数

参数名称 类型 描述
postIp String 同请求参数
postTime String 同请求参数
messageId String 同请求参数
uid String 同请求参数
associateAccount String 同请求参数
level Int 恶意等级
0:无恶意
1~4:恶意等级由低到高
type Int 系统命中关键词类别
0:其他
1:广告
2:色情
3:敏感
4:灌水
5:跨站追杀
6:个性
selfType Int 用户自定义关键词分类
beatTips String 打击原因,如命中的关键词


消息结构体介绍

消息结构体用于存储用户输入的文本、图片、视频和系统表情等内容,使用 TLV 格式存储,其中 Type 是 4 个字节,Length 是 4 个字节,Value 的值通过 Length 指定,Type 和 Length 都是网络字节序,其中所有的中文字符均为 UTF-8 编码。目前支持的
Type 类型如下:

类型 说明
1 文本 字符串内容,使用 UTF-8 编码
2 图片超链接 如果无法提供超链接,通过 Length=0 表示存在图片
3 视频超链接 如果无法提供超链接,通过 Length=0 表示存在视频
4 音频超链接 如果无法提供超链接,通过 Length=0 表示存在音频
5 网站超链接 如果无法提供超链接,通过 Length=0 表示存在网站
6 系统表情 无需传入系统表情编码,通过 Length=0 表示存在系统表情
7 文章标题 字符串内容,使用 UTF-8 编码
8 位置 无需传入位置,通过 Length=0 表示存在位置
9 第三方自定义 无需传入第三方内容,通过 Length=0 表示存在第三方内容
10 文件 无需传入文件,通过 Length=0 表示存在文件
1000 其他 无需传入其他内容,通过 Length=0 表示存在其他内容

请求示例

1. http://csec.api.qcloud.com/v2/index.php?Action=ContentSecurity.Text.AntiSpam
2. &accountType=1
3. &appId=100273020
4. &uid=00000000000000000000000033121475
5. &associateAccount=SpFsjpyvaJ27329
6. &nickName=%E6%B5%8B%E8%AF%95%E6%98%B5%E7%A7%B0
7. &phoneNumber=0086-186659115142
8. &emailAddress=testaccount@qq.com
9. &registerTime=1436665734
10. &registerIp=8.8.8.8
11. &loginSource=1
12. &loginType=1
13. &loginIp=8.8.8.8
14. &loginTime=1436674734
15. &postTime=1436675734
16. &passwordHash=f158abb2a762f7919846ee9bf8445c7f22a244c5
17. &referer=https%3A//ui.ptlogin2.qq.com/cgi-bin/login%3Fdaid%3D164%26target
18. %3Dself%26style%3D16%26mibao_css%3Dm_webqq%26appId%3D501004106%2
19. 6enable_qlogin%3D0%26no_verifyimg%3D1%26s_url%3Dhttp%253A%252F%252F
20. w.qq.com%252Fproxy.html%26f_url%3Dloginerroralert%26strong_login%3D1%26l
21. ogin_state%3D10%26t%3D20131024001
22. &jumUrl=web.qq.com
23. &cookieHash=0cc62d098effb4dd6c7835a28740f4542d190bdd
24. &userAgent=Mozilla/5.0%20%28Windows%20NT%205.1%29%20AppleWebKit/53
25. 7.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome/43.0.2357.132%20Safa
26. ri/537.36&mouseClickCount=10&keyboardClickCount=50&messageStruct=AAAA
27. AQAAAELmtYvor5Xlj5HluJbvvIzmnInkurrmiZPlh7vkuYjvvJ/og7bmsLTvvIzkvaDmmK
28. /ms5Xova7lip/niLHlpb3ogIUAAAADAAAAQWh0dHA6Ly9pbWcuemNvb2wuY24vY
29. 29tbXVuaXR5LzAzMzIwZGQ1NTRjNzVjNzAwMDAwMTU4ZmNlMTcyMDkuanBn
30. &messageId=UEBWM19590jbWPo19592
31. &macAddress=00-05-9A-3C-7A-00
32. &COMMON_PARAMS

响应示例

1. {
2. "code": 0,
3. "message": "No Error",
4. "level": 0,
5. "messageId":"UEBWM19590jbWPo19592",
6. "postTime": 1436675734,
7. "uid": "00000000000000000000000033121475",
8. "associateAccount": "SpFsjpyvaJ27329"
9. }