infox-masapi接口說明(已修改)
2025-04-19 05:58 本頁面
【正文】 目 錄1 總體說明 11 JAVA接口概述 12 讀者范圍 12 相關(guān)約定 122 API說明 21 API概述 22 基本數(shù)據(jù)類型介紹 23 數(shù)據(jù)結(jié)構(gòu)詳細(xì)描述 23 接口介紹 27 DBSMProxy 27 initConn 27 initConn 28 initConn 29 sendSm 29 sendMultiSm 210 getReceivedSms 211 querySmsResult 212 login 212 isConnected 213 logout 213 destroy 2133 安裝使用指導(dǎo) 315 介紹安裝JAVA SMS API 31 導(dǎo)入開發(fā)庫 31 方法調(diào)用 314 示例代碼 41 初始化連接對象并登錄 42 發(fā)送短信 42 查詢短信發(fā)送情況 44 查詢短信接收情況 44 銷毀連接或者退出登錄 455 配置文件說明 51 5251 / 32表格目錄表21 Java API的短信接口 22表22 基本數(shù)據(jù)類型簡介 23表23 SmReceiveBean字段說明 23表24 SmSendBean字段說明 24表25 SmSendResultBean字段說明 261 總體說明關(guān)于本章本章描述內(nèi)容如下表所示。標(biāo)題內(nèi)容 JAVA接口概述介紹JAVA接口的背景知識。 讀者范圍介紹本手冊的讀者對象。 相關(guān)約定介紹本手冊的相關(guān)約定。 JAVA接口概述為了企業(yè)用戶更加簡便、靈活地實(shí)現(xiàn)相關(guān)的業(yè)務(wù)，企業(yè)業(yè)務(wù)系統(tǒng)可以接入MAS（Mobile Agent Server）的應(yīng)用開發(fā)接口。MAS以JAVA的方式封裝其短信接口，提供給企業(yè)應(yīng)用系統(tǒng)調(diào)用。該JAVA組件封裝的對象可以提供短信單發(fā)接口、數(shù)據(jù)庫初始化接口、用戶登錄初始化接口、短信接收接口、短信查詢接口，其中短信查詢接口用于查詢已經(jīng)發(fā)送的短信的情況。該版本不提供短信群發(fā)接口和點(diǎn)點(diǎn)通短信接口。 讀者范圍本手冊適用于華為公司MAS開發(fā)人員，企業(yè)IT管理、維護(hù)部門的相關(guān)開發(fā)人員。 相關(guān)約定在本文中，每個(gè)API（Application Programming Interface）函數(shù)的描述由四部分組成：函數(shù)功能、函數(shù)原型、參數(shù)說明和返回碼/值。函數(shù)功能描述API的主要功能。函數(shù)原型描述API原型，可直接拷貝程序中的函數(shù)原型代碼。參數(shù)說明l 名稱：參數(shù)名稱l 如何理解：對參數(shù)的簡單解釋l 備注：輸入/輸出參數(shù)的相關(guān)信息返回碼/值A(chǔ)PI調(diào)用過程中的返回碼/值，分為成功時(shí)的返回和異常返回。如果是異常返回，分別對每一個(gè)可能的異常進(jìn)行詳細(xì)描述，包括異常名稱及相應(yīng)說明。2 API說明關(guān)于本章本章描述內(nèi)容如下表所示。標(biāo)題內(nèi)容 API概述介紹JAVA短信API的基本組成。 基本數(shù)據(jù)類型介紹各類數(shù)據(jù)結(jié)構(gòu)介紹。 API概述本文檔定義了開發(fā)程序和MAS之間的所有短信API，如表21所示。表21 Java API的短信接口序號接口名稱描述1public DBSMProxy()建立一個(gè)和MAS短信接口訪問的代理對象。2public final void initConn() throws Exception初始化和MAS系統(tǒng)的連接。3public final void initConn(String confFile) throws Exception初始化和MAS系統(tǒng)的連接。4public final void initConn(Map args) throws Exception初始化和MAS系統(tǒng)的連接。5public final int[] SendSm(SmSendBean sendBean) throws Exception發(fā)送短消息接口消息。6int sendMultiSm(SmSendBean sendBean)發(fā)送短消息接口，提交一條群發(fā)消息到MAS的發(fā)送消息隊(duì)列。7getReceivedSms(int maxCount, fromTime, endTime, orgAddr, destAddr) throws 從MAS接收的消息隊(duì)列中獲取消息。8public final SmSendResultBean[] querySmsResult(int sm_id, fromTime, endTime,String orgAddr,String destAddr) throws Exception查詢短消息發(fā)送結(jié)果。9public final void login(String userName, String password) throws Exception根據(jù)用戶名、密碼登錄系統(tǒng)，登錄MAS，如果失敗拋出異常。10boolean isConnected()判斷API是否已經(jīng)和MAS建立了連接。11public final void logout()退出登錄函數(shù)僅僅清理當(dāng)前的用戶，可以在此基礎(chǔ)上再次登錄，連接仍然是存在的。12public final void destroy()銷毀函數(shù)，將清理連接，關(guān)閉數(shù)據(jù)庫連接。 基本數(shù)據(jù)類型介紹短信API中各種基本數(shù)據(jù)類型表示如下。表22 基本數(shù)據(jù)類型簡介名稱如何理解SmSendBean短信發(fā)送的消息結(jié)構(gòu)體。SmReceiveBean接收消息的結(jié)構(gòu)體描述。SmSendResultBean發(fā)送結(jié)果的消息體描述。 數(shù)據(jù)結(jié)構(gòu)詳細(xì)描述SmReceiveBean接收消息的結(jié)構(gòu)體描述。從MAS中獲取消息，獲取完成之后自動在tbl_smreceived表中把Reserve1字段配置為1。結(jié)構(gòu)體各字段的說明請參見表23。SmRece
公司管理相關(guān)推薦
鄂ICP備17016276號-1