主要使用場(chǎng)景:第三方應(yīng)用接入平臺(tái)后,需要與平臺(tái)會(huì)話保持一致時(shí)使用
通過(guò)用戶編號(hào)獲取用戶隱私信息(支持批量數(shù)據(jù),不超過(guò)200,建議數(shù)據(jù)10 - 50)
獲取接口訪問(wèn)憑證:accessToken
url | https://api.hfeducloud.cn/baseInfo/user/privacy/batch?accessToken={{accessToken}} |
請(qǐng)求方式 | post |
是否需要鑒權(quán) | 是 |
請(qǐng)求數(shù)限制 | 否 |
接口方向 | 第三方應(yīng)用->開(kāi)放平臺(tái) |
序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
user_id |
必選 |
array |
用戶編號(hào) | |
2 |
privacy |
必選 |
array |
隱私類型,0:帳號(hào) account 1:手機(jī) phone 2:郵箱 email 3:證件 card_code(身份證) 4:學(xué)生學(xué)籍號(hào) student_id 5:教師資格證號(hào) teacher_id 6:qq號(hào)碼 qq 7:地址 address 8:街道 street 9:社區(qū) community |
序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
code |
必選 |
string |
結(jié)果編碼 | |
2 |
message |
必選 |
string |
結(jié)果描述 | |
3 |
result |
必選 |
json |
結(jié)果對(duì)象 |
請(qǐng)求示例 https://api.hfeducloud.cn/baseInfo/user/privacy/batch?accessToken={{accessToken}} { "user_id": ["4743b8d8c89911e99d270200f7dc4d78","ca7a27888cb611e9af1e0200f72bb845","6a97e0548c3d11e9884d0200f7b17acf"], "privacy": ["0", "1"] } 返回示例 { "code": "000000", "message": "請(qǐng)求成功", "result": { "4743b8d8c89911e99d270200f7dc4d78": { "0_num": "9f3ac572e4f26d215d5a43d25f1018ed", "1_num": "c1b99b21b775c6c5f425ad02e6c2db3d" }, "6a97e0548c3d11e9884d0200f7b17acf": { "0_num": "c8aabd9411bc5705f101b2ca7096de90", "1_num": "0fca9b7d5ce7576ecdee4f9ebbb5e9ce" }, "ca7a27888cb611e9af1e0200f72bb845": { "0_num": "a987db35ce5b2ea1485665d995d0b7ed", "1_num": "4d1aa8179db806fc7544c1273fef5317" } } }
序號(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)的值 |