主要使用場(chǎng)景：oauth認(rèn)證類接口
第三方從oauth授權(quán)登錄后跳轉(zhuǎn)的鏈接中獲取到用戶的personId和oauthCode，通過(guò)oauthCode臨時(shí)碼獲取Oauth令牌(默認(rèn)15天有效,使用后會(huì)延長(zhǎng))，然后保存到系統(tǒng)中，這樣兩個(gè)平臺(tái)間用戶的關(guān)系就綁定了。
獲取接口訪問(wèn)憑證：accessToken
| url | https://api.tze.cn/oauth/getOauthToken?accessToken={{ACCESS_TOKEN}} |
| 請(qǐng)求方式 | post |
| 是否需要鑒權(quán) | 是 |
| 請(qǐng)求數(shù)限制 | 否 |
| 接口方向 | 第三方應(yīng)用->開(kāi)放平臺(tái) |
| 序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
|---|---|---|---|---|---|
1 |
oauthCode |
必選 |
String |
oauth授權(quán)登錄后返回的憑證 |
| 序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
|---|---|---|---|---|---|
1 |
retCode |
必選 |
String |
結(jié)果編碼 | |
2 |
retDesc |
必選 |
String |
結(jié)果描述 | |
3 |
data |
必選 |
json |
json對(duì)象 | |
4 |
expiry |
必選 |
String |
時(shí)間戳 | |
5 |
oauthToken |
必選 |
String |
Oauth令牌 |
請(qǐng)求參數(shù)：
{
"oauthCode": "0b37d86ec2796085eb4******"
}
返回示例
{
"retCode": "000000",
"retDesc": "success",
"data": {
"expiry": 1602052142464,
"oauthToken": "bec21f569fb7e183205f94497ecbe9c5"
}
}
| 序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
|---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型，此時(shí)固定為：text |
1.1 |
text |
必選 |
Json |
- |
text消息體 |
1.1.1 |
content |
必選 |
String |
消息內(nèi)容 |
{
"msgtype": "text",
"text": {
"content": "zhxy msg text test 12"
}
}
| 序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
|---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型，此時(shí)固定為：link |
2 |
link |
必選 |
Json |
- |
link消息體 |
2.1 |
pcUrl |
必選 |
String |
PC端消息點(diǎn)擊鏈接地址 |
|
2.2 |
appUrl |
必選 |
String |
移動(dòng)客戶端點(diǎn)擊消息時(shí)跳轉(zhuǎn)到的H5地址 |
|
2.3 |
title |
必選 |
String |
消息標(biāo)題 |
|
2.4 |
busiId |
必選 |
String |
對(duì)應(yīng)業(yè)務(wù)的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"
}
}
| 序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
|---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型，此時(shí)固定為：oa |
2 |
busiId |
必選 |
String |
- |
該條oa消息在業(yè)務(wù)系統(tǒng)對(duì)應(yīng)的id |
3 |
pcUrl |
必選 |
String |
消息點(diǎn)擊鏈接地址 |
|
4 |
appUrl |
必選 |
String |
移動(dòng)客戶端點(diǎn)擊消息時(shí)跳轉(zhuǎn)到的H5地址 |
|
5 |
oa |
必選 |
Json |
- |
oa類型消息體 |
5.1 |
head |
必選 |
Json |
255 |
消息頭部Json |
5.1.1 |
text |
必選 |
String |
255 |
消息的頭部標(biāo)題 |
5.1.2 |
bgColor |
可選 |
String |
消息頭部的背景顏色。長(zhǎng)度限制為8個(gè)英文字符，其中前2為表示透明度，后6位表示顏色值。不要添加0x。默認(rèn)值：FFCC0000 |
|
5.2 |
body |
可選 |
Json |
消息體 |
|
5.2.1 |
title |
可選 |
String |
消息體的標(biāo)題 |
|
5.2.2 |
content |
可選 |
String |
消息體的正文 |
|
5.2.3 |
imageUrl |
可選 |
String |
消息體中的圖片url |
|
5.2.4 |
fileCount |
可選 |
String |
自定義的附件數(shù)目。此數(shù)字僅供顯示，不作驗(yàn)證 |
|
5.2.5 |
author |
可選 |
String |
自定義的作者名字 |
|
5.2.6 |
form |
可選 |
Json數(shù)組 |
消息體的表單，最多6個(gè) |
|
5.2.7 |
key |
可選 |
String |
消息體的關(guān)鍵字 |
|
5.2.8 |
value |
可選 |
String |
消息體的關(guān)鍵字對(duì)應(yīng)的值 |