infox-masapi接口說(shuō)明-wenkub
2023-04-22 05:58:18 本頁(yè)面
【正文】 d 計(jì)費(fèi)類型，標(biāo)識(shí)包月、封頂、單條、免費(fèi)、不計(jì)費(fèi)等。CMPP3消息點(diǎn)播使用，SMPP不使用。填寫接收該條短信的手機(jī)號(hào)碼。表24 SmSendBean字段說(shuō)明字段名字段類型字段說(shuō)明priorityprotected int優(yōu)先級(jí)別，對(duì)應(yīng)于masdb的SENDLEVEL。SmSendBeanSmSendBean是短信發(fā)送的消息結(jié)構(gòu)體。CMPP3消息點(diǎn)播使用。smRecvTimeprivate 接收消息的接收時(shí)間。smMsgContentprivate 接收消息的消息內(nèi)容。smIdprivate int接收消息id（唯一標(biāo)識(shí)），為1的時(shí)候表明此消息為無(wú)效消息。smActionReasonIDprivate 接收消息的請(qǐng)求原因。SmReceiveBean繼承于SmSendBean。SmSendResultBean發(fā)送結(jié)果的消息體描述。12public final void destroy()銷毀函數(shù)，將清理連接，關(guān)閉數(shù)據(jù)庫(kù)連接。8public final SmSendResultBean[] querySmsResult(int sm_id, fromTime, endTime,String orgAddr,String destAddr) throws Exception查詢短消息發(fā)送結(jié)果。4public final void initConn(Map args) throws Exception初始化和MAS系統(tǒng)的連接。 API概述本文檔定義了開發(fā)程序和MAS之間的所有短信API，如表21所示。如果是異常返回，分別對(duì)每一個(gè)可能的異常進(jìn)行詳細(xì)描述，包括異常名稱及相應(yīng)說(shuō)明。 相關(guān)約定在本文中，每個(gè)API（Application Programming Interface）函數(shù)的描述由四部分組成：函數(shù)功能、函數(shù)原型、參數(shù)說(shuō)明和返回碼/值。MAS以JAVA的方式封裝其短信接口，提供給企業(yè)應(yīng)用系統(tǒng)調(diào)用。標(biāo)題內(nèi)容 JAVA接口概述介紹JAVA接口的背景知識(shí)。 讀者范圍介紹本手冊(cè)的讀者對(duì)象。該JAVA組件封裝的對(duì)象可以提供短信單發(fā)接口、數(shù)據(jù)庫(kù)初始化接口、用戶登錄初始化接口、短信接收接口、短信查詢接口，其中短信查詢接口用于查詢已經(jīng)發(fā)送的短信的情況。函數(shù)功能描述API的主要功能。2 API說(shuō)明關(guān)于本章本章描述內(nèi)容如下表所示。表21 Java API的短信接口序號(hào)接口名稱描述1public DBSMProxy()建立一個(gè)和MAS短信接口訪問(wèn)的代理對(duì)象。5public final int[] SendSm(SmSendBean sendBean) throws Exception發(fā)送短消息接口消息。9public final void login(String userName, String password) throws Exception根據(jù)用戶名、密碼登錄系統(tǒng)，登錄MAS，如果失敗拋出異常。 基本數(shù)據(jù)類型介紹短信API中各種基本數(shù)據(jù)類型表示如下。 數(shù)據(jù)結(jié)構(gòu)詳細(xì)描述SmReceiveBean接收消息的結(jié)構(gòu)體描述。表23 SmReceiveBean字段說(shuō)明字段名字段類型字段說(shuō)明smActionIDprivate 接收消息的請(qǐng)求類型。CMPP3消息點(diǎn)播使用。smMessageIDprivate 接收消息的類型。smOrgAddrprivate 接收消息的源地址，對(duì)應(yīng)于發(fā)送方手機(jī)號(hào)碼。smReserve1private 接收消息的保留標(biāo)識(shí)，暫時(shí)沒(méi)有使用。SMPP不使用。在這個(gè)結(jié)構(gòu)體中，必要填寫的字段只有目的地址和消息內(nèi)容，其他字段使用文件或者API中的缺省值。sendSMIDprotected int返回發(fā)送到MAS的smid，唯一標(biāo)識(shí)發(fā)送短信的ID?？梢詾槿我舛鄠€(gè)，API函數(shù)自動(dòng)拆分成多條短信發(fā)送。smFeeCodeprotected 配合smFeeType，用來(lái)標(biāo)識(shí)計(jì)費(fèi)多少費(fèi)用。根據(jù)當(dāng)?shù)貐f(xié)議規(guī)定。smMsgContentprotected 短消息內(nèi)容。smOrgAddrprotected 消息的源地址。SMSEND_TYPE_TEXTstatic int發(fā)送類型，等于此數(shù)值的時(shí)候?yàn)槠胀ㄎ谋鞠掳l(fā)。smServiceIdprotected 在CMPP中對(duì)應(yīng)于對(duì)應(yīng)的serviceid。smTryTimesprotected int需要重發(fā)的次數(shù)。結(jié)構(gòu)體各字段的說(shuō)明請(qǐng)參見表25。CMPP、SGIP使用。smMsgFmtprotected int此條短消息的消息內(nèi)容格式。l 0：成功l 其他：失敗smRecvTimeprotected 短信被手機(jī)終端收到的時(shí)間。smSentTimeprotected 短信提交到短信網(wǎng)關(guān)的時(shí)間。smSubmitTimeprotected 短信提交到MAS的時(shí)間。 initConnpublic final void initConn( args)throws 函數(shù)描述該函數(shù)根據(jù)指定的map參數(shù)，初始化和MAS的連接，根據(jù)傳遞的參數(shù)，初始化數(shù)據(jù)庫(kù)連接。xml文件中關(guān)于數(shù)據(jù)庫(kù)的描述路徑：config/database/eiedb下包含配置。配置文件默認(rèn)存放在相對(duì)當(dāng)前工作目錄下的apiConf，名稱為：。l 必要參數(shù)包括短信內(nèi)容和目的地址。l 如果消息內(nèi)容超過(guò)了300字節(jié)，拋出異常。返回int[]返回所需要的sm_id，有多少個(gè)目的地址，就返回多少個(gè)sm_id，并且參照destAddrs的順序排列。l 對(duì)于源地址、業(yè)務(wù)id等參數(shù)，系統(tǒng)內(nèi)部有默認(rèn)配置值。l 對(duì)于消息目的地址過(guò)長(zhǎng)，拋出異常，目的地址最多150個(gè)。 返回返回所需要的sm_id，類型為int，失敗時(shí)返回1。調(diào)用前提API已經(jīng)初始化并且成功調(diào)用login(
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1