Skip to content

批量删除邮件

批量将邮件移动到已删除文件夹

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/messages/batch_trash
HTTP MethodPOST
接口频率限制5 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用mail:user_mailbox.message:modify 修改邮件

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

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

请求体

名称类型必填描述
message_idsstring\[\]邮件ID,可通过列出邮件接口、收信事件通知等方式获得
示例值:["NzR3Zkd5NGhBTS9NVkZnSklidDVGT3VoQmM4PQ=="]
数据校验规则
- 长度范围:020

请求体示例

json
{
    "message_ids": [
        "NzR3Zkd5NGhBTS9NVkZnSklidDVGT3VoQmM4PQ=="
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码错误码描述排查建议
4001230001param is invalid参数错误,请参考此文档修改参数
5001230002Internal error服务器内部错误,请稍后重试
4031230009permission denied无权限访问,请检查权限状态后重试
4291236006Concurrent write conflict. Please retry later无法并发处理更新邮件的请求,请稍后重试

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