主要使用場景：第三方應用接入平臺后，需要與平臺會話保持一致時使用
客戶端與服務器之間定時維護用戶心跳
獲取接口訪問憑證：accessToken
| url | https://api.tze.cn/user/openapi/user/heartbeat?usession_id=****&accessToken={{accessToken}} |
| 請求方式 | get |
| 是否需要鑒權 | 是 |
| 請求數(shù)限制 | 是 |
| 接口方向 | 第三方應用->開放平臺 |
| 序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
|---|---|---|---|---|---|
1 |
usession_id |
必選 |
String |
64 |
用戶會話編號 |
| 序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
|---|---|---|---|---|---|
1 |
code |
必選 |
String |
6 |
結(jié)果編碼,心跳成功000000，心跳失敗100000，心跳失敗110000(重復登錄限制開啟時存在該結(jié)果編碼，result會返回相關重復日志信息，應用可選擇使用) |
2 |
message |
必選 |
String |
結(jié)果描述 | |
3 |
result |
可選 |
json |
結(jié)果對象 | |
3.1 |
usession_id |
必選 |
string |
用戶會話編號 | |
3.2 |
account_id |
必選 |
string |
帳號編號 | |
3.3 |
user_id |
必選 |
string |
用戶編號 | |
3.4 |
other |
可選 |
json |
附加信息 | |
3.4.1 |
top_org_id |
可選 |
string |
當前會話用戶切換的機構、學校等組織編號 |
請求示例
http://api.tze.cn/user/openapi/user/heartbeat?usession_id=****&accessToken={{accessToken}}
返回示例
{
"code": "000000",
"message": "心跳成功",
"result": {
"usession_id": "746afa32-60ad-11e9-9c81-0200f7a5bbcc",
"account_id": "cec2cdba-6013-11e9-9fd4-0200f7764488",
"user_id": "cebe65e0-6013-11e9-9fd4-0200f7764488",
"other": {
"top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a"
}
}
}
| 序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
|---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型，此時固定為：text |
1.1 |
text |
必選 |
Json |
- |
text消息體 |
1.1.1 |
content |
必選 |
String |
消息內(nèi)容 |
{
"msgtype": "text",
"text": {
"content": "zhxy msg text test 12"
}
}
| 序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
|---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型，此時固定為：link |
2 |
link |
必選 |
Json |
- |
link消息體 |
2.1 |
pcUrl |
必選 |
String |
PC端消息點擊鏈接地址 |
|
2.2 |
appUrl |
必選 |
String |
移動客戶端點擊消息時跳轉(zhuǎn)到的H5地址 |
|
2.3 |
title |
必選 |
String |
消息標題 |
|
2.4 |
busiId |
必選 |
String |
對應業(yè)務的id |
|
2.5 |
content |
必選 |
String |
消息描述 |
|
2.6 |
picUrl |
必選 |
String |
圖文消息的圖片鏈接，支持JPG、PNG格式，較好的效果為大圖640*320，小圖80*80。如不填，在客戶端不顯示圖片 |
{
"msgtype": "link",
"link": {
"pcUrl": "http://www.baidu.com",
"appUrl": "http://www.baidu.com",
"picUrl": "http://xxx.yyy.com/zzz.jpg",
"content": "百度一下",
"title": "百度",
"busiId":"AQWER1234"
}
}
| 序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
|---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型，此時固定為：oa |
2 |
busiId |
必選 |
String |
- |
該條oa消息在業(yè)務系統(tǒng)對應的id |
3 |
pcUrl |
必選 |
String |
消息點擊鏈接地址 |
|
4 |
appUrl |
必選 |
String |
移動客戶端點擊消息時跳轉(zhuǎn)到的H5地址 |
|
5 |
oa |
必選 |
Json |
- |
oa類型消息體 |
5.1 |
head |
必選 |
Json |
255 |
消息頭部Json |
5.1.1 |
text |
必選 |
String |
255 |
消息的頭部標題 |
5.1.2 |
bgColor |
可選 |
String |
消息頭部的背景顏色。長度限制為8個英文字符，其中前2為表示透明度，后6位表示顏色值。不要添加0x。默認值：FFCC0000 |
|
5.2 |
body |
可選 |
Json |
消息體 |
|
5.2.1 |
title |
可選 |
String |
消息體的標題 |
|
5.2.2 |
content |
可選 |
String |
消息體的正文 |
|
5.2.3 |
imageUrl |
可選 |
String |
消息體中的圖片url |
|
5.2.4 |
fileCount |
可選 |
String |
自定義的附件數(shù)目。此數(shù)字僅供顯示，不作驗證 |
|
5.2.5 |
author |
可選 |
String |
自定義的作者名字 |
|
5.2.6 |
form |
可選 |
Json數(shù)組 |
消息體的表單，最多6個 |
|
5.2.7 |
key |
可選 |
String |
消息體的關鍵字 |
|
5.2.8 |
value |
可選 |
String |
消息體的關鍵字對應的值 |