查询邮箱地址状态

使用邮箱状态查询接口，可以输入邮箱地址，查询出该邮箱地址对应的类型以及状态。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/users/query
HTTP Method	POST
接口频率限制	50 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	mail:user_mailbox 查询、创建、修改和删除用户的企业邮箱

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

请求体

名称	类型	必填	描述
email_list	string\[\]	是	需要查询的邮箱地址列表 示例值：["test@a.com"]

请求体示例

{
    "email_list": [
        "test@a.com"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ user_list	user\[\]	邮箱地址以及其对应的类型和状态
└ email	string	邮箱地址
└ status	int	邮箱地址状态 可选值有： - 1: 邮箱地址格式错误 - 2: 邮箱地址域名不存在 - 3: 邮箱地址不存在 - 4: 启用 - 5: 已删除（邮箱回收站中） - 6: 禁用
└ type	int	邮箱地址类型 可选值有： - 1: 成员邮箱 - 2: 成员邮箱别名 - 3: 公共邮箱 - 4: 公共邮箱别名 - 5: 邮件组 - 6: 邮件组别名

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "user_list": [
            {
                "email": "aaa@lark.com",
                "status": 4,
                "type": 1
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1230001	parameter is invalid	检查邮箱地址是否正确