审核结果回调
在控制台的 IM & 音视频审核 页面开通 IM 审核服务后,可使用审核结果回调,实时接收审核结果详情。
提示
该回调服务仅返回 IM & 音视频审核 的审核结果。
配置审核结果回调地址
请在控制台的IM & 音视频审核页面配置回调地址。配置后 30 分钟内生效。请确保公网可访问您提供的回调接收地址。
回调方法
请求方法: POST
数据格式: application/json
即时通讯服务端会在 POST 请求头部添加签名参数,您可通过签名验证调用者身份,并确保数据有效性,详见 服务端回调签名。
回调正文参数
该回调服务的 HTTP 请求正文数据格式为 application/json
,包含具有以下结构的 JSON 对象:
名称 | 类型 | 说明 |
---|---|---|
result | Int | 返回审核是否通过。10000 为审核通过;10001 为审核不通过。审核结果详情在 resultDetail 字段中返回。 |
content | String | 返回审核的消息内容,详见下方 content 结构说明。 |
msgUID | String | 消息 ID。 |
serviceProvider | String | 审核渠道商标识。 |
resultDetail | String | 审核结果详情,直接返回审核服务商的审核结果 JSON 结构响应体,详见下方 resultDetail 说明。 |
-
content
结构说明:名称 类型 说明 appKey String appkey fromUserId String 发送者 ID targetId String 接收者 ID toUserIds String 群成员 ID 列表(以英文逗号分隔)。发送群聊定向消息时,接收消息的群成员用户 ID 列表。非群定向消息时为空。 conversationType String 会话类型。支持的会话类型包括: PERSON
(二人会话)、GROUP
(群组会话)、TEMPGROUP
(聊天室会话)、ULTRAGROUP
(超级群会话)。objectName String 消息类型。一般包括: RC:TxtMsg
(文本消息 )、RC:ImgMsg
(图片消息)、RC:VcMsg
(语音消息)、RC:HQVCMsg
(高清语音消息)、RC:SightMsg
(小视频消息)。message String 消息体内容,详细查看消息结构文档。 extraContent Object 消息扩展的内容,JSON 结构的 Key、Value 对,如: {"type":"3"}
。Key 最大 32 个字符,支持大小写英文字母、数字、 特殊字符+ = - _
的组合方式,不支持汉字。Value 最大 4096 个字符。clientOs String 客户端类型,包括:iOS、Android、Websocket、MiniProgram(小程序)、PC、Server(通过 Server API 发送,需要开通 Server API 发送消息进行消息路由功能)。 messageTime long 服务端收到客户端发送消息时的服务器时间,精确到毫秒 messageId String 消息 ID -
resultDetail
说明:直接返回审核服务商的审核结果响应体。-
如果您在控制台选择的审核服务商为数美,
resultDetail
中为数美审核的返回结果,详细结构说明请参见以下数美文档。注意,文本和图片审核返回的是单条同步请求的响应体,音频和视频审核返回的是单条异步的响应体。数美返回的审核结果响应体中的riskLabel1
中携带了审核不通过的具体原因。
-
回调请求示例
以下示例您在开通服务页面配置的接收地址为 http://example.com/review_result.php
POST review_result.php HTTP/1.1
Host: example.com
RC-App-Key: uwd1c0sxdlx2
RC-Timestamp: 1408710653491
RC-Nonce: 14314
RC-Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json
{
"result":10000,
"content":“{****}”,//审核的消息结构 JSON
"serviceProvider":"ShuMei",
"msgUID":"596E-P5PG-4FS2-7OJK",
"resultDetail":"{****}";//审核结果详细 JSON 结构
}
响应回调请求
提示
- 只要有 HTTP
200 OK
成功响应,服务端会认为状态已经同步。 - 如果应答超时 5 秒,服务端会再尝试推送 3 次,如果仍然失败,即时通讯服务默认将下发此条消息。
- 如短时间内有大面积超时,将暂时停止请求您的服务器,90 秒后会继续发送回调请求。异常断网情况下的会延迟 5 分钟同步。