列出邮箱文件夹

列出用户文件夹，可获取文件夹名称、文件夹ID、文件夹下的未读邮件和未读会话数量

Tip: 使用应用身份访问时，需要申请邮箱文件夹资源的数据权限。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/folders
HTTP Method	GET
接口频率限制	5 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	mail:user_mailbox.folder:read 查询邮箱文件夹 mail:user_mailbox.folder:write 查看、创建、更新、删除邮箱文件夹

请求头

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

路径参数

名称	类型	描述
user_mailbox_id	string	用户邮箱地址。当使用用户身份访问时，可以输入"me"代表当前调用接口用户 示例值："user@xxx.xx 或 me"

查询参数

名称	类型	必填	描述
folder_type	int	否	文件夹类型 示例值：1 可选值有： - 1: 系统文件夹 - 2: 用户文件夹 数据校验规则： - 取值范围：1 ～ 2

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	folder\[\]	文件夹列表
└ id	string	folder id
└ name	string	文件夹名称
└ parent_folder_id	string	父文件夹 id，该值为 0 表示根文件夹
└ folder_type	int	文件夹类型 可选值有： - 1: 系统文件夹 - 2: 用户文件夹
└ unread_message_count	int	未读邮件数量
└ unread_thread_count	int	未读会话数量

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "12314123123123123",
                "name": "newsletter 相关",
                "parent_folder_id": "725627422334644",
                "folder_type": 1,
                "unread_message_count": 3,
                "unread_thread_count": 4
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1230001	invalid param	参数错误，请检查请求参数的类型、格式或值是否与接口要求一致，具体可参考接口文档中的参数说明
500	1230003	internal server error	内部服务错误，请稍后重试
403	1230002	permission denied	无权限访问，请确认应用是否具备访问该资源的权限。如使用用户身份访问，请确认具备此用户的访问权限；如使用租户身份访问，请确认已申请对应的数据范围权限。