SY-P01-1.1.001
API: mail/log - 歷史明細(xì)查詢
概覽
mail/log 是 SUBMAIL 的歷史明細(xì)查詢API。使用 mail/log 可以實(shí)時查詢已發(fā)送的郵件歷史明細(xì)數(shù)據(jù)。
請注意：
- 該接口請求限制為每分鐘1次，時間間隔內(nèi)返回上一次查詢的緩存數(shù)據(jù)。
- 請注意 start_date（開始日期）和 end_date（結(jié)束日期）參數(shù)，當(dāng)有其他篩選條件時，該時間段內(nèi)查詢不到時會返回?zé)o記錄
URL
https://api-v4.mysubmail.com/mail/log
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/mail/log.json（默認(rèn)） |
http 請求方式
| 請求方式 | content-type設(shè)置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗(yàn)證機(jī)制
sms/log 請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的郵件應(yīng)用ID |
app | string | 可選 | 無 | 指定appid，返回該appid下的發(fā)送數(shù)據(jù) |
start_date | UNIX 時間戳 | 可選 | 1天前 | 開始時間，unix時間戳，精確到秒 eg:1640100000 |
end_date | UNIX 時間戳 | 可選 | 當(dāng)前時間 | 結(jié)束時間，unix時間戳，精確到秒 eg:1640100000 |
to | string | 可選 | 無 | 查詢特定的手機(jī)號碼 |
send_id | string | 可選 | 無 | 查詢特定的 Send ID |
status | string | 可選 | 無 | 可選參數(shù)：delivered、dropped、sending、warmup、bounce，分別對應(yīng)成功、失敗、正在發(fā)送、預(yù)熱中、回彈 |
rows | int | 可選 | 50 | 返回的數(shù)據(jù)行數(shù) |
offset | int | 可選 | 0 | 數(shù)據(jù)偏移值（與sql翻頁操作方法一致） |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗(yàn)證機(jī)制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式（ md5 or sha1 or normal ）參閱 API 授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
signature | string | 必需 | 無 | 應(yīng)用密匙或數(shù)字簽名 參閱 API授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
代碼示例
發(fā)送 CURL請求
curl -d "appid=your_appid&signature=your_appkey" https://api-v4.mysubmail.com/mail/log返回
{
"status": "success", //API請求狀態(tài)
"start_date": 1644152198, //日志查詢開始日期
"end_date": 1644238598, //日志查詢結(jié)束日期
"total": 724, // 記錄數(shù)
"offset": 0, // 數(shù)據(jù)偏移值
"results": 50, //每頁行數(shù)
"data": [ //數(shù)據(jù)
{
"appid": "16473",
"sendID": "f52cf56f666a4d9b588d20cc6f0ca644",
"to_address": "sum@mysubmail.com",
"to_name": "",
"from_address": "submail@submail1.icu",
"from_name": "",
"reply": "",
"subject": "Verification",
"send_at": 1720772710,
"sent_at": 1720772715,
"status": 6,
"bounce": 0,
"ip_address": "180.172.122.117",
"message": ""
},
{
"appid": "16473",
"sendID": "67597661f4c545e0771a6979c5f0d25c",
"to_address": "sum@mysubmail.com",
"to_name": "",
"from_address": "submail@submail1.icu",
"from_name": "",
"reply": "",
"subject": "Verification",
"send_at": 1720772690,
"sent_at": 1720772694,
"status": 6,
"bounce": 0,
"ip_address": "180.172.122.117",
"message": ""
},
{…………}
]
}請求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}