主要使用場景:oauth認證類接口
第三方從oauth授權登錄后跳轉的鏈接中獲取到用戶的personId和oauthCode,通過oauthCode臨時碼獲取Oauth令牌(默認15天有效,使用后會延長),然后保存到系統(tǒng)中,這樣兩個平臺間用戶的關系就綁定了。
獲取接口訪問憑證:accessToken
url | https://api.tze.cn/oauth/getOauthToken?accessToken={{ACCESS_TOKEN}} |
請求方式 | post |
是否需要鑒權 | 是 |
請求數(shù)限制 | 否 |
接口方向 | 第三方應用->開放平臺 |
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
oauthCode |
必選 |
String |
oauth授權登錄后返回的憑證 |
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
retCode |
必選 |
String |
結果編碼 | |
2 |
retDesc |
必選 |
String |
結果描述 | |
3 |
data |
必選 |
json |
json對象 | |
4 |
expiry |
必選 |
String |
時間戳 | |
5 |
oauthToken |
必選 |
String |
Oauth令牌 |
請求參數(shù): { "oauthCode": "0b37d86ec2796085eb4******" } 返回示例 { "retCode": "000000", "retDesc": "success", "data": { "expiry": 1602052142464, "oauthToken": "bec21f569fb7e183205f94497ecbe9c5" } }
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
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 |
移動客戶端點擊消息時跳轉到的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 |
移動客戶端點擊消息時跳轉到的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 |
消息體的關鍵字對應的值 |