撤回群消息之后回调

功能说明

App 后台可以通过该回调实时查看用户的群聊消息的撤回动作。

注意事项

要启用回调,必须配置回调 URL,并打开本条回调协议对应的开关,配置方法详见 第三方回调配置 文档。
回调的方向是即时通信 Chat 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
其他安全相关事宜请参考 第三方回调简介:安全考虑 文档。

可能触发该回调的场景

App 用户通过客户端撤回群聊消息。
App 管理员通过 REST API 撤回群聊消息

回调发生时机

群聊消息撤回成功之后。

接口说明

请求 URL 示例

以下示例中 App 配置的回调 URL 为 https://www.example.com示例:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

请求参数说明

参数
说明
https
请求协议为 HTTPS,请求方式为 POST。
www.example.com
回调 URL。
SdkAppid
创建应用时在即时通信 Chat 控制台分配的 SDKAppID。
CallbackCommand
固定为:Group.CallbackAfterRecallMsg。
contenttype
固定值为 json
ClientIP
客户端 IP,格式例如:127.0.0.1。
OptPlatform
客户端平台,取值参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义。

请求包示例

{
"CallbackCommand":"Group.CallbackAfterRecallMsg", // 回调命令
"Operator_Account":"admin", // 操作者
"Type":"Community", // 群组类型
"GroupId":"1213456", // 群组 ID
"MsgSeqList":[ // 撤回消息MsgSeq列表
{
"MsgSeq":130,
"MsgId":"144115213033478435-1739361321-2512805311"
}
],
"TopicId":"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic",// 话题的ID, 仅支持话题的社群适用此选项
"EventTime":"1670574414123"//毫秒级别,事件触发时间戳
}

请求包字段说明

对象
介绍
功能
CallbackCommand
String
回调命令。
Operator_Account
String
撤回群聊消息的操作者 UserID。
Type
String
产生群消息的 群组类型介绍,例如 Public。
GroupId
String
群组 ID。
MsgSeqList
Array
撤回消息列表, 内部含有 MsgId 和 MsgSeq 字段, 分别表示被撤回消息的客户端消息唯一标识和消息 MsgSeq。
TopicId
String
话题的 ID,若具有此选项表示撤回的是话题中的消息,仅支持话题的社群适用此选项。
EventTime
Integer
事件触发的毫秒级别时间戳。

应答包示例

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 // 忽略回调结果
}

应答包字段说明

字段
类型
属性
说明
ActionStatus
String
必填
请求处理的结果,OK 表示处理成功,FAIL 表示失败。
ErrorCode
Integer
必填
错误码,此处填0表示忽略应答结果。
ErrorInfo
String
必填
错误信息。

参考

REST API:撤回群消息