【導(dǎo)讀】中國電信集團(tuán)公司企業(yè)標(biāo)準(zhǔn)?；诠潭娫捑W(wǎng)的信息終端及綜合信息系統(tǒng)技術(shù)規(guī)范。第七分冊(cè)短消息網(wǎng)關(guān)協(xié)議

　　

【正文】 發(fā)送時(shí)間，格式遵循 協(xié)議 sSrcTermId Char(22) 發(fā)送號(hào)碼 sChargeTermID Char(22) 計(jì)費(fèi)號(hào)碼 sDestTermID Char(22) 短消息接收號(hào)碼 nMsgLen Int 短消息長度 sMsgContent Char(*) 短消息 內(nèi)容（ nMsgLen=0 時(shí)表示存放短消息的文件名） sMsgID Char(11) 返回的短消息標(biāo)識(shí) 基于 固定 電話網(wǎng)的信息終端及綜合 信息系統(tǒng) 技術(shù)規(guī)范 第七分冊(cè) 第 23頁 nErrorCode Int* 錯(cuò)誤代碼（參照錯(cuò)誤代碼表）。 sMsgType Char(2) 短消息類型 sReserved Char(9) 保留 ? 返回 0=成功 1=失敗 群發(fā)短信（ SMGPSendBatch） ? 作用 向短消息網(wǎng)關(guān)發(fā)送 1 條短消息到多個(gè)手機(jī)用戶。短消息長度最長為 200，此函數(shù)使用文件傳遞短消息內(nèi)容。 SMGP API 在發(fā)送時(shí)自動(dòng)建立 Connection Pool，采用 長連接或者短連接發(fā)送短消息。當(dāng) Cache 的 connection 中斷時(shí)， API 能夠自動(dòng)重新連接短消息網(wǎng)關(guān)。如果應(yīng)用程序采用多線程發(fā)送短消息，多個(gè)線程共享同一個(gè) Connection Pool。在發(fā)送過程中，如果因?yàn)橥ㄐ旁驅(qū)е掳l(fā)送失敗， API 能夠自動(dòng)重新發(fā)送，重試的次數(shù)在配置文件設(shè)置。 ? 參數(shù) 參數(shù)名 數(shù)據(jù)類型 說明 nNeedReport Int 是否要求返回狀態(tài)報(bào)告（ 0=不要求， 1=要求） nMsgLevel Int 優(yōu)先級(jí)別，（ 0－ 9， 0表示最低優(yōu)先級(jí)） sServiceID Char(11) 業(yè)務(wù)類 型 nMsgFormat Int 短消息格式（參照短消息格式表）。網(wǎng)關(guān)不做判定 , 透明傳輸。 sFeeType Char(3) 資費(fèi)類別 sFeeCode Char(7) 資費(fèi)代碼（以分為單位） sFixedfee Char(7) 包月費(fèi) /封頂費(fèi)（以分為單位） sValidTime Char(18) 存活有效期，格式遵循 協(xié)議 sAtTime Char(18) 定時(shí)發(fā)送時(shí)間，格式遵循 協(xié)議 sSrcTermID Char(22) 短消息發(fā)送用戶號(hào)碼（當(dāng)為 CP 代碼時(shí)須在前 面加118） 基于 固定 電話網(wǎng)的信息終端及綜合 信息系統(tǒng) 技術(shù)規(guī)范 第七分冊(cè) 第 24頁 sChargeTermID Char(22) 計(jì)費(fèi)號(hào)碼（若為空，則對(duì)被叫計(jì)費(fèi)） sDestTermIDFile Char(100) 保存所有目的號(hào)碼的文件名 nMsgLen Int 消息長度 sMsgContent Char(*) 短消息內(nèi)容（ nMsgLen=0 時(shí)表示存放短消息的文件名） sMsgIDFile Char(100) 保存所有短消息的返回 MsgID 和 ErrorCode 的文件名 sMsgType Char(2) 短消息類型 sReserved Char(9) 保留 ? 返回 0=成功 1=失敗 獲取群發(fā)短信的結(jié)果（ GetSendBatchResp） ? 作用 從文件里讀取群發(fā)的某一個(gè)短信的標(biāo)識(shí)、發(fā)送結(jié)果和發(fā)送號(hào)碼。 ? 參數(shù) 參數(shù)名 數(shù)據(jù)類型 說明 sMsgIDFile Char(100) 保存所有短消息的返回 MsgID和 ErrorCode 的文件名 nPos Int 短消息位置，從 0開始 pSendBatchResp SendBatchResp * 用于保存結(jié)果的 SendBatchResp 結(jié)構(gòu)指針 ? 返回 0=成功 1=失敗 接收短信（ SMGPDeliver） ? 作用 基于 固定 電話網(wǎng)的信息終端及綜合 信息系統(tǒng) 技術(shù)規(guī)范 第七分冊(cè) 第 25頁 連接短信網(wǎng)關(guān)，等待接收屬于本 ICP 的短信。 ? 參數(shù) 參數(shù)名 數(shù)據(jù)類型 說明 nTimeout int 等待時(shí)間，單位：秒。 0表示永遠(yuǎn)等待。 pDeliverResp DeliverResp * 保存短消息的 DeliverResp結(jié)構(gòu)指針 ? 返回 0=成功 1=失敗 檢查短信網(wǎng)關(guān)是否能夠提供服務(wù)（ CMMPActiveTest） ? 作用 檢查短信網(wǎng)關(guān)是否能夠提供服務(wù)。 ? 參數(shù) 參數(shù)名 數(shù)據(jù)類型 說明 nErrorCode Int 錯(cuò)誤代碼（參照錯(cuò)誤代碼表）。 ? 返回 0=成功 1=失敗 A （ SMGPQuery可選） ? 作用 向短消息網(wǎng)關(guān)查詢某天的短消息流量。 ? 參數(shù) 參數(shù)名 數(shù)據(jù)類型 說明 sDate Char(10) 查詢?nèi)掌冢袷剑?yyyymmdd nQueryType Int 查詢類型， 0=總數(shù)查詢； 1=按業(yè)務(wù)代碼查詢 sServiceID Char(11) 查詢碼 5(業(yè)務(wù)類型 ) 基于 固定 電話網(wǎng)的信息終端及綜合 信息系統(tǒng) 技術(shù)規(guī)范 第七分冊(cè) 第 26頁 pQueryResp QueryResp * 保存查詢結(jié)果的 QueryResp結(jié)構(gòu)指針 ? 返回 0=成功 1=失敗 SMGP API 配置文件在 smgpapi/config/，以下是配置項(xiàng)的說明： 名稱 說明 CPId CP 編號(hào)。 CPShareKey CP 密碼。 WithPrevPage 第 1個(gè)以后的分割短消息的前置說明文字，可以為空。 例如（第 2個(gè)分割短消息）： (2/3)(continue)xxxxxx “(continue)”是前置說明文字 WithNextPage 分割短消息的后置說明文字，可以為空，最后一個(gè)短消息不帶后置說明文字。 例如（第 1個(gè)分割短消息）： (1/3)xxxxxx(to be continued) “(to be continued)”是后置說明文字PageSpaceAscii AscII短消息的最大長度 PageSpaceGB 中文短消息的最大長度 PageSpaceBinary 二進(jìn)制短消息的最大長度 WithPageIndex 在分割短消息時(shí)是否附加頁號(hào)， 0=否， 1=是。 MaxPage 最大分割頁數(shù)，最大是 99頁。 ClientIP 客戶主機(jī)的 IP地址，必須填寫接入 Inter的公網(wǎng)地址。如果主機(jī)是通過 Gateway接入 Inter，就填寫 Gateway地址。如果客戶主機(jī)的 IP 地址填寫錯(cuò)誤會(huì)導(dǎo)致 應(yīng)用程序不能通過 SMGP用戶認(rèn)證。 ServerIP 短消息網(wǎng)關(guān)的 IP 地址 ServerPort 短消息網(wǎng)關(guān)的端口 基于 固定 電話網(wǎng)的信息終端及綜合 信息系統(tǒng) 技術(shù)規(guī)范 第七分冊(cè) 第 27頁 SubmitRetry 發(fā)送短消息自動(dòng)重試次數(shù)（ 1表示只發(fā)送 1次，不重新發(fā)送） RequestTimeout 發(fā)送請(qǐng)求超時(shí)時(shí)間，單位：秒 SMGPSendSingle 和 SMGPSendBatch 提供自動(dòng)分割短消息的功能，分割的效果由 的配置控制。 當(dāng)參數(shù) nMsgFormat 等于 0 或 15 時(shí)， API 就提供分割短消息功能。 API 掃描短消息的內(nèi)容， 把短消息分段，根據(jù)每一段的短消息內(nèi)容設(shè)置 nMsgFormat。如果某一段短消息含有中文，就把那一段短消息的發(fā)送格式設(shè)為 15，取PageSpaceGB 為最大長度；如果不含中文，就把那一段短消息的發(fā)送格式設(shè)為 0，取 PageSpaceAscii 為最大長度。這樣，可以充分利用短消息的最大發(fā)送長度，減少分割數(shù)量。如果 WithPrevPage 或者 PageSpaceGB 含有漢字，所有分割短消息的發(fā)送格式都設(shè)為 15。 當(dāng)參數(shù) nMsgFormat 等于 4 時(shí)， API 根據(jù) PageSpaceBinary 配置分割短消息。 當(dāng)參數(shù) nMsgFormat 等于 0 并且長度小于 PageSpaceGB， API 掃描短消息內(nèi)容是否含有中文。如果發(fā)現(xiàn)中文，就自動(dòng)把發(fā)送格式變?yōu)?15。 編號(hào) 含義 0 成功 1 保留 2 保留 3 消息格式錯(cuò) 4 非法短消息長度（ MsgLength） 5 非法資費(fèi)代碼（ FeeCode） 6 短消息長度超長 保留 7 非法業(yè)務(wù)類型（ ServiceId） 8 短消息發(fā)送速度太快 系統(tǒng)忙 基于 固定 電話網(wǎng)的信息終端及綜合 信息系統(tǒng) 技術(shù)規(guī)范 第七分冊(cè) 第 28頁 9 保留 10 非法 CP編號(hào) 11 非法信息格式（ MsgFormat） 12 非法資費(fèi)類別（ FeeType） 13 非法存活有效期（ ValidTime） 14 非法定時(shí)發(fā)送時(shí)間（ AtTime） 15 非法計(jì)費(fèi)號(hào)碼（ ChargeTermId） 16 非法目標(biāo)號(hào)碼（ DestTermId） 17 不能打開目標(biāo)號(hào)碼文件（ DestTermIdFile） 18 不能打開短消息內(nèi)容文件（ MsgFile） 19 非法短消息 保留 20 連接短消息網(wǎng)關(guān)失敗 21 登陸失敗 認(rèn)證錯(cuò) 22 接收結(jié)果數(shù)據(jù)包失敗 保留 23 發(fā)送隊(duì)列滿 24 超出系統(tǒng)限制 保留 25 命令字錯(cuò) 26 序列號(hào)錯(cuò) 27 保留 28 保留 29 版本號(hào)不匹配 30 非法消息類型（ MsgType） 31 非法優(yōu)先級(jí)（ Priority） 32 保留 33 保留 34 保留 35 非法時(shí)間格式 36 保留 37 保留 38 非法查詢類型（ QueryType） 39 路由錯(cuò)誤 基于 固定 電話網(wǎng)的信息終端及綜合 信息系統(tǒng) 技術(shù)規(guī)范 第七分冊(cè) 第 29頁 40 非法包月 /封頂費(fèi)（ FixedFee） 41 保留 42 保留 43 保留 44 保留 45 保留 46 非法發(fā)送用戶號(hào)碼（ SrcTermId） 47 保留 48 保留 99 系統(tǒng)錯(cuò)誤 其他 保留