tencent cloud

即时通信 IM

创建群组之后回调

下载
聚焦模式
字号
最后更新时间: 2026-06-04 15:22:10

功能说明

App 后台可以通过该回调实时查看用户创建群组的信息,包括: 通知 App 后台有群组创建成功,App 后台可以据此进行数据同步等操作。

注意事项

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

可能触发该回调的场景

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
创建应用时在即时通信 Chat 控制台分配的 SDKAppID。
CallbackCommand
固定为 Group.CallbackAfterCreateGroup。
contenttype
固定值为 JSON。
ClientIP
客户端 IP,格式如:127.0.0.1。
OptPlatform
客户端平台,取值参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义。

请求包示例

{
"CallbackCommand": "Group.CallbackAfterCreateGroup", // 回调命令
"GroupId" : "@TGS#2J4SZEAEL",
"Operator_Account": "group_root", // 操作者
"Owner_Account": "leckie", // 群主
"Type": "Public", // 群组类型
"Name": "MyFirstGroup", // 群组名称
"Introduction" : "introduction",
"Notification" : "notification",
"MemberList": [ // 初始成员列表
{
"Member_Account": "bob"
},
{
"Member_Account": "peter"
}
],
"UserDefinedDataList": [ //用户建群时的自定义字段
{
"Key": "UserDefined1",
"Value": "hello"
},
{
"Key": "UserDefined2",
"Value": "world"
}
],
"EventTime":"1670574414123"//毫秒级别,事件触发时间戳
}

请求包字段说明

字段
类型
说明
CallbackCommand
String
回调命令。
GroupId
String
操作的群 ID。
Operator_Account
String
发起创建群组请求的操作者 UserID。
Owner_Account
String
请求创建的群的群主 UserID。
Type
String
请求创建的 群组类型介绍,例如 Public。
Name
String
请求创建的群组的名称。
Introduction
String
群简介。
Notification
String
群公告。
MemberList
Array
请求创建的群组的初始化成员列表。
UserDefinedDataList
Array
用户建群时的自定义字段,这个字段默认是没有的,需要开通,详见 自定义字段
EventTime
Integer
事件触发的毫秒级别时间戳。

应答包示例

App 后台同步数据后,发送回调应答包。
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 // 忽略回调结果
}

应答包字段说明

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

参考

REST API:创建群组

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈