SUBMAIl CMPP 協(xié)議接入文檔
SUBMAIL CMPP 協(xié)議基于中國移動短消息 CMPP 2 通訊協(xié)議。
參考開發(fā)文檔:《中國移動通信 互聯(lián)網(wǎng)短信網(wǎng)關接口協(xié)議 (China Mobile Peer to Peer, CMPP) (V2.0)》
基于 CMPP 通訊協(xié)議,接入 SUBMAIL CMPP 可實現(xiàn)短消息發(fā)送、狀態(tài)和短消息上行等功能;要接入SUBMAIL CMPP 網(wǎng)關,請前往 短信-》創(chuàng)建/管理 AppID 頁面創(chuàng)建一個 CMPP 應用;
參數(shù)示例
CMPP參數(shù) | 示例 | 描述 |
---|---|---|
IP/URL | cmpp.mysubmail.com | 接口URL,如果您的系統(tǒng)僅支持 IP 對接或無法使用域名,請聯(lián)系商務或售后支持 |
Port | 7890 | CMPP 端口號 |
User / SP_ID | appid | SP_ID /用戶名;前往 短信-》創(chuàng)建/管理 AppID 頁面獲取 |
Password | cmpp key | 密碼;前往 短信-》創(chuàng)建/管理 AppID 頁面獲取 |
Src_Id | appid | 企業(yè)ID/接入號;前往 短信-》創(chuàng)建/管理 AppID 頁面獲取 |
請注意:
- 每個獨立的 CMPP 應用默認為 1 個TCP鏈路,初始流速默認為 100/秒;
- CMPP 要求必須指定一個 授權的 IP 進行綁定;您可以綁定多個 IP;
- 當一個鏈路已成功登錄后,其他鏈路將無法繼續(xù)使用該 APPID 進行登錄;
- CMPP 短消息正文編碼統(tǒng)一采用 UCS 2 編碼即 Msg_Fmt = 8,其他編碼均不被支持;
- CMPP 應用支持 6 位自定義擴展
SUBMAIL CMPP 網(wǎng)關支持大多數(shù)的常用 CMPP 指令
CMPP 指令支持列表
指令 | 指令描述 |
---|---|
CMPP_CONNECT | 連接/登錄 |
CMPP_TERMINATE | 鏈路拆除 |
CMPP_SUBMIT | 短消息發(fā)送 |
CMPP_DELIVER | 回執(zhí)/短消息上行 |
CMPP_ACTIVE_TEST | 鏈路檢測(心跳包) |
除上述列表中的指令外,其他 CMPP 指令均不被支持;如遇特殊需求,請聯(lián)系商務或售后支持;
關于長短信
SUBMAIl CMPP 網(wǎng)關支持長短信發(fā)送,最大字符限制為1000 字,包含簽名,正文、標點符號和空格;
要發(fā)送長短信,請正確的設置 TP_udhi 、 Pk_total 和 Pk_number 參數(shù);
正文 UDHI 頭采用 6 字節(jié) UDHI,格式:05 00 03 XX MM NN
- byte 1 : 05, 表示剩余協(xié)議頭的長度
- byte 2 : 00, 這個值在GSM 03.40規(guī)范9.2.3.24.1中規(guī)定,表示隨后的這批超長短信的標識位長度為1(格式中的XX值)
- byte 3 : 03, 這個值表示剩下短信標識的長度
- byte 4 : XX,這批短信的唯一標志(被拆分的多條短信,此值必需一致),事實上,SME(手機或者SP)把消息合并完之后,就重新記錄,所以這個標志是否唯 一并不是很 重要。
- byte 5 : MM, 這批短信的數(shù)量。如果一個超長短信總共5條,這里的值就是5。
- byte 6 : NN, 當前短信的序號。如果當前短信是這批短信中的第一條的值是1,第二條的值是2。
示例:05 00 03 39 02 01
錯誤/狀態(tài)碼
SUBMAIL CMPP 網(wǎng)關除透傳短消息實際狀態(tài)外會有一些特殊的狀態(tài)碼,如模板審核拒絕、頻率超限、余額不足等
狀態(tài)碼 | 交互方式 | 描述 |
---|---|---|
SUBERRL | CMPP_DELIVER | 提交失?。ㄩL短信并包超時) |
SIGNERR | CMPP_DELIVER | 短信正文未包含短信簽名,或短信簽名沒有前置 |
CONTERR | CMPP_DELIVER | 短信正文超過最大長度限制(1000字) |
BEYONDD | CMPP_DELIVER | CMPP應用請求超限(請前往短信-》創(chuàng)建/管理 APPID 頁面設置發(fā)送限制參數(shù)) |
FRQEBYD | CMPP_DELIVER | 發(fā)送超限(相同內(nèi)容同一天內(nèi)對同一手機號發(fā)送超過15條) |
UBLOCKD | CMPP_DELIVER | 自定義黑名單 (請前往短信-》創(chuàng)建/管理 APPID 頁面設置或管理黑名單) |
REJECTD | CMPP_DELIVER | 審核拒絕 此狀態(tài)與網(wǎng)關REJECTD狀態(tài)碼一致,如遇相同內(nèi)容全部返回該錯誤碼,則模板審核被拒,請前往 短信-》創(chuàng)建 /管理模板頁面查看具體駁回原因,修改后重新提交該模板進行審核即可正常發(fā)送 |
BALANCU | CMPP_DELIVER | 通用/運營類短信余額不足 |
BALANCT | CMPP_DELIVER | 事務類短信余額不足 |
NOROUTE | CMPP_DELIVER | 無路由 |
BLOCKED | CMPP_DELIVER | 系統(tǒng)屏蔽 |
BEYONDT | CMPP_DELIVER | 模板發(fā)送超限;請前往 短信-》創(chuàng)建 /管理模板頁面 更改此模板發(fā)送限制 |
UNSUBED | CMPP_DELIVER | 用戶已退訂;請前往 短信-》上行交互頁面設置取消退訂規(guī)則 |