- 动态与公告
- 产品简介
- 购买指南
- 体验 Demo
- 下载中心
- 快速入门
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 客服场景
- 智能机器人
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
- 动态与公告
- 产品简介
- 购买指南
- 体验 Demo
- 下载中心
- 快速入门
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 客服场景
- 智能机器人
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
功能说明
App 后台可以通过该回调实时查看群成员加入的消息，包括：通知 App 后台有成员入群，App 可以据此进行必要的数据同步。
注意事项
要启用回调，必须配置回调 URL，并打开本条回调协议对应的开关，配置方法详见 第三方回调配置 文档。
回调的方向是即时通信 IM 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后，务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
其他安全相关事宜请参考 第三方回调简介：安全考虑 文档。
可能触发该回调的场景
App 用户通过客户端主动申请加群并得到通过。
App 用户通过客户端拉其他人入群成功。
App 管理员通过 REST API 添加用户到群组。
回调发生时机
用户主动申请并成功加入群组之后。
用户被其他成员邀请并成功加入群组之后。
用户被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 |
www.example.com | 回调 URL |
SdkAppid | 创建应用时在即时通信 IM 控制台分配的 SDKAppID |
CallbackCommand | 固定为 Group.CallbackAfterNewMemberJoin |
contenttype | 固定值为 JSON |
ClientIP | 客户端 IP，格式如：127.0.0.1 |
OptPlatform |
请求包示例
{"CallbackCommand": "Group.CallbackAfterNewMemberJoin", // 回调命令"GroupId" : "@TGS#2J4SZEAEL","Type": "Public", // 群组类型"JoinType": "Apply", // 入群方式：Apply（申请入群）；Invited（邀请入群）"Operator_Account": "leckie", // 操作者成员"NewMemberList": [ // 新入群成员列表{"Member_Account": "jared"},{"Member_Account": "tommy"}],"EventTime":"1670574414123"//毫秒级别，事件触发时间戳}
请求包字段说明
字段 | 类型 | 说明 |
CallbackCommand | String | 回调命令 |
GroupId | String | 要将其他用户拉入的群组 ID |
Type | String | |
JoinType | String | 入群方式：Apply（申请入群）；Invited（邀请入群） |
Operator_Account | String | 请求的操作者 UserID |
NewMemberList | Array | 新入群成员 UserID 集合 |
EventTime | Integer | 事件触发的毫秒级别时间戳 |
应答包示例
App 后台同步数据后，返回应答包。
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // 忽略应答结果}
应答包字段说明
字段 | 类型 | 属性 | 说明 |
ActionStatus | String | 必填 | 请求处理的结果，OK 表示处理成功，FAIL 表示失败 |
ErrorCode | Integer | 必填 | 错误码，0表示允许忽略应答结果 |
ErrorInfo | String | 必填 | 错误信息 |
参考
REST API：增加群组成员
是
否
本页内容是否解决了您的问题？