资源介绍

资源定义

飞书中的聊天群组。

字段说明

名称	类型	描述
chat_id	string	群 ID，详情参见群ID 说明
avatar	string	群头像 URL
name	string	群名称
description	string	群描述
i18n_names	i18n_names	群国际化名称
∟ zh_cn	string	中文名
∟ en_us	string	英文名
∟ ja_jp	string	日文名
owner_id	string	群主 ID，ID值与 owner_id_type 对应。不同 ID 的说明参见用户相关的 ID 概念。当群主是机器人时，该字段不返回
owner_id_type	string	群主 ID 对应的ID类型，取值为：`open_id`、`user_id`、`union_id`其中之一。不同 ID 的说明参见用户相关的 ID 概念。当群主是机器人时，该字段不返回
add_member_permission	string	拉用户或机器人入群权限可选值有：`only_owner`：仅群主和管理员`all_members`：所有成员
share_card_permission	string	群分享权限可选值有：`allowed`：允许`not_allowed`：不允许
at_all_permission	string	at 所有人权限可选值有：`only_owner`：仅群主和管理员`all_members`：所有成员
edit_permission	string	群编辑权限可选值有：`only_owner`：仅群主和管理员`all_members`：所有成员
chat_mode	string	群模式可选值有：`group`：群组`topic`：话题群`p2p`：单聊
chat_type	string	群类型可选值有：`private`：私有群`public`：公开群
chat_tag	string	群标签，如有多个，则按照下列顺序返回第一个可选值有：`inner`：内部群`tenant`：公司群`department`：部门群`edu`：教育群`meeting`：会议群`customer_service`：客服群
external	boolean	是否是外部群
tenant_key	string	租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用里面的唯一标识
join_message_visibility	string	入群消息可见性可选值有：`only_owner`：仅群主和管理员可见`all_members`：所有成员可见`not_anyone`：任何人均不可见
leave_message_visibility	string	出群消息可见性可选值有：`only_owner`：仅群主和管理员可见`all_members`：所有成员可见`not_anyone`：任何人均不可见
membership_approval	string	加群审批可选值有：`no_approval_required`：无需审批`approval_required`：需要审批
moderation_permission	string	发言权限可选值有：`only_owner`：仅群主和管理员`all_members`：所有成员`moderator_list`：指定群成员

数据示例

{
        "chat_id": "oc_a0553eda9014c201e6969b478895c230",
        "avatar": "https://p3-lark-file.byteimg.com/img/lark-avatar-staging/default-avatar_44ae0ca3-e140-494b-956f-78091e348435~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",
        "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",
}

群 ID 说明

参见文档群ID 说明

资源定义#

字段说明#

数据示例#

群 ID 说明#

资源定义

字段说明

数据示例

群 ID 说明