API: SMS/Reports - 短信分析報告
概覽
sms/reports 是 SUBMAIL 的短信分析報告 API
URL
https://api-v4.mysubmail.com/sms/reports
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/sms/reports.json（默認(rèn)） |
xml | https://api-v4.mysubmail.com/sms/reports.xml |
yaml | https://api-v4.mysubmail.com/sms/reports.yaml |
http 請求方式
| 請求方式 | content-type設(shè)置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗(yàn)證機(jī)制
請求參數(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)證方式。當(dāng)sign_type=normal時signature應(yīng)傳appkey的值。 |
start_date | UNIX 時間戳 | 可選 | 7 天前 | 報告開始時間，unix時間戳，精確到秒 eg:1640100000 |
end_date | UNIX 時間戳 | 可選 | 1天前 | 報告結(jié)束時間，unix時間戳，精確到秒 eg:1640200000 |
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)證方式 |
代碼示例
發(fā)送 CURL請求
curl -d "appid=your_app_id&start_date=1640100000&end_date=1640200000&signature=your_app_key" https://api-v4.mysubmail.com/sms/reports返回
{
"status": "success", //請求狀態(tài)
"start_date": "2021-12-21", // 開始日期
"end_date": "2021-12-22", // 結(jié)束日期
"overview": { //概覽
"request": 760, // API請求
"deliveryed": 718, // 成功數(shù)
"dropped": 42, // 失敗數(shù)
"fee": 838, // 計費(fèi)數(shù)
"operators": { //運(yùn)營商占比
"china_mobile": 319, //移動
"china_unicom": 196, // 聯(lián)通
"china_telecom": 213 // 電信
},
"location": { // 地區(qū)分類
"province": { //省份
"UNKOWN": 24,
"上海": 186,
"云南": 12,
"內(nèi)蒙古": 3,
"北京": 43,
"吉林": 12,
"四川": 29,
"天津": 3,
"寧夏": 3,
"安徽": 35,
"山東": 36,
"山西": 18,
"廣東": 84,
"廣西": 6,
"新疆": 1,
"江蘇": 63,
"江西": 7,
"河北": 7,
"河南": 20,
"浙江": 43,
"海南": 9,
"湖北": 17,
"湖南": 32,
"甘肅": 1,
"福建": 6,
"貴州": 20,
"遼寧": 9,
"重慶": 7,
"陜西": 11,
"青海": 2,
"黑龍江": 9
},
"cities": { //城市
"UNKOWN": 24,
"上海 上海": 186,
"云南 昆明": 1,
"云南 普洱": 2,
"云南 紅河": 9,
"內(nèi)蒙古 通遼": 2,
"內(nèi)蒙古 鄂爾多斯": 1,
"北京 北京": 43,
"吉林 吉林": 2,
"吉林 松原": 1,
"吉林 通化": 5,
"吉林 長春": 4,
"四川 樂山": 4,
"四川 成都": 20,
"四川 瀘州": 1,
"四川 眉山": 2,
"四川 雅安": 2,
"天津 天津": 3,
"寧夏 吳忠": 2,
"寧夏 石嘴山": 1,
"安徽 合肥": 11,
"安徽 安慶": 5,
"安徽 宿州": 2,
"安徽 池州": 5,
"安徽 淮南": 3,
"安徽 滁州": 7,
"安徽 阜陽": 2,
"山東 臨沂": 1,
"山東 威海": 2,
"山東 日照": 2,
"山東 棗莊": 1,
"山東 濟(jì)南": 12,
"山東 濟(jì)寧": 2,
"山東 煙臺": 5,
"山東 菏澤": 5,
"山東 青島": 6,
"山西 大同": 2,
"山西 太原": 3,
"山西 晉城": 10,
"山西 運(yùn)城": 2,
"山西 長治": 1,
"廣東 東莞": 6,
"廣東 中山": 4,
"廣東 佛山": 2,
"廣東 廣州": 27,
"廣東 惠州": 3,
"廣東 揭陽": 2,
"廣東 汕頭": 2,
"廣東 汕尾": 2,
"廣東 深圳": 32,
"廣東 潮州": 2,
"廣東 珠海": 1,
"廣東 茂名": 1,
"廣西 北海": 1,
"廣西 南寧": 1,
"廣西 柳州": 1,
"廣西 桂林": 1,
"廣西 玉林": 2,
"新疆 和田": 1,
"江蘇 南京": 17,
"江蘇 南通": 4,
"江蘇 宿遷": 1,
"江蘇 常州": 7,
"江蘇 徐州": 4,
"江蘇 揚(yáng)州": 1,
"江蘇 無錫": 6,
"江蘇 淮安": 2,
"江蘇 鹽城": 2,
"江蘇 蘇州": 19,
"江西 吉安": 3,
"江西 萍鄉(xiāng)": 1,
"江西 贛州": 3,
"河北 保定": 1,
"河北 石家莊": 2,
"河北 邢臺": 4,
"河南 信陽": 2,
"河南 南陽": 4,
"河南 新鄉(xiāng)": 3,
"河南 洛陽": 2,
"河南 鄭州": 9,
"浙江 麗水": 1,
"浙江 臺州": 5,
"浙江 嘉興": 5,
"浙江 寧波": 9,
"浙江 杭州": 11,
"浙江 溫州": 5,
"浙江 湖州": 1,
"浙江 衢州": 2,
"浙江 金華": 4,
"海南 ?？?quot;: 9,
"湖北 十堰": 1,
"湖北 宜昌": 1,
"湖北 武漢": 9,
"湖北 荊門": 4,
"湖北 襄陽": 2,
"湖南 湘潭": 2,
"湖南 益陽": 4,
"湖南 邵陽": 8,
"湖南 郴州": 2,
"湖南 長沙": 16,
"甘肅 蘭州": 1,
"福建 廈門": 1,
"福建 漳州": 1,
"福建 福州": 2,
"福建 莆田": 2,
"貴州 貴陽": 11,
"貴州 遵義": 2,
"貴州 銅仁": 2,
"貴州 黔東南": 3,
"貴州 黔西南": 2,
"遼寧 大連": 3,
"遼寧 沈陽": 2,
"遼寧 遼陽": 4,
"重慶 重慶": 7,
"陜西 商洛": 1,
"陜西 渭南": 4,
"陜西 西安": 6,
"青海 西寧": 2,
"黑龍江 哈爾濱": 3,
"黑龍江 大慶": 2,
"黑龍江 鶴崗": 2,
"黑龍江 齊齊哈爾": 2
}
},
"dropped_reason_analysis": { //失敗原因分析
"號碼異常": 4,
"號碼錯誤": 2,
"無法投遞消息": 3,
"消息接收超時": 2,
"空號/停機(jī)/關(guān)機(jī)": 13
}
},
"timeline": [ //時間線
{
"date": "2021-12-21", //日期
"report": {
"request": 351, //API請求
"deliveryed": 335, //成功數(shù)
"dropped": 16, //失敗數(shù)
"fee": 392 //計費(fèi)數(shù)
}
}
]
}