查询公共邮箱的所有别名
获取所有公共邮箱别名。
Tip: 该接口一次性返回所有数据,分页参数无效
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/mail/v1/public_mailboxes/:public_mailbox_id/aliases |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | mail:public_mailbox 查询、创建、修改公共邮箱 mail:public_mailbox:readonly 查询公共邮箱 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
public_mailbox_id | string | 公共邮箱id或公共邮箱邮件地址 示例值:"xxxxxx 或 xxx@xx.xxx" |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | email_alias\[\] | 公共邮箱别名 |
└ primary_email | string | 主邮箱地址 |
└ email_alias | string | 邮箱别名 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"primary_email": "xxx@xx.xxx",
"email_alias": "xxx@xx.xxx"
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 404 | 1234016 | public mailbox not found | 请确认公共邮箱是否存在 |
| 400 | 1234008 | request parameter error | 请检查请求参数是否正确 |
