获取用户邮箱所有别名
获取用户邮箱所有别名。
Tip: 该接口一次性返回所有数据,分页参数无效
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/aliases |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | mail:user_mailbox 查询、创建、修改和删除用户的企业邮箱 mail:user_mailbox:readonly 查询用户的企业邮箱 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
user_mailbox_id | string | 用户邮箱地址 示例值:"user@xxx.xx" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:xxx |
page_size | int | 否 | 分页大小 示例值:10 默认值: 20数据校验规则: - 最大值: 20 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
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 | 1235013 | user not found | 请确认用户邮箱是否存在 |
| 400 | 1234008 | request parameter error | 请检查请求参数是否正确 |
