# 创建群

创建群并设置群头像、群名、群描述等。

注意事项:

  • 只支持以机器人身份创建群聊(即不可使用user_access_token)
  • 每次请求最多可拉50个用户和5个机器人

# 请求

基本
HTTP URL https://hi-gw.weizhipin.com/open-apis/im/v2/chats
HTTP Method POST
支持的应用类型 自建应用
商店应用
权限要求 获取与更新群组信息
字段权限要求 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请
获取用户 user_id(仅自建应用)

# 请求头

名称 类型 必填 描述
Authorization string tenant_access_token
值格式:"Bearer access_token"
示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type string 固定值:"application/json; charset=utf-8"

# 查询参数

名称 类型 描述
user_id_type string 用户 ID 类型示例值:"open_id"
可选值有:
open_id:用户的 open id
union_id:用户的 union id
user_id:用户的 user id
默认值:open_id
当值为 user_id,字段权限要求:
获取用户 user ID
uuid string 由开发者生成的唯一字符串序列,用于发送消息请求去重;持有相同uuid的请求1小时内至多成功执行一次
示例值:"a0d69e20-1dd1-458b-k525-dfeca4015204"
数据校验规则:
最大长度:50 字符

# 请求体

名称展开子列表 类型 必填 描述
avatar string 群头像对应的 Image Key,可通过[上传图片]获取
name string 群名称
示例值:"测试群名称"
数据校验规则
* 最大长度:32(英文字符)
bulletin string 群公告
示例值:"测试群公告"
数据校验规则
* 最大长度:1000(英文字符)
owner_id string 创建群时指定的群主,不填时指定manager_id_list中第一个为群主, manager_id_list为空取当前机器人为群主。
user_id_list string[] 创建群时邀请的群成员
示例值:["4d7a3c6g"]
数据校验规则
* 最大长度:50
字段权限要求
获取用户 user_id(仅自建应用)
bot_id_list string[] 创建群时邀请的群机器人
示例值:["cli_a10fbf7e94b8d01d"]
数据校验规则
* 最大长度:5
manager_id_list string[] 创建群时指定的群管理员,只支持用户
chat_type string 群类型
可选值有
* private:私有群
* public:公开群
默认值:"private"
look_type int 群成员是否可见历史消息
可选值有
* 1:可见所有
* 3:不可见
* 5:可见最近100条
默认值:1
owner_edit int 只有群主和管理员可以编辑信息
可选值有
* 1:是
* 0:否
默认值:0
owner_add_user int 只有群主和管理员可以添加用户
可选值有
* 1:是
* 0:否
默认值:0
owner_at_all int 只有群主和管理员可以@所有人
可选值有
* 1:是
* 0:否
默认值:0
{
    "avatar": "default-avatar_44ae0ca3-e140-494b-956f-78091e348435",
    "name": "测试群名称",
    "bulletin": "测试群公告",
    "owner_id": "4d7a3c6g",
    "user_id_list": [
        "4d7a3c6g"
    ],
    "bot_id_list": [
        "bli_a10fbf7e94b8d01d"
    ],
    "manager_id_list": [
        "bli_a10fbf7e94b8d01d"
    ],
    "chat_type": "private",
    "look_type": 1,
    "owner_edit": 1,
    "owner_add_user": 1,
    "owner_at_all": 1
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 响应体

名称 类型 描述
code int 错误码,非 0 表示失败
msg string 错误描述
data - -
 ∟chat_id string 群组 ID
 ∟avatar string 群头像 URL
 ∟name string 群名称
 ∟bulletin string 群描述
 ∟owner_id string 群主 ID
 ∟user_id_list string[] 创建群时邀请的群成员
 ∟bot_id_list string[] 创建群时邀请的群机器人
 ∟manager_id_list string[] 创建群时指定的群管理员
 ∟chat_type string 是否为公开群
 ∟look_type int 群成员是否可见历史消息
 ∟owner_edit int 只有群主和管理员可以编辑群信息
 ∟owner_add_user int 只有群主和管理员可以添加用户
 ∟owner_at_all int 只有群主和管理员可以@所有人

# 响应体示例

{
  "code": 0,
  "traceId": "_Ao59UOIBLPCeAAu",
  "success": true,
  "data": {
    "chat_id": "48da40ceb2a03d421HVy0ts~",
    "avatar": "https://bosshi-admin-qa.weizhipin.com/api/media/download/TsH7SJsyELOzi71PYZP5QhbJUMoTJe0j9FIvbu5gnchF4VdTWnIW3cC5fPoaB5HcqKQ~.png",
    "name": "开放平台测试11",
    "bulletin": "开放平台测试11",
    "manager_id_list": [
      "98643"
    ],
    "user_id_list": [
      "98643"
    ],
    "bot_id_list": [
      "bli_alrwtjqjpfct6fib"
    ],
    "chat_type": "public",
    "look_type": 1,
    "owner_edit": 1,
    "owner_add_user": 0,
    "owner_at_all": 1
  },
  "msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
最后更新于 : 8/21/2023, 4:57:10 PM