转让群主之后的回调
功能说明
App 业务服务端可以通过该回调获取群组所有权转移的信息,同时业务服务端可以对转移后的群组进行后续处理或记录。
注意事项
- 为启用回调,必须配置回调 URL,并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
- 回调的方向是 OpenIMServer 向 App 后台发起 HTTP/HTTPS POST 请求。
- APP 业务服务端需在超时时间内响应此请求。
可能触发该回调的场景
- App 用户或管理员通过客户端或 API 接口转移群组所有权。
回调发生时机
- OpenIMServer 在群组所有权成功转移之后。
接口说明
请求 URL 示例
此处CallbackCommand
为:callbackAfterTransferGroupOwnerCommand
{WEBHOOK_ADDRESS}/callbackAfterTransferGroupOwnerCommand?contenttype=json
请求包示例
{
"callbackCommand": "callbackAfterTransferGroupOwnerCommand",
"groupID": "G12345",
"oldOwnerUserID": "userOld123",
"newOwnerUserID": "userNew456"
}
请求包字段说明
字段 | 类型 | 描述 |
---|---|---|
callbackCommand | string | 回调命令,这里是转移群组所有权之后的回调 |
groupID | string | 群组的唯一标识符 |
oldOwnerUserID | string | 原群主的用户ID |
newOwnerUserID | string | 新群主的用户ID |
应答包示例
处理成功
表示业务系统成功处理了群组所有权转移的回调。
{
"actionCode": 0,
"errCode": 0,
"errMsg": "",
"errDlt": "",
"nextCode": 0
}
处理失败
表示业务系统无法处理该回调,提供错误信息。
{
"actionCode": 1,
"errCode": 5002,
"errMsg": "Unable to process the request",
"errDlt": "The group ownership transfer cannot be processed due to internal policy",
"nextCode": 1
}
应答包字段说明
字段 | 值 | 说明 |
---|---|---|
actionCode | 0 | 表示业务系统的回调是否正确执行。0 表示操作成功。 |
errCode | 0 | 表示自定义错误码,此处填0代表忽略回调结果。 |
errMsg | "An error message" | 自定义错误码对应的简单错误信息。 |
errDlt | "Detailed error information" | 自定义错误码对应的详细错误信息。 |
nextCode | 1 | 下一步执行指令,1 表示拒绝继续执行,actionCode等于0 时设置。 |