API: SMS/MO - 短信上行查詢
概覽
sms/mo 是 SUBMAIL 的短信上行查詢API。使用 sms/mo 可以實時查詢短信上行回復(fù)。
請注意：
- 該接口請求限制為每分鐘1次，時間間隔內(nèi)返回上一次查詢的緩存數(shù)據(jù)。
- 請注意 start_date（開始日期）和 end_date（結(jié)束日期）參數(shù)，當(dāng)有其他篩選條件時，該時間段內(nèi)查詢不到時會返回?zé)o記錄
URL
https://api-v4.mysubmail.com/sms/mo
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/sms/mo.json（默認(rèn)） |
xml | https://api-v4.mysubmail.com/sms/mo.xml |
yaml | https://api-v4.mysubmail.com/sms/mo.yaml |
http 請求方式
| 請求方式 | content-type設(shè)置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗證機(jī)制
sms/mo 請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短信應(yīng)用ID |
signature | string | 必需 | 無 | 應(yīng)用密匙或數(shù)字簽名 參閱 API授權(quán)與驗證機(jī)制 > 授權(quán)和驗證方式 |
start_date | UNIX 時間戳 | 可選 | 7天前 | 開始時間，unix時間戳，精確到秒 eg:1640100000 |
end_date | UNIX 時間戳 | 可選 | 當(dāng)前時間 | 結(jié)束時間，unix時間戳，精確到秒 eg:1640100000 |
from | string | 可選 | 無 | 查詢特定的手機(jī)號碼 |
rows | int | 可選 | 50 | 返回的數(shù)據(jù)行數(shù) |
offset | int | 可選 | 0 | 數(shù)據(jù)偏移值（與sql翻頁操作方法一致） |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機(jī)制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式（ md5 or sha1 or normal ）參閱 API 授權(quán)與驗證機(jī)制 > 授權(quán)和驗證方式 |
代碼示例
發(fā)送 CURL請求
curl -d "appid=your_appid&signature=your_appkey" https://api-v4.mysubmail.com/sms/mo返回
{
"status": "success", // API 請求狀態(tài)
"start_date": 1652554968, //開始日期
"end_date": 1653159768, //結(jié)束日期
"total": 2, //查詢總數(shù)
"offset": 0, //數(shù)據(jù)偏移值
"results": 2, //返回結(jié)果數(shù)
"mo": [
{
"appid": "3xxxx", // appid
"from": "158xxxxxxxx", // 回復(fù)手機(jī)號
"content": "你好 xxxx", // 回復(fù)正文
"reply_at": 1653026354, // 回復(fù)時間
"sms_content":"下行短信內(nèi)容",
"sendlist":"批次號"
},
{
"appid": "3xxxx", // appid
"from": "132xxxxxxxx", // 回復(fù)手機(jī)號
"content": "td", // 回復(fù)正文
"reply_at": 1652573228, // 回復(fù)時間
"sms_content":"下行短信內(nèi)容",
"sendlist":"批次號"
}
]
}請求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}