跳到主要内容

解散群组后回调

功能说明

App 业务服务端可以通过该回调获取群组解散的信息,包括:对群组的解散实时记录(例如记录日志,或者同步到其他系统)。

注意事项

  • 为启用回调,必须配置回调 URL,并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
  • 回调的方向是 OpenIM Server 向 App 后台发起 HTTP/HTTPS POST 请求。
  • APP 业务服务端需在超时时间内响应此请求。

可能触发该回调的场景

  • App 用户通过客户端解散群组。
  • App 管理员通过 REST API 解散群组。

回调发生时机

  • 群组解散后。

接口说明

请求 URL 示例

此处CallbackCommand为:callbackAfterDisMissGroupCommand

{WEBHOOK_ADDRESS}/callbackAfterDisMissGroupCommand?contenttype=json

请求包示例

{
"callbackCommand": "callbackAfterDisMissGroupCommand",
"groupID": "G001",
"groupType": 2,
"ownerID": "user123",
"membersID": ["user456", "user789"]
}

请求包字段说明

对象类型描述
callbackCommandstring回调命令,这里是群组解散后的回调
groupIDstring群组的唯一标识符
groupTypeint32群类型,固定为2。
ownerIDstring群主ID
membersIDarray群组成员的列表,包括用户ID,表示解散时群组中的成员

应答包示例

处理结果

App 后台记录群解散信息后,发送回调应答包。

{
"actionCode": 0,
"errCode": 0,
"errMsg": "",
"errDlt": "",
"nextCode": 1
}

应答包字段说明

字段说明
actionCode0表示业务系统的回调是否正确执行。0表示操作成功。
errCode0表示自定义错误码,此处填0代表忽略回调结果。
errMsg"An error message"自定义错误码对应的简单错误信息。
errDlt"Detailed error information"自定义错误码对应的详细错误信息。
nextCode1下一步执行指令,1表示拒绝继续执行,actionCode等于0时设置。