SUBMAIL API V4 更新文檔
概覽
SUBMAIL API V4 是基于 API V3 的重構,大幅提高了系統(tǒng)穩(wěn)定性和運行效率;
新版 API 提供更多豐富的產品接口功能,優(yōu)化工作流,API 響應更迅捷,新版接口向下兼容(詳情請參閱新功能與接口變動-兼容性變動),業(yè)務層 100% 兼容舊版 API;
本次更新涉及產品
短信、國際短信、多媒體彩信(視頻/圖文)、語音、郵件、地址簿
如何升級?
URL | https://api-v4.mysubmail.com |
---|
從 V3 API 升級至新版 API,請將原接口域名 api.mysubmail.com
更換為 api-v4.mysubmail.com
即可完成接口升級(僅短信、國際短信、多媒體彩信(視頻/圖文)、語音、郵件、地址簿 等產品);
舊版接口 https://api.mysubmail.com/message/send
> 升級新版接口 https://api-v4.mysubmail.com/sms/send
新版接口同時支持 http
和 https
新特性
新增 yaml
返回碼格式;
新版本在原有的 xml
和 json
返回碼的基礎上增加了yaml
格式返回碼,要使用 yaml
返回碼,請在 API 接口的結尾使用 .yaml
后綴; 例:https://api-v4.mysubmail.com/service/timestamp.yaml
新增 SHA256 數(shù)字簽名模式
新功能與接口變動
短信
新增接口
- 增加 REPORT 離線分析報告接口
sms/reports
(查看開發(fā)文檔) - 增加群發(fā)接口
sms/batchsend
(查看開發(fā)文檔)與sms/batchxsend
(查看開發(fā)文檔) - 新版日志接口
sms/log
(查看開發(fā)文檔) sms/send
(查看開發(fā)文檔) 和sms/xsend
(查看開發(fā)文檔) 單發(fā)接口支持 GET 方式提交數(shù)據
兼容性變動
- 移除了短信發(fā)送接口返回碼中的
sms_credits
和transactional_sms_credits
短信余額參數(shù);要獲取當前余額請使用sms/balance
接口獲取 - 模板 API
template/get
中add_date
和edit_date
現(xiàn)在使用時間戳返回
新增 CMPP 協(xié)議支持
開放 CMPP 協(xié)議接入,SUBMAIL CMPP 協(xié)議基于中國移動短消息 CMPP 2 通訊協(xié)議( CMPP 接入文檔)
國際短信
兼容性變動
- 移除了國際短信發(fā)送接口返回碼中的
account_balance
余額參數(shù);要獲取當前余額請使用internationalsms/balance
接口獲取 - 模板 API
template/get
中add_date
和edit_date
現(xiàn)在使用時間戳返回
新增 SMPP 協(xié)議支持
開放 SMPP 協(xié)議接入 ,支持 SMPP 3.4 通訊協(xié)議(查看 SMPP 接入文檔)
多媒體彩信
兼容性變動
- 移除了彩信發(fā)送接口返回碼中的
money_account
余額參數(shù);要獲取當前余額請使用mms/balance
接口獲取 - 模板 API
template/get
中add_date
和edit_date
現(xiàn)在使用時間戳返回
語音
兼容性變動
- 移除了語音呼叫接口返回碼中的
money_account
余額參數(shù);要獲取當前余額請使用voice/balance
接口獲取 - 模板 API
template/get
中add_date
和edit_date
現(xiàn)在使用時間戳返回