API: SMS/Log - 歷史明細(xì)查詢
概覽
sms/log 是 SUBMAIL 的歷史明細(xì)查詢API。使用 sms/log 可以實(shí)時(shí)查詢已發(fā)送的短信歷史明細(xì)數(shù)據(jù)。
請(qǐng)注意：
- 該接口請(qǐng)求限制為每分鐘1次，時(shí)間間隔內(nèi)返回上一次查詢的緩存數(shù)據(jù)。
- 請(qǐng)注意 start_date（開始日期）和 end_date（結(jié)束日期）參數(shù)，當(dāng)有其他篩選條件時(shí)，該時(shí)間段內(nèi)查詢不到時(shí)會(huì)返回?zé)o記錄
URL
https://api-v4.mysubmail.com/sms/log
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/sms/log.json（默認(rèn)） |
xml | https://api-v4.mysubmail.com/sms/log.xml |
yaml | https://api-v4.mysubmail.com/sms/log.yaml |
http 請(qǐng)求方式
| 請(qǐng)求方式 | content-type設(shè)置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗(yàn)證機(jī)制
sms/log 請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短信應(yīng)用ID |
signature | string | 必需 | 無 | 應(yīng)用密匙或數(shù)字簽名 參閱 API授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
app | string | 可選 | 無 | 指定appid，返回該appid下的發(fā)送數(shù)據(jù) |
start_date | UNIX 時(shí)間戳 | 可選 | 1天前 | 開始時(shí)間，unix時(shí)間戳，精確到秒 eg:1640100000 |
end_date | UNIX 時(shí)間戳 | 可選 | 當(dāng)前時(shí)間 | 結(jié)束時(shí)間，unix時(shí)間戳，精確到秒 eg:1640100000 |
to | string | 可選 | 無 | 查詢特定的手機(jī)號(hào)碼 |
send_id | string | 可選 | 無 | 查詢特定的 Send ID |
sendlist | string | 可選 | 無 | 查詢特定的發(fā)送任務(wù)，（batchsend,batchxsend和timedtask接口的batchlist 參數(shù)） |
status | string | 可選 | 無 | delivered或dropped，如需查詢所有成功的明細(xì)請(qǐng)將該參數(shù)設(shè)置為：delivered，查詢失敗則傳參 dropped |
rows | int | 可選 | 50 | 返回的數(shù)據(jù)行數(shù) |
offset | int | 可選 | 0 | 數(shù)據(jù)偏移值（與sql翻頁操作方法一致） |
timestamp | UNIX 時(shí)間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗(yàn)證機(jī)制 > Timestamp UNIX 時(shí)間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式（ md5 or sha1 or normal ）參閱 API 授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
代碼示例
發(fā)送 CURL請(qǐng)求
curl -d "appid=your_appid&signature=your_appkey" https://api-v4.mysubmail.com/sms/log返回
{
"status": "success", //API請(qǐng)求狀態(tài)
"start_date": 1644152198, //日志查詢開始日期
"end_date": 1644238598, //日志查詢結(jié)束日期
"total": 724, // 記錄數(shù)
"offset": 0, // 數(shù)據(jù)偏移值
"results": 50, //每頁行數(shù)
"data": [ //數(shù)據(jù)
{
"sendID": "f3a34daf58210d498917f31c7d26693f", //send ID
"to": "xxx", // 手機(jī)號(hào)碼
"appid": "xxx", // AppID
"template_id": "xxx", //模板ID
"sms_signature": "【xx】", //短信簽名
"sms_content": "您本次登錄的驗(yàn)證碼：xxx", //短信正文
"fee": 1, // 計(jì)費(fèi)條數(shù)
"status": "delivered", //發(fā)送狀態(tài) ，delivered = 成功 ， dropped = 失敗 ， pending=未知（運(yùn)營商未返回）
"report_state": "DELIVRD", // 運(yùn)營商返回的實(shí)際狀態(tài) DELIVRD = 成功，其他均為失敗 pending=未知（運(yùn)營商未返回）
"location": "廣東 廣州", //手機(jī)號(hào)歸屬地
"mobile_type": "中國移動(dòng)", // 手機(jī)運(yùn)營商
"ip_address": "xxx", // 發(fā)送IP
"send_at": 1644209557, // 請(qǐng)求時(shí)間
"sent_at": 1644209557, //平臺(tái)發(fā)送時(shí)間
"report_at": 1644209561 //運(yùn)營商狀態(tài)匯報(bào)時(shí)間（一般為用戶的手機(jī)收到短信的時(shí)間）
},
{
"sendID": "c7770e74d84377a5cdad844131e46b96",
"to": "xxx",
"appid": "xxx",
"template_id": "xxx",
"sms_signature": "【xxx】",
"sms_content": "您本次登錄的驗(yàn)證碼：xxx",
"fee": 0, // 計(jì)費(fèi)條數(shù)
"status": "dropped",
"report_state": "mk:0012",
"dropped_reason": "空號(hào)/停機(jī)", // 失敗原因，該參數(shù)僅在該條數(shù)據(jù)失敗時(shí)返回的原因分析
"location": "上海 上海",
"mobile_type": "中國移動(dòng)",
"ip_address": "xxx",
"send_at": 1644210137,
"sent_at": 1644210137,
"report_at": 1644210139
},
{…………}
]
}請(qǐng)求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}