Skip to content

Z
zw_game_sdk
提交 88506c58 作者: yyc
操作

拆分接口文档

上级 d9d304cb
正在显示 包含 76 行增加 和 49 行删除
AI检查敏感词.md 0 → 100644
v1.0
v1.0
## 聊天记录敏感检查接口
检查是否可以发送
### 请求方式
1. POST 数据结构 JSON
2. Header数据需要加验证参数 Authorization
3. Authorization 将请求数据，
a. 按照key ascll 码小到大排序,
b.拼接参数 string = "key1=value1&key2=value2" + secert;
c. 将string 转为32 位的md5数据， stringMd5 = string.md5();
d. 截取stringMd5 第二位到第17位， 一共 16位字符串, 之后转为大写， 为Authorization
#### 1. 掌游AI聊天记录接口
/api/server/chat/chatRickReport
请求数据
| 字段 | 是否必传 | 字段类型 | | |
| ---------------- | -------- | -------- | ----------------------------------------- | ---- |
| zw_app_id | 是 | String | 掌玩appId | |
| cp_role_id | 是 | String | 角色ID | |
| action_time | 是 | dateTime | 发送时间 | |
| context | 是 | String | 聊天内容 | |
| context_type | 是 | String | 文本类型，默认为'chat' 聊天 'nick' 昵称 'post' 帖子 | |
| channel_id | 否 | String | 渠道ID | |
| user_id | 否 | String | 用户ID | |
| ip | 否 | String | IP | |
| room_id | 否 | String | 聊天ID | |
| room_name | 否 | String | 聊天室名 | |
| server_id | 否 | String | 区服ID | |
返回数据
| | 是否必要 | 字段类型 | |
| --------------- | -------- | -------- | ------------------------------------------------------------ |
| code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 处理成功 |
| data | 是 | Object | |
| data.label | 是 | string | 标签 normal: 正常； politics: 政治敏感； terror: 暴恐违禁； porn: 文本色情； ad：恶意推广； curse: 咒骂敌视； nonsense: 刷屏灌水； customize: 用户自定义。 |
| data.suggestion | 是 | String | 是否通过 pass: 通过。 review: 建议人工审核。 block: 文本不合规，建议屏蔽。 |
```shell
请注意：room_id需要传聊天室id，我们需要根据不同的聊天类型设置不同的检测规则，让消息的拦截更智能和精准。
所需的聊天类型：
● 世界：1
● 行会：2
● 系统：3
● 地图：4
● 组队：5
● 跨服：8
● 个人：100
数据传输内容
● 聊天审核：在玩家发送聊天时， 调用审核接口，其中context为聊天内容   context_type设置为 chat
● 昵称审核：在玩家设置昵称或更改昵称时，调用审核接口,  其中context为待审核文本(昵称名), context_type设置为 nick, 昵称审核时若无角色ID(cp_role_id), 则不传cp_role_id字段或传空字符串, 注意不要传0
● 行会公告审核：在玩家设置行会公告时，调用审核接口，其中context为待审核文本(公告内容)， context_type设置为post
● 行会昵称审核：在玩家设置行会昵称时，调用审核接口，其中context为待审核文本(行会昵称名), context_type设置为signature
● 区服审核：当调用审核服务时,  接口传输增加一个字段，字段名为server_id 内容为区服，类型为字符串
返回结果处理
● 接口返回结果中 suggestion 为pass则允许发送该聊天 为block或review均拦截
```
\ No newline at end of file
风控聊天内容接口.md
v1.0
v1.0
......@@ -43,51 +43,3 @@ v1.0
| msg | 是 | string | 返回信息 ： 处理成功 |
## 聊天记录风控接口
接受风控数据
### 请求方式
1. POST 数据结构 JSON
2. Header数据需要加验证参数 Authorization
3. Authorization 将请求数据，
a. 按照key ascll 码小到大排序,
b.拼接参数 string = "key1=value1&key2=value2" + secert;
c. 将string 转为32 位的md5数据， stringMd5 = string.md5();
d. 截取stringMd5 第二位到第17位， 一共 16位字符串, 之后转为大写， 为Authorization
#### 2. 掌游AI聊天记录接口
/api/server/chat/chatRickReport
请求数据
| 字段 | 是否必传 | 字段类型 | | |
| ---------------- | -------- | -------- | ----------------------------------------- | ---- |
| zw_app_id | 是 | String | 掌玩appId | |
| cp_role_id | 是 | String | 角色ID | |
| room_id | 否 | String | 聊天ID | |
| room_name | 否 | String | 聊天室名 | |
| server_id | 是 | String | 区服ID | |
| action_time | 是 | dateTime | 发送时间 | |
| context | 是 | String | 聊天内容 | |
| context_type | 是 | String | 文本类型，默认为'chat' 'nick' 昵称 'post' 帖子 | |
| channel_id | 否 | String | 渠道ID | |
| user_id | 否 | String | 用户ID | |
| ip | 否 | String | 聊天室ID | |
返回数据
| | 是否必要 | 字段类型 | |
| --------------- | -------- | -------- | ------------------------------------------------------------ |
| code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 处理成功 |
| data | 是 | Object | |
| data.label | 是 | string | 标签 normal: 正常； politics: 政治敏感； terror: 暴恐违禁； porn: 文本色情； ad：恶意推广； curse: 咒骂敌视； nonsense: 刷屏灌水； customize: 用户自定义。 |
| data.suggestion | 是 | String | 是否通过 pass: 通过。 review: 建议人工审核。 block: 文本不合规，建议屏蔽。 |
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论