投遞回應

查詢

用戶發送的郵件狀態清單

你可以對此清單進行査詢操作

URL

https://email.api.engagelab.cc/v1/email_status

          https://email.api.engagelab.cc/v1/email_status

此代碼塊在浮窗中顯示

HTTP 請求方式

GET

GET

此代碼塊在浮窗中顯示

請求 Headers

Header	類型	必須	說明
Authorization	String	true	Basic base64(api_user:api_key)

Query 參數說明

參數	類型	必須	說明
offset	string	否	査詢起始位置，取值區間 [0-]，默認為 0
limit	int	否	査詢個數，取值區間 [0-100]，默認為 100
send_date	string	是	發送日期，格式為`yyyy-MM-dd`
email	string	否	收件人地址
email_ids	string	否	調用 api 發送郵件成功返回的 emailId. 多個地址使用';'分隔，如：`email_ids=a;b;c`
api_user	string	否	用戶的某個 API_USER
domain_name	string	否	接收域，例如：gmail.com。
label_id	string	否	用戶創建的標籤對應的標籤 ID
status	string	否	査詢投遞回應狀態。請求中值為 18；送達值為 1；軟退信值為 5；無效郵件值為 4。
sub_status	string	否	查詢无效邮件或软退信子类，多个无效子类使用';'分隔，如：subStatus=a;b;c。當傳入本參數時，status 參數無效。

注意：

每次査詢默認只査詢 100 條記錄，如果用戶査詢滿足條件的記錄數超過 100 時候，需要人為指定 offset 和 limit 參數。

每次査詢得到的對應的記錄會根據用戶所傳參數緩存 10 分鐘。

此接口限制每個用戶帳戶，每分鐘調用接口 60 次。若不能滿足您的需求，請使用 WebHook。

傳入 email 地址，可查詢 send_date 之後 30 天該地址的投遞明細；若未傳入 email 地址，則僅能查詢 send_date 當天的數據明細。

sub_status	sub_stat_desc
401	無效郵件-平臺黑名單
402	無效郵件-取消訂閱
403	無效郵件-服務器不可達
404	無效郵件-地址格式錯誤
405	無效郵件-IP、域名被拒
406	無效郵件-地址不存在
407	無效郵件-垃圾郵件
408	無效郵件-發件人/收件人被拒
409	無效郵件-其他
503	軟退信-服務不可達
505	軟退信-IP、域名被拒
506	軟退信-郵箱地址不存在
507	軟退信-反垃圾郵件被拒
508	軟退信-發件人/收件人被拒
509	軟退信-其他

請求示例：

curl "https://email.api.engagelab.cc/v1/email_status?send_date=2022-11-21&email_ids=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

          
curl "https://email.api.engagelab.cc/v1/email_status?send_date=2022-11-21&email_ids=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

此代碼塊在浮窗中顯示

響應說明

參數	說明
email	收件人地址
email_id	調用 api 發送郵件成功返回的 emailId
api_user	apiUser 名稱
status	投遞狀態
status_desc	投遞狀態描敘
sub_status	401-509 無效狀態碼
sub_status_desc	無效或軟退信子類描述
request_time	請求時間
update_time	狀態更新時間
response_message	發送結果消息

響應示例：

{ "result": [ { "email_id": "1668065941982_15_2032_7460.sc-10_2_226_96-test0$1720f4a1d6af047181@hotmail.com", "api_user": "zymtest4", "email": "1720f4a1d6af047181@hotmail.com", "request_time": "2022-11-10T15:39:01+0800", "update_time": "2022-11-10T17:34:16+0800", "status": 4, "sub_status": 409, "status_desc": "Invalid Email", "sub_status_desc": "Other", "response_message": "Other(scheduler: deleted)" } ], "total": "48675", "count": 1 }

          {
    "result": [
        {
            "email_id": "1668065941982_15_2032_7460.sc-10_2_226_96-test0$1720f4a1d6af047181@hotmail.com",
            "api_user": "zymtest4",
            "email": "1720f4a1d6af047181@hotmail.com",
            "request_time": "2022-11-10T15:39:01+0800",
            "update_time": "2022-11-10T17:34:16+0800",
            "status": 4,
            "sub_status": 409,
            "status_desc": "Invalid Email",
            "sub_status_desc": "Other",
            "response_message": "Other(scheduler: deleted)"
        }
    ],
    "total": "48675",
    "count": 1
}

此代碼塊在浮窗中顯示