获取群信息

获取指定群的基本信息，包括群名称、群描述、群头像、群主 ID 以及群权限配置等。

前提条件

应用需要开启机器人能力。

使用限制

• 调用接口的机器人或者用户需要在群组内，才可以获取完整信息，否则只返回群名称、群头像、成员数量以及群状态信息。
• 获取内部群信息时，调用接口的机器人或者用户需要与群组在同一租户下。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v1/chats/:chat_id
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	im:chat 获取与更新群组信息 im:chat:read 查看群信息 im:chat:readonly 获取群组信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
chat_id	string	群 ID。获取方式： - 创建群，从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口，可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 示例值："oc_a0553eda9014c201e6969b478895c230"

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ avatar	string	群头像 URL
└ name	string	群名称。没有设置群名称时，不会返回该参数。
└ description	string	群描述
└ i18n_names	i18n_names	群国际化名称
└ zh_cn	string	中文名
└ en_us	string	英文名
└ ja_jp	string	日文名
└ 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：所有成员
└ owner_id_type	string	群主的用户 ID 类型，与查询参数中的 user_id_type 相同。取值为 open_id、user_id、union_id 其中之一，不同 ID 的说明参见 用户相关的 ID 概念。 注意： - 当群主是机器人时不返回该字段 - 单聊不返回该字段
└ owner_id	string	群主的用户 ID，ID 类型与查询参数中的 user_id_type 对应。 注意： - 当群主是机器人时不返回该字段 - 单聊不返回该字段
└ user_manager_id_list	string\[\]	用户管理员 ID 列表，ID 类型与查询参数 user_id_type 一致。
└ bot_manager_id_list	string\[\]	机器人管理员 ID 列表，ID 类型为应用的 App ID。
└ group_message_type	string	群消息模式 可选值有： - chat：会话消息 - thread：话题消息 注意：仅普通对话群组返回该字段，话题群和单聊不返回值。
└ chat_mode	string	群模式 可选值有： - group：群组 - topic: 话题 - p2p: 单聊
└ chat_type	string	群类型 可选值有： - private：私有群 - public：公开群 注意：单聊不返回该字段
└ chat_tag	string	群标签。如有多个，则按照下列顺序返回第一个标签。 可选值有： - inner：内部群 - tenant：公司群 - department：部门群 - edu：教育群 - meeting：会议群 - customer_service：客服群 注意：单聊不返回该字段
└ 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：指定群成员
└ external	boolean	是否是外部群
└ tenant_key	string	租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。
└ user_count	string	群内用户的数量
└ bot_count	string	群内机器人的数量
└ restricted_mode_setting	restricted_mode_setting	保密模式设置
└ status	boolean	保密模式是否开启
└ screenshot_has_permission_setting	string	允许截屏录屏 可选值有： - all_members: 所有成员允许截屏录屏 - not_anyone: 所有成员禁止截屏录屏
└ download_has_permission_setting	string	允许下载消息中图片、视频和文件 可选值有： - all_members: 所有成员允许下载资源 - not_anyone: 所有成员禁止下载资源
└ message_has_permission_setting	string	允许复制和转发消息 可选值有： - all_members: 所有成员允许复制和转发消息 - not_anyone: 所有成员禁止复制和转发消息
└ urgent_setting	string	谁可以加急 可选值有： - only_owner: 仅群主和管理员 - all_members: 所有成员
└ video_conference_setting	string	谁可以发起视频会议 可选值有： - only_owner: 仅群主和管理员 - all_members: 所有成员
└ hide_member_count_setting	string	隐藏群成员人数设置 可选值有： - all_members: 所有群成员可见 - only_owner: 仅群主群管理员可见
└ chat_status	string	群状态 可选值有： - normal: 正常 - dissolved: 解散 - dissolved_save: 解散并保留

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "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": "グループチャット"
        },
        "add_member_permission": "all_members",
        "share_card_permission": "allowed",
        "at_all_permission": "all_members",
        "edit_permission": "all_members",
        "owner_id_type": "user_id",
        "owner_id": "4d7a3c6g",
        "user_manager_id_list": [
            "ou_9204a37300b3700d61effaa439f34295"
        ],
        "bot_manager_id_list": [
            "cli_a3e157960e7294c"
        ],
        "group_message_type": "chat",
        "chat_mode": "group",
        "chat_type": "private",
        "chat_tag": "inner",
        "join_message_visibility": "only_owner",
        "leave_message_visibility": "only_owner",
        "membership_approval": "no_approval_required",
        "moderation_permission": "all_members",
        "external": false,
        "tenant_key": "736588c9260f175e",
        "user_count": "1",
        "bot_count": "3",
        "restricted_mode_setting": {
            "status": false,
            "screenshot_has_permission_setting": "all_members",
            "download_has_permission_setting": "all_members",
            "message_has_permission_setting": "all_members"
        },
        "urgent_setting": "all_members",
        "video_conference_setting": "all_members",
        "hide_member_count_setting": "all_members",
        "chat_status": "normal"
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	232004	Such an app does NOT exist.	作为操作者的 app_id 不存在，请联系技术支持。
400	232006	Your request specifies a chat_id which is invalid.	无效的 chat_id，请检查 chat_id 是否正确。获取方式： - 创建群，从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口，可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。
400	232010	Operator and chat can NOT be in different tenants.	调用接口的操作者和被操作的群组不在同一租户下，无法操作。需确保当前的操作者和被操作的群组在同一租户下。
400	232011	Operator can NOT be out of the chat.	调用接口的操作者不在群组内，无法操作。你需要将当前调用 API 的应用或用户加入待操作的群组后重试。
400	232025	Bot ability is not activated.	应用未启用机器人能力。你需要登录开发者后台，在应用详情页的 应用能力 > 添加应用能力 页面内，添加 机器人 能力，并发布应用使配置生效。具体操作参见机器人能力。
400	232033	The operator or invited bots does NOT have the authority to manage external chats without the scope.	当前被操作的群为外部群，暂不支持操作外部群。只有开启对外共享能力的机器人支持外部群，详情参见机器人支持外部群和外部用户单聊。
400	232034	The app is unavailable or inactivated by the tenant.	应用在本租户下未安装或未启用。需要先安装应用，再使用应用调用接口。

更多错误码信息，参见通用错误码。