短信HTTP接口文檔

1、 官網(wǎng)：閱信短信HTTP接口文檔v3.0.2北京金樓世紀(jì)科技有限公司2016年03月目錄1. 概述31.1 名詞定義31.2 工作方式31.3 字符編碼31.4 計費方式32. 下行消息42.1 提交參數(shù)說明42.2 返回值說明42.3 返回內(nèi)容示例53. 上行消息&狀態(tài)報告63.1 上行消息參數(shù)說明63.2 短信狀態(tài)報告參數(shù)說明63.3 語音狀態(tài)報告參數(shù)說明63.4 返回值74. 余額查詢84.1 提交參數(shù)說明84.2 返回參數(shù)說明84.3 返回內(nèi)容示例85. 上行消息&狀態(tài)報告主動查詢95.1 提交參數(shù)說明95.2 返回參數(shù)說明95.3 返回內(nèi)容示例96. 附錄A111.

2、概述 本接口規(guī)范定義了短信系統(tǒng)（服務(wù)方）與客戶系統(tǒng)（客戶方）之間的數(shù)據(jù)傳輸協(xié)議及使用方法。通過這個接口規(guī)范可以實現(xiàn)客戶系統(tǒng)(通過短信系統(tǒng))與手機終端之間的消息傳送。1.1 名詞定義1.1.1 下行消息 下行消息又稱MT消息，是指由業(yè)務(wù)系統(tǒng)送到短信平臺,再轉(zhuǎn)發(fā)到運營商的網(wǎng)關(guān)，并最終發(fā)送到手機終端上的文字信息。1.1.2 上行消息 上行消息又稱MO消息，是指由手機終端發(fā)送至短信短信平臺并最終送到客戶系統(tǒng)的文字信息。1.1.3 狀態(tài)報告 狀態(tài)報告是一條特殊上行消息，用于報告下行消息的投遞情況。即消息被送達到手機終端后返回的消息。并不是每一條下行消息都會有對應(yīng)的狀態(tài)報告。1.2 工作方式雙方通過HTT

3、P方式交互數(shù)據(jù)，可以簡單的“name=value”方式發(fā)送提交內(nèi)容或響應(yīng)請求內(nèi)容。即通過HTTP的GET/POST方式交換。1.3 字符編碼關(guān)于短消息內(nèi)容，服務(wù)端發(fā)送和接收數(shù)據(jù)均以UTF-8編碼和解碼。1.4 計費方式 短短信：短信內(nèi)容70字（含）以內(nèi)，按70字1條計費。 長短信：短信內(nèi)容70字以上，最大1000字，按67字1條計費。2. 下行消息接口URL地址：26:9000/HttpSmsMt提交方式：GETPOST（建議使用POST，批量提交用戶必須使用POST）2.1 提交參數(shù)說明參數(shù)名稱參數(shù)說明備注name帳號（必選）pwd密碼（必選）32位MD5

4、小寫值。需要用給定的密碼拼接發(fā)送時間進行再次MD5加密。MD5(pwd+mttime)subid擴展碼（可選）用戶自定義的子用戶接入號擴展碼。phone手機號碼（必選）11位的有效手機號碼。群發(fā)多個手機號，用英文半角逗號“，”隔開，手機號最大個數(shù)為1000個。content短信內(nèi)容（必選）GET提交需要對內(nèi)容進行URL編碼。Javascript提交需要對內(nèi)容進行2次URL編碼。POST提交不需要對內(nèi)容進行URL編碼。短信內(nèi)容最長為1000個字符。mttime發(fā)送時間（必選）時間格式：yyyyMMddhhmmssextend擴展字段（可選）用戶自定義擴展字段，推送狀態(tài)報告時返回。rpttype返

5、回數(shù)據(jù)類型（必選）值為：12.2 返回值說明參數(shù)名稱參數(shù)說明備注ReqCode返回值返回值，參見附錄AReqMsg返回值說明返回值說明ReqId提交批次ID匹配狀態(tài)報告使用2.3 返回內(nèi)容示例"ReqCode": "00","ReqMsg": "提交成功", "ReqId": "20160101080000000123456"3. 上行消息&狀態(tài)報告用戶提供接收上行消息和狀態(tài)報告的URL地址，短信平臺給用戶及時推送上行消息和狀態(tài)報告。上行消息和狀態(tài)報告可共用1個URL

6、地址，也可分開用2個URL地址。狀態(tài)報告需要用戶根據(jù)下行消息時返回的ReqId和phone進行匹配。3.1 上行消息參數(shù)說明參數(shù)名稱參數(shù)說明msgtype0為上行消息phone手機號subid擴展號content上行短信內(nèi)容receivetime上行消息接收時間，格式y(tǒng)yyyMMddHHmmss3.2 短信狀態(tài)報告參數(shù)說明參數(shù)名稱參數(shù)說明msgtype2為狀態(tài)報告phone手機號reqidReqId發(fā)送批次IDextend用戶自定義擴展字段，返回用戶提交時的值。receivetime狀態(tài)報告接收時間，格式y(tǒng)yyyMMddHHmmsssendtime短信下發(fā)時間，格式y(tǒng)yyyMMddHHmmss

7、state狀態(tài)報告碼3.3 語音狀態(tài)報告參數(shù)說明參數(shù)名稱參數(shù)說明msgtype2為狀態(tài)報告phone手機號reqidReqId發(fā)送批次IDreceivetime狀態(tài)報告接收時間，格式y(tǒng)yyyMMddHHmmsssendtime短信下發(fā)時間，格式y(tǒng)yyyMMddHHmmssendtime語音結(jié)束時間，格式y(tǒng)yyyMMddHHmmssstate狀態(tài)報告碼3.4 返回值用戶在接收到上行消息和狀態(tài)報告時，需要返回內(nèi)容“ok”。4. 余額查詢 接口URL地址：26:9000/HttpSmsBalance4.1 提交參數(shù)說明參數(shù)名稱參數(shù)說明備注name帳號（必選）pwd

8、密碼（必選）同6.1rpttype返回數(shù)據(jù)類型（必選）值為：14.2 返回參數(shù)說明參數(shù)名稱參數(shù)說明備注ReqCode返回值返回值，參見附錄AReqMsg返回值說明返回值說明Balance余額-1為后付費，其他為具體余額。4.3 返回內(nèi)容示例"ReqCode": "00","ReqMsg": "提交成功", "Balance": "1234"5. 上行消息&狀態(tài)報告主動查詢上行消息和狀態(tài)報告推薦使用第7節(jié)方式，由短信平臺主動推送給用戶。用戶主動查詢方式即時性不高，效率較

9、低。只在用戶業(yè)務(wù)無法實現(xiàn)被動接收的情況下使用。接口URL地址：26:9000/HttpSmsRpt 每次查詢返回最多100個上行消息和狀態(tài)報告。5.1 提交參數(shù)說明參數(shù)名稱參數(shù)說明備注name帳號（必選）pwd密碼（必選）同6.1mttime發(fā)送時間（必選）時間格式：yyyyMMddhhmmssrpttype返回數(shù)據(jù)類型（必選）值為：15.2 返回參數(shù)說明參數(shù)名稱參數(shù)說明MsgType0為上行消息2為狀態(tài)報告ReqId提交批次IDSubId擴展碼Phone手機號Content短信內(nèi)容Sendtime短信下發(fā)時間，格式y(tǒng)yyyMMddHHmmssReceive

10、time狀態(tài)報告接收時間，格式y(tǒng)yyyMMddHHmmssEndtime語音結(jié)束時間，格式y(tǒng)yyyMMddHHmmssState狀態(tài)報告碼5.3 返回內(nèi)容示例 "ReqCode": "00", "Rpts": "MsgType": "2", "ReqId": "20160101080000000123456", "SubId": "1234", "Phone": "/p>

11、", "Content": "", "Sendtime": "20160101080000", "Receivetime": "20160101080000", "Endtime": "", "State": "0" 6. 附錄AReqId返回值返回值說明備注00提交成功01提交參數(shù)異常提交參數(shù)不完成，卻少必須參數(shù)。02手機號參數(shù)異常03擴展號參數(shù)異常04發(fā)送時間參數(shù)異常05短信內(nèi)容解析