App 后台可以通过该回调实时查看用户创建群组的请求,包括后台可以拒绝用户创建群组的请求。
即时通信 IM 后台准备创建群组之前。
以下示例中 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.CallbackBeforeCreateGroup |
contenttype | 固定值为 JSON |
ClientIP | 客户端 IP,格式如:127.0.0.1 |
OptPlatform | 客户端平台,取值参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义 |
{
"CallbackCommand": "Group.CallbackBeforeCreateGroup", // 回调命令
"Operator_Account": "leckie", // 操作者
"Owner_Account": "leckie", // 群主
"Type": "Public", // 群组类型
"Name": "MyFirstGroup", // 群组名称
"CreateGroupNum": 123, //该用户已创建的同类的群组个数
"MemberList": [ // 初始成员列表
{
"Member_Account": "bob"
},
{
"Member_Account": "peter"
}
],
"EventTime":"1670574414123"//毫秒级别,事件触发时间戳
}
对象 | 介绍 | 功能 |
---|---|---|
CallbackCommand | String | 回调命令 |
Operator_Account | String | 发起创建群组请求的操作者 UserID |
Owner_Account | String | 请求创建的群的群主 UserID |
Type | String | 产生群消息的 群组类型介绍,例如 Public |
Name | String | 请求创建的群组的名称 |
CreateGroupNum | Integer | 该用户已创建的同类的群组个数 |
MemberList | Array | 请求创建的群组的初始化成员列表 |
EventTime | Integer | 事件触发的毫秒级别时间戳 |
允许用户创建群组。
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 // 允许创建
}
不允许用户创建群组,群组将不会被创建,同时给调用方返回错误码:10016
。
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 1 // 拒绝创建
}
字段 | 类型 | 属性 | 说明 |
---|---|---|---|
ActionStatus | String | 必填 | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 必填 | 错误码,0为允许创建;1为拒绝创建,若业务希望使用自己的错误码拒绝用户建群,将错误码 ErrorCode 和 ErrorInfo 传递至客户端,请将错误码 ErrorCode 设置在 [10100, 10200] 区间内 |
ErrorInfo | String | 必填 | 错误信息 |
本页内容是否解决了您的问题?