tencent cloud

功能说明

App 管理员可以通过该接口修改群成员资料。

接口调用说明

适用的群组类型

即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。

说明：

AVChatRoom（直播群）不存储群成员资料，所以不能修改成员资料。

请求 URL 示例

https://xxxxxx/v4/group_open_http_svc/modify_group_member_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

请求包示例

• 设置管理员
  设置指定群成员的管理员身份。

  {
    "GroupId": "@TGS#2CLUZEAEJ", // 要操作的群组（必填）
    "Member_Account": "bob", // 要操作的群成员（必填）
    "Role": "Admin" // 设置管理员
  }
  

• 取消管理员
  取消指定群成员的管理员身份。

  {
    "GroupId": "@TGS#2CLUZEAEJ", // 要操作的群组（必填）
    "Member_Account": "bob", // 要操作的群成员（必填）
    "Role": "Member" //取消管理员
  }
  

• 设置成员消息屏蔽位
  设置的指定成员消息屏蔽类型： AcceptAndNotify 代表接收并提示消息，Discard 代表不接收也不提示消息，AcceptNotNotify 代表接收消息但不提示。

  {
    "GroupId": "@TGS#2CLUZEAEJ", // 要操作的群组（必填）
    "Member_Account": "bob", // 要操作的群成员（必填）
    "MsgFlag": "AcceptAndNotify" // AcceptAndNotify、Discard或者AcceptNotNotify，消息屏蔽类型
  }
  

• 设置成员的群名片
  设置的指定成员的群名片，最大不超过50个字节。

  {
    "GroupId": "@TGS#2CLUZEAEJ", // 要操作的群组（必填）
    "Member_Account": "bob", // 要操作的群成员（必填）
    "NameCard": "鲍勃" // 群名片（选填）
  }
  

• 设置成员自定义字段
  设置群成员的自定义字段。AppMemberDefinedData 默认是没有的，可以通过 即时通信 IM 控制台 进行配置后使用，详见请求包字段说明表。

  {
    "GroupId": "@TGS#2CLUZEAEJ", // 要操作的群组（必填）
    "Member_Account": "bob", // 要操作的群成员（必填）
    "AppMemberDefinedData": [ // 要操作的成员自定义字段（选填）
        {
            "Key":"MemberDefined1", // 要操作的群成员自定义字段Key
            "Value":"ModifyData1" // 要设置的数据内容
        },
        {
            "Key":"MemberDefined3",
            "Value":"ModifyData3"
        }
    ]
  }
  

• 设置群成员禁言时间
  设置指定的群成员禁言时间。

  {
    "GroupId": "@TGS#2CLUZEAEJ", // 要操作的群组（必填）
    "Member_Account": "bob", // 要操作的群成员（必填）
    "MuteTime":86400 // 指定群成员的禁言时间，单位为秒
  }
  

说明：

Private 群（同新版本中的 Work（好友工作群））不支持禁言群用户。

请求包字段说明

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

通过 REST API在线调试工具 调试本接口。

参考

获取群成员详细资料（v4/group_open_http_svc/get_group_member_info）