踢除群组成员的回调
功能说明
App 业务服务端可以通过该回调处理群组管理员踢出成员的请求,包括:对用户退群进行实时记录(例如记录日志,或者同步到其他系统)。
注意事项
- 为启用回调,必须配置回调 URL,并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
- 回调的方向是 OpenIMServer 向 App 后台发起 HTTP/HTTPS POST 请求。
- APP 业务服务端需在超时时间内响应此请求。
可能触发该回调的场景
- 群组管理员或拥有者通过客户端尝试踢出某个或某些群组成员。
回调发生时机
- OpenIMServer 收到踢出群组成员的请求之后,处理该请求前。
接口说明
请求 URL 示例
此处CallbackCommand
为:callbackAfterKickGroupCommand
{WEBHOOK_ADDRESS}/callbackAfterKickGroupCommand?contenttype=json
请求包示例
{
"callbackCommand": "callbackAfterKickGroupCommand",
"groupID": "G001",
"kickedUserIDs": ["user123", "user456"],
"reason": "Violation of group rules"
}
请求包字段说明
字段 | 类型 | 描述 |
---|---|---|
callbackCommand | string | 回调命令,这里是踢出群组成员的回调 |
groupID | string | 群组的唯一标识符 |
kickedUserIDs | []string | 被踢出的群组成员的用户ID列表 |
reason | string | 踢出成员的原因 |
应答包示例
允许踢出
允许踢出指定的群组成员。
{
"actionCode": 0,
"errCode": 0,
"errMsg": "",
"errDlt": "",
"nextCode": 0
}
应答包字段说明
字段 | 值 | 说明 |
---|---|---|
actionCode | 0 | 表示业务系统的回调是否正确执行。0 表示操作成功。 |
errCode | 0 | 表示自定义错误码,此处填0代表忽略回调结果。 |
errMsg | "An error message" | 自定义错误码对应的简单错误信息。 |
errDlt | "Detailed error information" | 自定义错误码对应的详细错误信息。 |
nextCode | 1 | 下一步执行指令,1 表示拒绝继续执行,actionCode等于0 时设置。 |