致遠OA北京服務商北京諾必達科技有限公司OA系統消息集成開發分享
1.1. 系統消息對象
1.1.1. 系統消息對象示例
{
"id" : -6675423597613201249,
"creationDate" : 1397631785000,
"referenceId" : 1524058743291659976,
"messageCategory" : 10,
"messageContent" : "張三發起調查《調查樣式1》",
"messageType" : 0,
"senderId" : -8361687019900091749,
"receiverId" : -8361687019900091749,
"userId" : -8361687019900091749,
"senderName" : "張三",
"linkType" : "message.link.inq.alreadyauditing",
"openType" : 0,
"linkParam0" : "1524058743291659976",
"linkParam1" : null,
"linkParam2" : null,
"linkParam3" : null,
"linkParam4" : null,
"linkParam5" : null,
"linkParam6" : null,
"linkParam7" : null,
"linkParam8" : null,
"linkParam9" : null,
"isRead" : false
}
1.1.2. 系統消息屬性說明
參數 | 說明 |
---|---|
id | 消息主鍵,唯一標示消息 |
creationDate | 創建時間 |
referenceId | 主對象ID,例如此處為調查對象的ID |
messageCategory | 消息所屬應用類型,應用類型請查看應用類型枚舉說明 |
messageContent | 消息內容 |
messageType | 消息類型,目前只有系統消息一種 |
senderId | 發送者ID |
receiverId | 接收者ID |
userId | 消息接收人Id |
senderName | 發送者名稱 |
linkType | 鏈接類型 |
openType | 鏈接的打開方式,0:新窗口打開;1:工作區打開 |
linkParam0 — linkParam9 | 鏈接參數,順序要與消息鏈接配置中保持一致。 |
isRead | 是否已讀 |
1.2. 導出協同全部系統消息
導出協同中個人的全部系統消息。
接口請求說明:
V6.0之前請求方式
http請求方式:GET
http://ip:port/seeyon/rest/message/all/{userId}
例如:http://127.0.0.1:8088/seeyon/rest/message/all/-8361687019900091749
V6.0開始請求方式【增加分頁】
http請求方式:GET
http://ip:port/seeyon/rest/message/all/{userId}?pageNo=1&pageSize=20
例如:http://127.0.0.1:8088/seeyon/rest/message/all/-8361687019900091749?pageNo=1&pageSize=20
參數說明:
參數 | 是否必須 | 說明 |
---|---|---|
userId | 是 | 人員ID |
返回說明
正常情況下會返回UserHistoryMessage對象的JSON格式集合ArrayList,消息不存在返回null,JSON數據包參考:系統消息對象示例
參數說明 請參考:系統消息屬性說明
1.3. 導出協同全部未讀系統消息
導出協同中個人的全部未讀系統消息。
接口請求說明:
V6.0之前請求方式
http請求方式:GET
http://ip:port/seeyon/rest/message/unread/{userId}?ispage=true/false
例如:http://127.0.0.1:8088/seeyon/rest/message/unread/-8361687019900091749
V6.0開始請求方式【增加分頁】
http請求方式:GET
http://ip:port/seeyon/rest/message/unread/{userId}?pageNo=1&pageSize=20
例如:http://127.0.0.1:8088/seeyon/rest/message/unread/-8361687019900091749?pageNo=1&pageSize=20
參數說明:
參數 | 是否必須 | 說明 |
---|---|---|
userId | 是 | 人員ID |
ispage | 否 | 默認true返回20條,false返回所有 |
返回說明
正常情況下會返回UserHistoryMessage對象的JSON格式集合ArrayList,消息不存在返回null,JSON數據包參考:系統消息對象示例
參數說明 請參考:系統消息屬性說明
1.4. 發送協同消息
外部系統通過消息接口,可以把系統消息發送到協同平臺。
接口請求說明:
http請求方式:POST
接收人為用戶ID:http://ip:port/seeyon/rest/message/userId
接收人為登錄名:http://ip:port/seeyon/rest/message/loginName
具體代碼調用方式請查看REST接口調用示例
參數說明:
此請求為【接收人為用戶ID】POST請求,傳遞參數如下:
{
"userIds": [11111,22222],/***接受人ID**/
"sendUserId" : "3333",/***發起人用戶ID;V5.6增加發起者登錄名參數【senderLoginName】**/
"content" : 我是消息內容,/***消息內容**/
"url" : [],/***消息連接**/
}
此請求為【接收人為登錄名】POST請求,傳遞參數如下:
{
"sendUserId" : "3333",/***發起人用戶ID;V5.6增加發起者登錄名參數【senderLoginName】**/
"loginNames" : [張三,李四],/***登錄名**/
"content" : 我是消息內容,/***消息內容**/
"url" : [],/***消息連接**/
}
參數 | 是否必須 | 說明 |
---|---|---|
loginNames | 是 | 接收人為登錄名,可以多人接收 |
userIds | 是 | 接收人為用戶ID,可以多人接收 |
content | 是 | 消息內容:可以是發送人,標題,內容的組合 |
url | 否 | 接收人觸發的鏈接,跟接收人一一對應,如果為空則此接收人沒有鏈接 |
sendUserId | 是 | 發起者ID 與發起者登錄名【senderLoginName】填寫一個即可 |
senderLoginName(V5.6增加) | 是 | 發起者登錄名 與發起者ID【sendUserId】填寫一個即可 |
返回說明
返回值:ServiceResponse;成功則返回1,失敗而沒有異常是0,有異常返回是-1,并且返回異常信息
1.5. 獲取消息URL連接
通過獲取的消息對象中的linkType 和ReferenceId 來獲取消息URL連接。
接口請求說明:
http請求方式:GET
http://ip:port/seeyon/rest/message/linkurl/{linkType}?ReferenceId={ReferenceId}
例如:http://127.0.0.1:8088/seeyon/rest/message/linkurl/message.link.col.pending?ReferenceId=2197872205573017031
參數說明:
參數 | 是否必須 | 說明 |
---|---|---|
linkType | 是 | 消息對象中的linkType屬性 |
ReferenceId | 是 | 消息對象中的ReferenceId屬性 |
year | 否 | 年,只有獲取績效消息才需要 |
month | 否 | 月,只有獲取績效消息才需要 |
返回說明
正常情況下會返回消息的URL連接,消息不存在返回空。
1.6. 改變未讀消息讀取狀態
通過人員ID以及人員未讀消息對象中的ID 來改變當前消息的ISREAD屬性。
接口請求說明:
http請求方式:POST
http://ip:port/seeyon/rest/message/isread
例如:http://127.0.0.1:8088/seeyon/rest/message/isread
參數說明:
參數 | 是否必須 | 說明 |
---|---|---|
userid | 是 | 人員ID |
messageid | 是 | 未讀消息ID |
代碼示例:
Map res = new HashMap();
String userid ="5195799439650475398";
String[] messageid ={"-6208158811057140087"};
res.put("userid", userid);
res.put("messageid", messageid);
return res;
String result = client.post("message/isread",res, String.class);
返回說明
正常情況下會返回消息的JSON信息,消息不存在返回空。
公司主要經營內容:
帆軟報表,帆軟軟件,致遠OA,北京致遠軟件,致遠軟件,致遠OA軟件,OA軟件,致遠OA辦公軟件,致遠OA協同軟件,OA協同軟件,OA辦公軟件,致遠辦公軟件,致遠協同辦公軟件,致遠OA協同辦公軟件,OA綜合辦公軟件,致遠系統,OA系統,致遠OA系統,北京致遠OA系統,北京致遠OA軟件,致遠OA系統軟件,致遠協同辦公系統,致遠協同辦公OA系統,致遠系統OA,致遠軟件OA,OA軟件系統,OA致遠北京,致遠A8OA,OAA8軟件,致遠A8軟件,致遠A8系統Oa軟件,致遠OA系統版本軟件