投递回应

用户发送的邮件状态列表

你可以对此列表进行查询操作

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	api_user 名称
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
}

此代码块在浮窗中显示