解散话题之后回调

最近更新时间:2022-11-07 14:52:46

我的收藏

功能说明

App 后台可以通过该回调实时查看话题的解散动态,包括:对话题的解散实时记录(例如记录日志,或者同步到其他系统)。

注意事项

要启用回调,必须配置 URL,本条回调协议和群组解散之后回调协议的控制台开关为同一个,配置方法详见 第三方回调配置 文档。
回调的方向是即时通信 IM 后台向 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
回调 URL
SdkAppid
创建应用时在即时通信 IM 控制台分配的 SDKAppID
CallbackCommand
固定为:Group.CallbackAfterTopicDestroyed
contenttype
固定值为 JSON
ClientIP
客户端 IP,格式如:127.0.0.1
OptPlatform
客户端平台,取值参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义

请求包示例

{
"CallbackCommand": "Group.CallbackAfterTopicDestroyed", // 回调命令
"GroupId": "@TGS#_@TGS#cQVLVHIM62CJ", // 解散的话题所在的群组ID
"Type": "Community", // 群组类型
"TopicIdList":[ // 被解散话题的列表
"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic",
"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic_1"
]
}

请求包字段说明

对象
介绍
功能
CallbackCommand
String
回调命令
GroupId
String
解散的话题所在的群组
Type
String
代表解散话题所属的群组类型,这里为Community
TopicIdList
String
被解散话题的列表

应答包示例

App 后台记录话题解散信息后,发送回调应答包。
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}

应答包字段说明

字段
类型
属性
说明
ActionStatus
String
必填
请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode
Integer
必填
错误码,建议设置为0,该回调用于群解散后通知用户,用户的错误码值不影响群解散的正常流程
ErrorInfo
String
必填
错误信息

参考

REST API:解散话题