Skip to content

列出草稿列表

列出用户草稿箱中的草稿,只会返回草稿ID信息,不会返回草稿内容

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/drafts
HTTP MethodGET
接口频率限制10 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用mail:user_mailbox.message:readonly 查询用户邮件

请求头

名称类型必填描述
Authorizationstringuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

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

查询参数

名称类型必填描述
page_sizeint分页大小
示例值:20
默认值20
数据校验规则
- 取值范围:1100
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:xxx

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsdraft\[\]草稿列表
    └ idstring草稿ID
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "268dce11-85f7-427d-8756-6be3abc850fd"
            }
        ],
        "page_token": "xxx",
        "has_more": true
    }
}

错误码

HTTP状态码错误码描述排查建议
4001234008request parameter error参数错误,请检查请求参数的类型、格式或值是否与接口要求一致,具体可参考接口文档中的参数说明
4031234017permission deny无权限访问,请确认应用是否具备访问该资源的权限。如使用用户身份访问,请确认具备此用户的访问权限;如使用租户身份访问,请确认已申请对应的数据范围权限。
4041234013user mailbox not found or user mailbox not active用户邮箱地址不存在,请检查输入的用户邮箱地址是否正确,或确认用户的邮箱处于正常状态
4291236006too many request请求被限流,请勿并发调用接口
5001236019internal server error内部服务错误,请重试

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