将公共邮箱移至回收站
将公共邮箱移至回收站
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/mail/v1/public_mailboxes/:public_mailbox_id/remove_to_recycle_bin |
| HTTP Method | DELETE |
| 接口频率限制 | 20 次/分钟 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | mail:public_mailbox 查询、创建、修改公共邮箱 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
public_mailbox_id | string | 公共邮箱地址 示例值:"test_public_mailbox@xxx.xx" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
to_mail_address | string | 否 | 接收删除邮件的邮箱地址,不填则删除该公共邮箱的邮件 示例值:"user@xxx.xx" |
请求体示例
json
{
"to_mail_address": "user@xxx.xx"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1230001 | 参数错误 | 修改参数后重试 |
| 500 | 1230003 | 内部错误 | 请稍后重试 |
| 403 | 1230002 | 无权限 | 检查相关权限后重试 |
