Skip to content

群组管理概述

群组 OpenAPI 提供了群组管理能力,包括创建群、解散群、更新群信息、获取群信息、管理群置顶以及获取群分享链接等。

基本概念

概念描述
群模式- group:普通对话群组。调用创建群接口仅能创建该模式的群组,该类群组内的消息模式分为会话消息(chat)、话题消息(thread)两类。 image.png - topic:话题群组。无法通过 OpenAPI 创建,只能在飞书客户端内手动创建。详情参见使用话题群image.png - p2p:单聊。无法通过 OpenAPI 创建,在发送消息时,如果消息接收者为用户(user_id/open_id/union_id),会返回 chat_id,使用该类 chat_id 获取群信息时,返回的群模式参数(chat_mode)值为单聊(p2p)。
群类型- 私有群:仅被邀请至群组内的成员可以查看到该群,在企业内无法直接搜索加入,适用于团队内部交流沟通。 - 公开群:企业内的成员可直接搜索加入的群组,适用于企业内的业务推广、活动邀请等开放沟通的场景。
群权限创建或更新群组时,可以设置群组的相关权限,包括:成员入群或退群的提示消息可见性、用户加群是否需要审批、谁可以邀请成员入群、谁可以分享群、谁可以 @ 所有人、谁可以加急消息、谁可以编辑群信息、是否隐藏群成员人数等。

字段说明

Note 以下字段并非所有类型的群组都具备,部分群组可能缺失某些字段。详情参考具体的 API 文档。

名称类型描述
chat_idstring群 ID,是群聊的唯一标识,在创建群聊时系统会自动生成该 ID,格式以 oc_ 开头。ID 获取方式: - 创建群,从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口,可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表,可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 - 调用发送消息接口向单聊发消息(即向某一用户发消息)时,该接口会返回 chat_id,使用该 chat_id 获取群信息,群模式为单聊(即 chat_mode 返回值为 p2p)。
avatarstring群头像 URL
namestring群名称
descriptionstring群描述
i18n_namesi18n_names群国际化名称
∟ zh_cnstring中文名
∟ en_usstring英文名
∟ ja_jpstring日文名
owner_idstring群主的用户 ID,ID 类型与 owner_id_type 的取值相对应。不同 ID 说明参见 用户相关的 ID 概念注意:群主是机器人则该字段不返回。
owner_id_typestring群主的用户 ID 类型。用户 ID 类型分为 open_iduser_idunion_id。不同 ID 的说明参见 用户相关的 ID 概念注意:群主是机器人则该字段不返回。
add_member_permissionstring谁可以邀请用户或机器人入群 可选值有: - all_members:所有成员。取该值时,群分享权限(share_card_permission)取值必须为 allowed。 - only_owner:仅群主和管理员。取该值时,群分享权限(share_card_permission)取值必须为 not_allowed
share_card_permissionstring谁可以分享群 可选值有: - allowed:所有成员。取该值时,邀请用户或机器人入群的权限(add_member_permission)取值必须为 all_members。 - not_allowed:仅群主和管理员。取该值时,邀请用户或机器人入群的权限(add_member_permission)取值必须为 only_owner
at_all_permissionstring谁可以 at 所有人 可选值有: - only_owner:仅群主和管理员 - all_members:所有成员
edit_permissionstring谁可以编辑群信息 可选值有: - only_owner:仅群主和管理员 - all_members:所有成员
chat_modestring群模式 可选值有: - group:群组 - topic:话题群 - p2p:单聊 注意创建群时,该参数作为请求参数仅支持取值 group
group_message_typestring群消息形式 可选值有: - chat:对话消息 - thread:话题消息
chat_typestring群类型 可选值有: - private:私有群 - public:公开群
chat_tagstring群标签。如有多个,则按照下列顺序返回第一个标签。 可选值有: - inner:内部群 - tenant:公司群 - department:部门群 - edu:教育群 - meeting:会议群 - customer_service:客服群
externalboolean是否是外部群
tenant_keystring租户在飞书上的唯一标识,用来换取对应的 tenant_access_token,也可以用作租户在应用里面的唯一标识。
join_message_visibilitystring成员入群提示消息的可见性 可选值有: - only_owner:仅群主和管理员可见 - all_members:所有成员可见 - not_anyone:任何人均不可见
leave_message_visibilitystring成员出群提示消息的可见性 可选值有: - only_owner:仅群主和管理员可见 - all_members:所有成员可见 - not_anyone:任何人均不可见
membership_approvalstring加群审批 可选值有: - no_approval_required:无需审批 - approval_required:需要审批
moderation_permissionstring群发言权限 可选值有: - only_owner:仅群主和管理员 - all_members:所有成员 - moderator_list:指定群成员

数据示例

json
{
  "chat_id": "oc_a0553eda9014c201e6969b478895c230",
  "avatar": "https://p3-lark-file.byteimg.com/img/lark-avatar-staging/default-avatar_44ae0ca3-e140-494b-956f-xxxx~100x100.jpg",
  "name": "测试群名称",
  "description": "测试群描述",
  "i18n_names": {
    "zh_cn": "群聊",
    "en_us": "group chat",
    "ja_jp": "グループチャット"
  },
  "owner_id": "4d7a3c6g",
  "owner_id_type": "user_id",
  "add_member_permission": "all members",
  "share_card_permission": "allowed",
  "at_all_permission": "all members",
  "edit_permission": "all members",
  "group_message_type": "chat",
  "chat_mode": "group",
  "chat_type": "private",
  "chat_tag": "inner",
  "external": false,
  "tenant_key": "736588c9260f175e",
  "join_message_visibility": "all_members",
  "leave_message_visibility": "all_members",
  "membership_approval": "no_approval_required",
  "moderation_permission": "all_members"
}

内容来源:飞书开放平台 · 自动爬取整理