主要使用場(chǎng)景：用戶信息接口7.0
根據(jù)組織編號(hào)獲取組織成員簡(jiǎn)單列表
獲取接口訪問憑證：accessToken
| url | https://api.tze.cn/user/openapi/user/get-org-member-simple-list?accessToken={{accessToken}}&top_org_id=c2d2a224-5a9a-11e9-9c82-0200f7b88099&page=1&page_size=10 |
| 請(qǐng)求方式 | get |
| 是否需要鑒權(quán) | 是 |
| 請(qǐng)求數(shù)限制 | 否 |
| 接口方向 | 第三方應(yīng)用->開放平臺(tái) |
| 序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說明 |
|---|---|---|---|---|---|
1 |
top_org_id |
可選 |
string |
機(jī)構(gòu)、學(xué)校等組織編號(hào)（top_org_id、org_id、top_school_id不能同時(shí)為空） | |
2 |
org_id |
可選 |
string |
部門、校區(qū)、班級(jí)等單節(jié)點(diǎn)編號(hào)（top_org_id、org_id、top_school_id不能同時(shí)為空），支持復(fù)合值，用半角逗號(hào)分隔（復(fù)合查詢時(shí)需要傳遞機(jī)構(gòu)編號(hào)） | |
3 |
org_recursion |
可選 |
int |
是否包含下級(jí)節(jié)點(diǎn)成員，0:不包含（默認(rèn)），1:包含所有下級(jí)，org_id須為單值 | |
4 |
top_school_id |
可選 |
string |
校區(qū)編號(hào)，查校區(qū)及其下屬所有節(jié)點(diǎn)的數(shù)據(jù)（top_org_id、org_id、top_school_id不能同時(shí)為空） | |
6 |
name |
可選 |
string |
姓名 | |
7 |
need_type |
可選 |
string |
額外需要返回的類型（dep部門節(jié)點(diǎn),edu班級(jí)節(jié)點(diǎn),family學(xué)生家長(zhǎng)數(shù)據(jù),多個(gè)使用,逗號(hào)分隔） | |
7 |
user_type |
可選 |
int |
用戶類型，0:學(xué)生，1:老師，2:家長(zhǎng)，3:工作人員，4:機(jī)構(gòu)人員，5:企業(yè)人員，12:市民（支持復(fù)合值，用半角逗號(hào)分隔，例如：0,1）不支持家長(zhǎng)類型 | |
8 |
page |
可選 |
int |
頁碼 | |
9 |
page_size |
可選 |
int |
每頁條數(shù)，默認(rèn)10，最大500條 |
| 序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說明 |
|---|---|---|---|---|---|
1 |
code |
必選 |
string |
結(jié)果編碼 | |
2 |
message |
必選 |
string |
結(jié)果描述 | |
3 |
result |
可選 |
json |
結(jié)果對(duì)象 | |
3.1 |
page |
必選 |
int |
頁碼 | |
3.2 |
page_size |
必選 |
int |
每頁條數(shù) | |
3.3 |
count |
必選 |
int |
數(shù)量 | |
3.4 |
member_list |
必選 |
json數(shù)組 |
成員列表 | |
3.4.1 |
user_id |
必選 |
string |
成員id | |
3.4.2 |
user_type |
必選 |
string |
成員類型 | |
3.4.3 |
name |
必選 |
string |
成員姓名 | |
3.4.4 |
user_org |
可選 |
json數(shù)組 |
部門、班級(jí)列表信息，設(shè)置need_type時(shí)返回 | |
3.4.4.1 |
org_id |
必選 |
string |
部門、班級(jí)id | |
3.4.4.2 |
org_type |
必選 |
string |
節(jié)點(diǎn)類型("1": "機(jī)構(gòu)","2": "學(xué)校","3": "校區(qū)","4": "部門","5": "學(xué)段","6": "年級(jí)","7": "班級(jí)","8": "企業(yè)機(jī)構(gòu)","9": "教學(xué)工作室","10": "平臺(tái)") | |
3.4.5 |
user_family |
可選 |
json數(shù)組 |
學(xué)生的家長(zhǎng)信息，設(shè)置need_type時(shí)返回 | |
3.4.5.1 |
family_id |
必選 |
string |
家長(zhǎng)用戶id | |
3.4.5.2 |
family_name |
必選 |
string |
家長(zhǎng)的稱謂(xx的媽媽) |
請(qǐng)求示例
http://api.tze.cn/user/openapi/user/get-org-member-simple-list?accessToken={{accessToken}}&top_org_id=c2d2a224-5a9a-11e9-9c82-0200f7b88099&page=1&page_size=10
返回示例
{
"code": "000000",
"message": "請(qǐng)求成功",
"result": {
"page": 1,
"page_size": 10,
"count": 3,
"member_list": [
{
"user_id": "b4c63e54-5a9d-11e9-a503-0200f757af5f",
"user_type": "1",
"name": "xxx"
},
{
"user_id": "805a9c00-5a9d-11e9-976d-0200f757af5f",
"user_type": "1",
"name": "yyy"
},
{
"user_id": "af144ae4-5a9a-11e9-9c82-0200f7b88099",
"user_type": "1",
"name": "zzz"
}
]
}
}
| 序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說明 |
|---|---|---|---|---|---|
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)度 | 說明 |
|---|---|---|---|---|---|
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)度 | 說明 |
|---|---|---|---|---|---|
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)的值 |