获取群菜单

获取指定群组内的群菜单信息，包括所有一级或二级菜单的名称、跳转链接、图标等信息。

前提条件

• 应用需要开启机器人能力。
• 调用当前接口的机器人必须在对应的群组内。

使用限制

该接口仅支持群模式为 group 的群组，你可以调用获取群信息接口，在返回结果中查看 chat_mode 参数取值是否为 group。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v1/chats/:chat_id/menu_tree
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	im:chat 获取与更新群组信息 im:chat.menu_tree:read 查看群菜单 im:chat:readonly 获取群组信息

请求头

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

路径参数

名称	类型	描述
chat_id	string	群 ID。获取方式： - 创建群，从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口，可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 注意：仅支持群模式为 群组（group） 的群组 ID。你可以调用获取群信息接口，在返回结果中查看 chat_mode 参数取值是否为 group。 示例值："oc_a0553eda9014c201e6969b478895c230"

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ menu_tree	chat.menu_tree	群内所有菜单的信息
└ chat_menu_top_levels	chat_menu_top_level\[\]	一级菜单列表
└ chat_menu_top_level_id	string	一级菜单 ID。删除、修改、排序等群菜单管理操作均需要使用菜单 ID。
└ chat_menu_item	chat_menu_item	一级菜单信息
└ action_type	string	菜单类型 可选值有： - NONE: 无类型，当一级菜单下有二级菜单时，类型取值为 NONE。 - REDIRECT_LINK: 跳转链接类型
└ redirect_link	chat_menu_item_redirect_link	跳转链接
└ common_url	string	公用跳转链接
└ ios_url	string	iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 common_url 值。
└ android_url	string	Android 端跳转链接，当该字段不设置时，Android 端默认使用 common_url 值。
└ pc_url	string	PC 端跳转链接，当该字段不设置时，PC 端默认使用 common_url 值。 说明：以 https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url= 开头的链接表示在飞书侧边栏展开。
└ web_url	string	Web 端跳转链接，当该字段不设置时，Web 端默认使用 common_url 值。
└ image_key	string	图标的 key 值。通过下载图片接口可将图标下载到本地（只能下载由当前机器人上传的图片）。 注意：一级菜单下存在二级菜单时不能设置图标。
└ name	string	菜单名称
└ i18n_names	i18n_names	菜单国际化名称
└ zh_cn	string	中文名
└ en_us	string	英文名
└ ja_jp	string	日文名
└ children	chat_menu_second_level\[\]	二级菜单列表
└ chat_menu_second_level_id	string	二级菜单 ID
└ chat_menu_item	chat_menu_item	二级菜单信息
└ action_type	string	菜单类型 可选值有： - NONE: 无类型 - REDIRECT_LINK: 跳转链接类型
└ redirect_link	chat_menu_item_redirect_link	跳转链接
└ common_url	string	公用跳转链接
└ ios_url	string	iOS 端跳转链接，当该字段不设置时，iOS 端默认使用 common_url 值。
└ android_url	string	Android 端跳转链接，当该字段不设置时，Android 端默认使用 common_url 值。
└ pc_url	string	PC 端跳转链接，当该字段不设置时，PC 端默认使用 common_url 值。 说明：以 https://applink.feishu.cn/client/web_url/open?mode=sidebar-semi&url= 开头的链接表示在飞书侧边栏展开。
└ web_url	string	Web 端跳转链接，当该字段不设置时，Web 端默认使用 common_url 值。
└ image_key	string	图标的 key 值。通过下载图片接口可将图标下载到本地（只能下载由当前机器人上传的图片）。
└ name	string	菜单名称
└ i18n_names	i18n_names	菜单国际化名称
└ zh_cn	string	中文名
└ en_us	string	英文名
└ ja_jp	string	日文名

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "menu_tree": {
            "chat_menu_top_levels": [
                {
                    "chat_menu_top_level_id": "7117116451961487361",
                    "chat_menu_item": {
                        "action_type": "NONE",
                        "redirect_link": {
                            "common_url": "https://open.feishu.cn/",
                            "ios_url": "https://open.feishu.cn/",
                            "android_url": "https://open.feishu.cn/",
                            "pc_url": "https://open.feishu.cn/",
                            "web_url": "https://open.feishu.cn/"
                        },
                        "image_key": "img_v2_b0fbe905-7988-4282-b882-82edd010336j",
                        "name": "菜单",
                        "i18n_names": {
                            "zh_cn": "菜单",
                            "en_us": "Menu",
                            "ja_jp": "メニュー"
                        }
                    },
                    "children": [
                        {
                            "chat_menu_second_level_id": "7039638308221468675",
                            "chat_menu_item": {
                                "action_type": "REDIRECT_LINK",
                                "redirect_link": {
                                    "common_url": "https://open.feishu.cn/",
                                    "ios_url": "https://open.feishu.cn/",
                                    "android_url": "https://open.feishu.cn/",
                                    "pc_url": "https://open.feishu.cn/",
                                    "web_url": "https://open.feishu.cn/"
                                },
                                "image_key": "img_v2_b0fbe905-7988-4282-b882-82edd010336j",
                                "name": "报名",
                                "i18n_names": {
                                    "zh_cn": "报名",
                                    "en_us": "Sign up",
                                    "ja_jp": "サインアップ"
                                }
                            }
                        }
                    ]
                }
            ]
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	232001	Your request contains an invalid request parameter.	参数错误，参考接口文档提供的参数描述，检查输入参数是否有误。
400	232011	Operator can NOT be out of the chat.	操作者不在群组中。你需要将当前调用 API 的应用或用户加入待操作的群组后重试。
400	232014	The token used in the request does NOT have the permissions necessary to complete the request.	操作者没有权限进行该操作，请检查是否已开通调用接口所需要的权限。
400	232024	Users do not have the visibility of the app, or the operator does not have collaboration permissions with the target users.	机器人对用户没有可见性，或操作者与用户间没有协作权限。 - 如果是机器人对用户没有可见性，需要在开发者后台 > 应用详情页 > 应用发布 > 版本管理与发布 编辑应用对用户的可见性并发布应用。具体操作参考配置应用可用范围。 - 如果是操作者与用户之间没有协作权限，请检查是否与目标用户有协作权限，如屏蔽、未添加为联系人等。
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.	应用在本租户下未安装或未启用。需要先安装应用，再使用应用调用接口。

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