SY-P01-1.1.001
API: mail/log - 历史明细查询
概览
mail/log
是 SUBMAIL 的历史明细查询API。使用 mail/log
可以实时查询已发送的邮件历史明细数据。
请注意:
- 该接口请求限制为每分钟1次,时间间隔内返回上一次查询的缓存数据。
- 请注意 start_date(开始日期)和 end_date(结束日期)参数,当有其他筛选条件时,该时间段内查询不到时会返回无记录
URL
https://api-v4.mysubmail.com/mail/log
支持格式
格式 | URL |
---|---|
json | https://api-v4.mysubmail.com/mail/log.json (默认) |
http 请求方式
请求方式 | content-type设置 |
---|---|
http post | multipart/form-data 、x-www-form-urlencoded 、application/json |
是否需要授权
是
参阅 API 授权和验证机制
sms/log 请求参数
参数 | 类型 | 必需/可选 | 默认 | 描述 |
---|---|---|---|---|
appid | string | 必需 | 无 | 在 SUBMAIL 应用集成中创建的邮件应用ID |
app | string | 可选 | 无 | 指定appid,返回该appid下的发送数据 |
start_date | UNIX 时间戳 | 可选 | 1天前 | 开始时间,unix时间戳,精确到秒 eg:1640100000 |
end_date | UNIX 时间戳 | 可选 | 当前时间 | 结束时间,unix时间戳,精确到秒 eg:1640100000 |
to | string | 可选 | 无 | 查询特定的手机号码 |
send_id | string | 可选 | 无 | 查询特定的 Send ID |
status | string | 可选 | 无 | 可选参数:delivered、dropped、sending、warmup、bounce ,分别对应成功、失败、正在发送、预热中、回弹 |
rows | int | 可选 | 50 | 返回的数据行数 |
offset | int | 可选 | 0 | 数据偏移值(与sql翻页操作方法一致) |
timestamp | UNIX 时间戳 | 可选 | 无 | 参阅 API 授权与验证机制 > Timestamp UNIX 时间戳 |
sign_type | string | 可选 | normal | API 授权模式( md5 or sha1 or normal )参阅 API 授权与验证机制 > 授权和验证方式 |
signature | string | 必需 | 无 | 应用密匙或数字签名 参阅 API授权与验证机制 > 授权和验证方式 |
代码示例
发送 CURL请求
curl -d "appid=your_appid&signature=your_appkey" https://api-v4.mysubmail.com/mail/log
返回
{
"status": "success", //API请求状态
"start_date": 1644152198, //日志查询开始日期
"end_date": 1644238598, //日志查询结束日期
"total": 724, // 记录数
"offset": 0, // 数据偏移值
"results": 50, //每页行数
"data": [ //数据
{
"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"
}