Docs Overview/
Chat/
服务端 API/
触发器/
群回调/
群属性变更后回调/

群属性变更后回调

功能说明

App 后台可以通过该回调实时查看群自定义属性变更信息，包括：修改、清空、重置、删除群自定义属性，App 后台可以据此回调进行数据同步等操作。

注意事项

要启用回调，必须配置回调 URL，并打开本条回调协议对应的开关，配置方法详细参见 第三方回调配置 文档。
回调的方向是即时通信 IM 后台向 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
创建应用时在即时通信 IM 控制台分配的 SDKAppID
CallbackCommand
固定为 Group.CallbackAfterGroupAttrChanged
contenttype
固定值为 JSON
ClientIP
客户端 IP，格式如：127.0.0.1
OptPlatform
客户端平台，取值参见 第三方回调简介 - 回调协议中 OptPlatform 的参数含义

请求包示例

{
    "CallbackCommand": "Group.CallbackAfterGroupAttrChanged",
    "GroupId": "@TGS#2J4SZEAEL",
    "Type": "Public",
    "Operator_Account": "leckie",
    "OptionType":"set",   // "set" : 重置自定义属性; "modify": 修改自定义属性;  "clear": 清空自定义属性;  "delete" : 删除自定义属性
    "GroupAttr": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "values"
        }
    ],
    "EventTime":"1670574414123"//毫秒级别，事件触发时间戳		
}


请求包字段说明

字段
类型
说明
CallbackCommand
String
回调命令
GroupId
String
操作的群 ID
Type
String
群组类型 群组类型介绍，例如：Public
Operator_Account
String
发起群自定义属性变更请求的操作者 UserID
GroupAttr
Array
自定义属性列表，key 为自定义属性的键，value 为自定义属性的值
EventTime
Integer
事件触发的毫秒级别时间戳

应答包示例

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

应答包字段说明

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

参考

第三方回调简介
REST API：修改群自定义属性
REST API：清空群自定义属性
REST API：重置群自定义属性
REST API：删除群自定义属性