tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
即时通信 IM
    文档
    Download PDF

    群成员资料变更后回调

    最后更新时间：2024-05-14 14:28:25
    下载PDF

      功能说明

      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.CallbackAfterMemberFieldChanged
      contenttype
      固定值为 JSON
      ClientIP
      客户端 IP，格式例如：127.0.0.1
      OptPlatform
      客户端平台，取值参见 第三方回调简介 - 回调协议 中 OptPlatform 的参数含义

      请求包示例

      {
          "CallbackCommand": "Group.CallbackAfterMemberFieldChanged",    // 群成员资料变更回调
          "GroupId": "@TGS#xxxx", // 群组 ID
          "Type": "Community", // 群组类型
          "Operator_Account": "admin", // 操作用户id
          "Member_Account": "123456", // 用户id
          "Role": "Admin", // 变更后成员身份
          "NameCard": "jacky", // 变更后群名片
          "EventTime":"1670574414123"//毫秒级别，事件触发时间戳
      }
      

      请求包字段说明

      字段
      类型
      说明
      CallbackCommand
      String
      回调命令
      GroupId
      String
      操作的群 ID
      Type
      String
      群组类型 群组类型介绍，例如：Public
      Operator_Account
      String
      发起变更请求的操作者 UserID
      Member_Account
      String
      变更成员 UserID
      Role
      String
      变更后成员身份，Admin/Member 分别为设置/取消管理员
      NameCard
      String
      变更后群名片
      EventTime
      Integer
      事件触发的毫秒级别时间戳

      应答包示例

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

      应答包字段说明

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

      参考

      第三方回调简介
      REST API：修改群成员资料
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款