tencent cloud

功能说明

App 管理员可以通过该接口向指定的群中添加新成员。

接口调用说明

适用的群组类型

即时通信 IM 内置以上四种群组类型，详情请参阅 群组系统。

注意：

AVChatRoom(直播群)不支持增加群成员，对此类型群组进行操作时会返回10007错误。用户加入此类型群组的唯一方式是用户申请加群。

请求 URL 示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

• 基础形式
  用来向群中进行邀请加人，一次请求最多支持添加300个成员。后台默认情况下会给群中所有成员下发加群系统通知，不包括没有激活的 Private 类型（即新版本中的Work，好友工作群）群组外。

  {
    "GroupId": "@TGS#2J4SZEAEL", // 要操作的群组（必填）
    "MemberList": [ // 一次最多添加300个成员
    {
        "Member_Account": "tommy" // 要添加的群成员ID（必填）
    },
    {
        "Member_Account": "jared"
    }]
  }
  

• 静默加人
  当 Silence 为 1 时，成员添加成功后，不会给任何人下发系统通知。

  {
    "GroupId": "@TGS#2J4SZEAEL", // 要操作的群组（必填）
    "Silence": 1, // 是否静默加人（选填）
    "MemberList": [ // 一次最多添加300个成员
    {
        "Member_Account": "tommy" // 要添加的群成员 ID（必填）
    },
    {
        "Member_Account": "jared"
    }]
  }
  

请求包字段说明

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "MemberList": [
    {
         "Member_Account": "tommy",
         "Result": 1 // 加人结果：0 为失败；1 为成功；2 为已经是群成员
    },
    {
         "Member_Account": "jared",
         "Result": 1
    }]
}

应答包字段说明

错误码说明

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

接口调试工具

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

参考

删除群成员（v4/group_open_http_svc/delete_group_member）

可能触发的回调

• 拉人入群之前回调
• 新成员入群之后回调
• 群组满员之后回调