項(xiàng)目-建行即時(shí)通信需求0.接口說明

1、1 接口定義1.1 客戶端接口使用方法：客戶端提供了 lib 開發(fā)包，封裝成了 dll 方式；第的調(diào)用。程序可該 dll 進(jìn)行客戶端接口1.1.1 SendMessage 消息發(fā)送描述：此接口主要用于發(fā)送即時(shí)消息。是否需要登錄：是使用方法：客戶端提供的 dll 組件， 通過賬號SendMesage 方法進(jìn)行消息的發(fā)送登錄到服務(wù)器上；調(diào)用 dll 中提供的輸入?yún)?shù)：返回參數(shù)：參數(shù)類型約束描述sus1返回值。0：調(diào)用成功1：調(diào)用失敗參數(shù)類型約束描述recidsstring1接收的 id 信息，逗號分隔。根據(jù)接收類型確定該 id 的類型。rectype1接收類型：1：用戶2：部門3：群組chatty

2、pe1會話類型：1：單人2：多人會話3：廣播會話bodystring1消息內(nèi)容1.1.2 SendFile 文件發(fā)送描述：此接口主要用于發(fā)送文件信息。是否需要登錄：是使用方法：客戶端提供的 dll 組件，通過賬號登錄到服務(wù)器上；調(diào)用 dll 中提供的 SendFile方法進(jìn)行文件的發(fā)送。發(fā)送文件時(shí)需要傳輸本地的文件地址，dll調(diào)用自帶的文件傳輸方式進(jìn)行文件的傳輸；同時(shí)通過 OnFilePro的接收。組件負(fù)責(zé)本地文件并s 回調(diào)函數(shù)處理文件進(jìn)度輸入?yún)?shù)：返回參數(shù)：OnFileProgress 文件發(fā)送進(jìn)度回調(diào)函數(shù)輸入?yún)?shù)：參數(shù)類型約束描述sus1返回值。0：調(diào)用成功1：調(diào)用失敗參數(shù)類型約束描述re

3、cidsstring1接收的 id 信息，逗號分隔。根據(jù)接收類型確定該 id 的類型。rectype1接收類型：1：用戶2：部門3：群組chattype1會話類型：1：單人2：多人會話3：廣播會話offline1是否離線傳輸：0：傳輸(單人文件的情況下)1：離線傳輸(不管在不都離線傳)filepathstring1文件全路徑streamidstring1當(dāng)前文件傳輸通道的 ID返回參數(shù)：1.1.3 OnMessageReceive 消息接收描述：此接口主要用于接收 IM 的即時(shí)消息，通過實(shí)現(xiàn)該方法可IM 消息的接收。使用方法：客戶端提供的 dll 組件，通過賬號登錄進(jìn)行登錄。接收消息需要通過函

4、數(shù)原型并做為變量到 dll 提供的事件接口中，當(dāng) dll 組件接收到服務(wù)器的消息后，會自動調(diào)用組件中的回調(diào)函數(shù)并傳遞相關(guān)參數(shù)信息；第來自服務(wù)器發(fā)送的信息。應(yīng)用程序可通過回調(diào)函數(shù)的方式接收是否需要登錄：是輸入?yún)?shù)：返回參數(shù)：參數(shù)類型約束描述type1返回的消息類型：1：單人2：多人會話3：廣播會話offtype1是否是離線消息0：1：離線bodystring1消息內(nèi)容，純文本格式ownerstring1消息發(fā)送者賬號receiverstring1接收者(缺省就是登錄的用戶)timelong1時(shí)間戳格式(1970 相對時(shí)間)參數(shù)類型約束描述sus1返回值。0：繼續(xù)調(diào)用-1：表示取消文件傳輸參數(shù)類型

5、約束描述currsizelong1當(dāng)前上傳大小(byte),目前已經(jīng)發(fā)送的大小totalsizelong1總大小(byte)streamidstring1文件傳輸通道 ID1.1.4 OnFileReceive 文件接收描述：此接口主要用于接收 IM 的文件消息，通過實(shí)現(xiàn)該方法可接收文件信息。是否需要登錄：是使用方法：客戶端提供的 dll 組件，通過賬號登錄進(jìn)行登錄。接收消息需要通過函數(shù)原型并做為變量到 dll 提供的事件接口中，當(dāng) dll 組件接收到服務(wù)器的消息后，會自動調(diào)用組件中的回調(diào)函數(shù)并傳遞相關(guān)參數(shù)信息；第應(yīng)用程序可通過回調(diào)函數(shù)的方式接收來自服務(wù)器發(fā)送的信息。接收文件消息后，需調(diào)用文件

6、接收確認(rèn)函數(shù) ToReceiveFile 將文件接收到的通道 ID 做為參數(shù)傳遞進(jìn)來，接收的數(shù)據(jù)傳輸過程已通過 dll 封裝好，接收進(jìn)度會通過 OnFilePro s 函數(shù)進(jìn)行回調(diào)。輸入?yún)?shù)：返回參數(shù)：ToReceiveFile 文件接收函數(shù)輸入?yún)?shù)：參數(shù)類型約束描述無參數(shù)類型約束描述type1返回的消息類型：1：文件2：離線文件3：多人文件offtype1是否是離線消息0：1：離線filenamestring1文件名稱ownerstring1文件發(fā)送者賬號receiverstring1文件接受者streamidstring1文件通道 IDtimelong1時(shí)間戳格式(1970 相對時(shí)間)參數(shù)

7、類型約束描述無返回參數(shù)：OnFileProgress 文件接收進(jìn)度回調(diào)函數(shù)輸入?yún)?shù)：返回參數(shù)：1.1.5 login 登陸描述：此接口主要用于 IM 登陸用。是否需要登錄：否使用方法：客戶端提供的 dll 組件，調(diào)用 dll 提供的 login 方法進(jìn)行登錄調(diào)用。輸入?yún)?shù)：參數(shù)類型約束描述usernamestring1用戶登陸的賬號passwordstring1賬號或者 ses標(biāo)識type10：賬號登陸參數(shù)類型約束描述sus1返回值。0：繼續(xù)調(diào)用-1：表示取消文件傳輸參數(shù)類型約束描述currsizelong1當(dāng)前上傳大小(byte),目前已經(jīng)發(fā)送的大小totalsizelong1總大小(byt

8、e)streamidstring1文件傳輸通道 ID參數(shù)類型約束描述sus10：調(diào)用成功1：調(diào)用失敗參數(shù)類型約束描述streamidstring1文件通道 ID返回參數(shù)：注明：單點(diǎn)登陸采用的是 username+seskey 的方式來認(rèn)證，seskey 可以通過 ucstar 的接口來獲取。調(diào)用 login 方法的時(shí)候?qū)?type 設(shè)置成 4 表明為單點(diǎn)認(rèn)證方式。1.1.6 logout 登出描述：此接口主要用于 IM 登出用。是否需要登錄：是使用方法：客戶端提供的 dll 組件，調(diào)用 dll 提供的 logout 方法進(jìn)行登錄調(diào)用。輸入?yún)?shù)：返回參數(shù)：參數(shù)類型約束描述flag10：退出成功1

9、：客戶端未登陸2：退出失敗參數(shù)類型約束描述type1登陸狀態(tài)：0：只是離線1：離線并給關(guān)閉客戶端參數(shù)類型約束描述flag10：登陸成功1：已經(jīng)登陸2：錯(cuò)誤3：登陸超時(shí)1：RSA 加密登陸2：僅僅使用賬號登陸，不驗(yàn)證 4：使用賬號和 sesKey 登陸1.2 服務(wù)器接口1.2.1 SendMessage 消息發(fā)送描述：此接口主要用于發(fā)送廣播消息。是否需要登錄：是使用方法：通過服務(wù)器的 webservice 地址生成本地 webservice 代碼，通過本地代碼進(jìn)行 webservice接口的調(diào)用。參數(shù)采用的是對象方式。輸入?yún)?shù)：參數(shù)類型約束描述msgobjectObject1msgType 消息

10、類型(缺省 system)system: 系統(tǒng)消息 broadcast: 廣播消息 chat: 普通消息msgResource 消息來源(OA,等) (缺省 ucstar)msgScope消息重要程度(緊急,一般等等)(缺省 1) 0:無1:緊急2:重要3:提醒4:一般msgContent消息內(nèi)容userIds消息接收者(逗號隔開) deptIds 消息接收部門(逗號隔開) bindGrous 消息接收群組(逗號隔開) sue用戶狀態(tài)(缺省 0)0: 發(fā)送給所有用戶1: 發(fā)送給所有用戶3:方式發(fā)送給所有用戶4:方式發(fā)送給離線用戶 msgUrl消息對應(yīng)的 URL(詳細(xì)內(nèi)容) sender發(fā)送者b

11、indGroupNames 群組名發(fā)送支持userNames使用發(fā)送支持返回參數(shù)：1.2.2 getSue 獲取用戶狀態(tài)描述：此接口主要用于調(diào)用服務(wù)器 webservice 接口獲取用戶狀態(tài)用。是否需要登錄：否使用方法：通過服務(wù)器的 webservice 地址生成本地 webservice 代碼，通過本地代碼進(jìn)行 webservice接口的調(diào)用。輸入?yún)?shù)：返回參數(shù)：1.2.3 getUserList 獲取特定用戶列表描述：此接口主要用于調(diào)用服務(wù)器 webservice 接口獲取用戶列表。是否需要登錄：否參數(shù)類型約束描述sueresstring1返回用戶狀態(tài)對應(yīng)的 xml 數(shù)據(jù)結(jié)構(gòu)：x sue

12、結(jié)果說明： 0：離線1：2：離開show 結(jié)果說明：表示離開的顯示信息參數(shù)類型約束描述usernamesstring1用戶賬號用逗號隔開參數(shù)類型約束描述sus1返回值。0：調(diào)用成功1：調(diào)用失敗deptNames部門名稱發(fā)送支持使用方法：通過服務(wù)器的 webservice 地址生成本地 webservice 代碼，通過本地代碼進(jìn)行 webservice接口的調(diào)用。輸入?yún)?shù)：返回參數(shù)：1.2.4 getDepart 獲取組織架構(gòu)描述：此接口主要用于調(diào)用服務(wù)器 webservice 接口獲取組織架構(gòu)。是否需要登錄：否使用方法：通過服務(wù)器的 webservice 地址生成本地 webservice 代碼，通過本地代碼進(jìn)行 webservice接口的調(diào)用。輸入?yún)?shù)：參數(shù)類型約束描述usersresstring1返回用戶列表對應(yīng)的 xml 數(shù)據(jù)結(jié)構(gòu)：用戶賬號用戶郵件.參數(shù)類型約束描述groustring1分組 IDgrouptypestrin