设置群组信息之后的回调
功能说明
App 业务服务端可以通过该回调实时查看群资料的变更,包括:通知 App 后台成员入群,包括对变动群组资料的实时记录(例如记录日志,或者同步到其他系统)。
注意事项
- 为启用回调,必须配置回调 URL,并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
- 回调的方向是 OpenIMServer 向 App 后台发起 HTTP/HTTPS POST 请求。
- APP 业务服务端需在超时时间内响应此请求。
可能触发该回调的场景
- App 用户通过客户端请求修改群组资料。
- App 管理员通过 REST API 变动群组资料。
回调发生时机
- OpenIMServer 完成修改群组信息的操作后。
接口说明
请求 URL 示例
此处CallbackCommand
为:callbackAfterSetGroupInfoExCommand
{WEBHOOK_ADDRESS}/callbackAfterSetGroupInfoExCommand?contenttype=json
请求包示例
{
"callbackCommand": "callbackAfterSetGroupInfoExCommand",
"operationID": "1646445464564",
"groupID": "G002",
"groupName": {
"value": "NewGroupName"
},
"notification": {
"value": "Updated group notification"
},
"introduction": {
"value": "Updated group introduction"
},
"faceURL": {
"value": "http://example.com/new/path/to/face/image.png"
},
"ex": {
"value": "Updated extra data"
},
"needVerification": {
"value": 0
},
"lookMemberInfo": {
"value": 1
},
"applyMemberFriend": {
"value": 0
}
}
请求包字段说明
字段 | 类型 | 描述 |
---|---|---|
callbackCommand | string | 回调命令,这里为设置群组信息之后的回调 |
operationID | string | 用于全局链路追踪,建议使用时间戳,在每个请求中独立 |
groupID | string | 群组的唯一标识符 |
groupName | string | 群组的名称 |
notification | string | 群组的通知信息 |
introduction | string | 群组的简介 |
faceURL | string | 群组的图标的URL |
ex | *string | 额外的数据字段 |
needVerification | *int32 | 是否需要验证加入群组 |
lookMemberInfo | *int32 | 是否可以查看群成员信息 |
applyMemberFriend | *int32 | 是否可以申请加群成员为好友 |
应答包示例
操作完成
确认群组信息修改操作已完成。
{
"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 时设置。 |