即时通信 IM 创建群组之前回调 - 服务端 API

功能说明

App 后台可以通过该回调实时监控用户创建群组的请求，包括后台可以拒绝用户创建群组的请求。

注意事项

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

可能触发该回调的场景

• App 用户通过客户端创建群组
• App 管理员通过 REST API 创建群组

回调发生时机

即时通信 IM 后台准备创建群组之前。

接口说明

请求 URL 示例

以下示例中 App 配置的回调 URL 为 https://www.example.com。
示例：

https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

请求参数说明

请求包示例

{
  "CallbackCommand": "Group.CallbackBeforeCreateGroup", // 回调命令
  "Operator_Account": "leckie", // 操作者
  "Owner_Account": "leckie", // 群主
  "Type": "Public", // 群组类型
  "Name": "MyFirstGroup", // 群组名称
  "CreatedGroupNum": 123, //该用户已创建的同类的群组个数
  "MemberList": [ // 初始成员列表
      {
          "Member_Account": "bob"
      },
      {
          "Member_Account": "peter"
      }
  ]
}

请求包字段说明

应答包示例

允许创建

允许用户创建群组。

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0 // 允许创建
}

禁止创建

不允许用户创建群组，群组将不会被创建，同时给调用方返回错误码：10016。

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 1 // 拒绝创建
}

应答包字段说明

参考

• 第三方回调简介
• REST API：创建群组