From 716baba4aadd66cb58954d4e2b1d12f3c5f302b7 Mon Sep 17 00:00:00 2001
From: tk <fiyne1a@dingtalk.com>
Date: Wed, 29 May 2024 15:45:06 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20Home?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Home.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/Home.md b/Home.md
index 3e95041..d292029 100644
--- a/Home.md
+++ b/Home.md
@@ -86,9 +86,58 @@
 
 ## 邮箱接码流程
 1. 获取邮箱号（<a href="http://test.api.cc.line92.com/index.html#/%E7%AE%A1%E7%90%86%E6%9C%8D%E5%8A%A1/mail.code/api-adm-mail.code-get.email-Post" target="_blank">文档</a>）
+
+成功响应示例：
+``` json
+{
+  "code": "succeed",  // 使用if ( code == "succeed" ) 判定获取成功。
+  "data": {
+    "email": "kerwinnskinnerroman@gmail.com", // email 地址
+    "id": 552154460643333 // 业务流水号，存下来，在后续的接口调用中要传入。
+  }
+}
+```
+
+失败响应示例：
+``` json
+{
+  "code": "unexpected", // 错误码
+  "msg": "无可用邮箱号"// 错误原因
+}
+```
 2. 拿到邮箱号输入目标程序发送验证码
 3. 获取邮件码（<a href="http://test.api.cc.line92.com/index.html#/%E7%AE%A1%E7%90%86%E6%9C%8D%E5%8A%A1/mail.code/api-adm-mail.code-get-Post" target="_blank">文档</a>），此步骤需要多次尝试，建议设定请求间隔为5s，持续5min
 
+取到码响应示例：
+``` json
+{
+  "code": "succeed",
+  "data": {
+    "receiveStatus": "received",    // 如果取到邮件验证码 此字段值为 “received”
+    "mailCode": "1234" // 邮件验证码
+  }
+}
+```
+
+未取到码示例：
+``` json
+{
+  "code": "succeed",
+  "data": { 
+    "receiveStatus": "waiting"  // 如果是waiting，说明还在取码中，可等待几秒再调用此接口
+  }
+}
+```
+
+``` json
+{
+  "code": "succeed",
+  "data": {
+    "receiveStatus": "timeout" // 如果是timeout，说明长时间未收到验证码，系统已经自动释放了该邮箱号，不会再去收码了。
+  }
+}
+```
+
 
 ### 拉黑邮箱号
 如果不希望获取到某个邮箱号，可以调用此接口（<a href="http://test.api.cc.line92.com/index.html#/%E7%AE%A1%E7%90%86%E6%9C%8D%E5%8A%A1/mail.code/api-adm-mail.code-ban.email-Post" target="_blank">文档</a>）拉黑，拉黑之后可确保24小时内不会再次取到此邮箱号。