# 将用户或机器人拉入群聊

将用户或机器人拉入群聊。

注意事项:

  • 可以用户身份调用
  • 若机器人为管理员时,可以将用户直接拉入群聊
  • 若机器人不为管理员时,群内普通成员可以添加用户时则可以拉人进入群聊,反之不可以
  • 每次请求最多拉入50个用户和5个机器人

# 请求

基本
HTTP URL https://hi-gw.weizhipin.com/open-apis/im/chats/:chat_id/members
HTTP Method POST
支持的应用类型 自建应用商店应用
权限要求 获取与更新群组信息

# 请求头

名称 类型 必填 描述
Authorization string tenant_access_token

user_access_token
值格式:"Bearer access_token"
示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560"
Content-Type string 固定值:"application/json; charset=utf-8"

# 路径参数(url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值)

名称 类型 描述
chat_id string 群 ID[群ID 说明]
示例值:"oc_a0553eda9014c201e6969b478895c230"

# 查询参数

名称 类型 必填 描述
member_id_type string 进群成员 id 类型 user_id/app_id
示例值:"user_id"
可选值有
* user_id:以 user_id 来识别成员,需要有获取用户UserID的权限
* app_id:以 app_id 来识别成员

# 请求体

名称 类型 必填 描述
id_list string[] 成员列表示例值:["ou_9204a37300b3700d61effaa439f34295"]
fail_type int 出现不可用ID后的处理方式 1/2
示例值:1
可选值有
* 1:失败后取消本次拉群操作。
* 2:将请求成功的用户ID拉入群聊。

# 请求体示例

{
      "id_list": [
        "ou_9204a37300b3700d61effaa439f34295"
      ]
}
1
2
3
4
5

# 响应

# 响应体

名称 类型 描述
code int 错误码,非 0 表示失败
msg string 错误描述
data - -
 ∟fail_id_list string[] 失败的成员列表

# 响应体示例

{
    "code": 0,
    "traceId": "_Ao59UOIBLPCeAAu",
    "success": true,
    "msg": "操作成功",
    "data": {
        "fail_id_list": [
            "ou_9204a37300b3700d61effaa439f34295"
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
最后更新于 : 3/4/2024, 3:29:16 PM