群组满员之后回调

最近更新时间:2019-08-02 18:55:06

功能说明

App 后台可以通过该回调实时监控群组满员的动态,包括:删除一部分不活跃的群成员,以确保用户能够加入该群。

注意事项

  • 要启用回调,必须配置回调 URL,并打开本条回调协议对应的开关,配置方法详见 第三方回调配置 文档。
  • 回调的方向是即时通信 IM 后台向 App 后台发起 HTTP POST 请求。
  • App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
  • 其他安全相关事宜请参考 第三方回调简介:安全考虑 文档。

可能触发该回调的场景

  • App 用户通过客户端申请加群。
  • App 用户通过客户端邀请加群。
  • 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.CallbackAfterGroupFull
contenttype 固定值为 JSON
ClientIP 客户端 IP,格式如:127.0.0.1
OptPlatform 客户端平台,取值参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义

请求包示例

{
    "CallbackCommand": "Group.CallbackAfterGroupFull", // 回调命令
    "GroupId": "@TGS#2J4SZEAEL" // 群组 ID
}

请求包字段说明

字段 类型 说明
CallbackCommand String 回调命令
GroupId String 满员的群组 ID

应答包示例

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

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // 忽略应答结果
}

应答包字段说明

字段 类型 属性 说明
ActionStatus String 必填 请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode Integer 必填 错误码,0表示允许忽略应答结果
ErrorInfo String 必填 错误信息

参考