API REFERENCEV1.0

Outlook 验证码
读取 API

为客户系统提供稳定的单账号与批量邮件取码能力。支持 OAuth2、Microsoft Graph 和自动回退的混合模式。

查看认证方式 →

01 20

单次批量账号上限

并发工作线程4

请求协议HTTPS

OAuth2GraphCodes

01 · AUTH

认证方式

客户接口必须携带 API Key。推荐使用 X-API-Key 请求头。

Header API Key

适合服务端集成，密钥不会出现在 URL 或请求正文中。

X-API-Key: fyui_live_xxxxxxxxxx

兼容Bearer

Authorization Bearer

兼容使用标准 Bearer Token 的 API 客户端与网关。

Authorization: Bearer fyui_live_xxxxxxxxxx

BASE URL https://outlook.fyui.top

GET

/api/health

健康检查

公开接口，无需 API Key。用于负载均衡、监控平台或客户系统确认服务是否可用。

无需认证响应 application/json缓存 no-store

200 Response

{
  "ok": true,
  "service": "fyui-outlook-mail-ui"
}

POST

/api/v1/fetch

单账号读取验证码

读取一个 Outlook、Hotmail 或 Live 邮箱的最近邮件，返回验证码、模式、请求状态与可选邮件摘要。

需要 API Key频率 20 次/分钟超时 5–30 秒

请求字段

application/json

字段类型必填说明

credentialstring二选一

email----password----client_id----refresh_token

email / clientId / refreshTokenstring二选一

拆分字段方式，与 credential 任选其一。

modeenum否

mixed、oauth2、graph，默认 mixed。

mailboxenum否

both、INBOX、Junk。

includeBodyboolean否

是否读取正文并从正文中提取验证码。

returnMessagesboolean否

是否在客户 API 响应中返回邮件摘要。

Request Example

{
  "id": "order-10001",
  "credential": "email----password----client_id----refresh_token",
  "mode": "mixed",
  "mailbox": "both",
  "top": 10,
  "includeBody": true,
  "returnMessages": false
}

POST

/api/v1/batch

批量读取验证码

一次提交多个账号，服务端最多使用 4 个工作线程并行处理，结果顺序与提交顺序保持一致。

需要 API Key批量上限 20 个频率 6 次/分钟

批量规则

公共参数可放在请求根节点，每个 accounts 项也可以覆盖 mode、mailbox、top 等参数。

Request Example

{
  "mode": "mixed",
  "mailbox": "both",
  "includeBody": true,
  "returnMessages": false,
  "accounts": [
    {
      "id": "account-1",
      "credential": "email----password----client_id----refresh_token"
    },
    {
      "id": "account-2",
      "email": "user@outlook.com",
      "clientId": "application-client-id",
      "refreshToken": "microsoft-refresh-token"
    }
  ]
}

04 · SCHEMA

响应字段模型

HTTP 200 表示客户 API 已完成业务处理，具体账号是否成功请检查 result.ok。

request_idstring

每次请求的唯一追踪 ID。

mode_usedstring

实际成功或最终尝试的模式。

codesarray

提取出的验证码及对应邮件信息。

code_countinteger

当前账号匹配到的验证码数量。

error_typestring

稳定的机器可读错误类型。

relogin_requiredboolean

是否需要用户重新完成 Microsoft 授权。