主要使用場(chǎng)景:用戶信息接口7.0
查詢班級(jí)成員列表
獲取接口訪問憑證:accessToken
url | https://api.tze.cn/user/openapi/org/get-class-member-list?top_org_id=***&org_id=***&accessToken={{accessToken}} |
請(qǐng)求方式 | get |
是否需要鑒權(quán) | 是 |
請(qǐng)求數(shù)限制 | 否 |
接口方向 | 第三方應(yīng)用->開放平臺(tái) |
序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
top_org_id |
必選 |
String |
學(xué)校id | |
2 |
org_id |
必選 |
String |
班級(jí)id | |
3 |
page |
可選 |
Int |
分頁(yè),默認(rèn)1 | |
4 |
page_size |
可選 |
Int |
數(shù)量,默認(rèn)10,上限100 |
序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
code |
必選 |
String |
結(jié)果編碼,000000:成功, 100001:失敗 | |
2 |
message |
必選 |
String |
結(jié)果描述 | |
3 |
result |
必選 |
json |
結(jié)果 | |
3.1 |
page |
必選 |
Int |
分頁(yè) | |
3.2 |
page_size |
必選 |
Int |
查詢量 | |
3.3 |
count |
必選 |
Int |
總數(shù) | |
3.4 |
member_list |
必選 |
json |
成員列表 | |
3.4.1 |
user_id |
必選 |
string |
用戶id | |
3.4.2 |
name |
必選 |
string |
姓名 | |
3.4.3 |
gender |
必選 |
string |
性別(0:女,1:男,2:未填,3:保密) | |
3.4.4 |
user_type |
必選 |
Int |
用戶類型(0學(xué)生,1老師) | |
3.4.5 |
avatar_list |
必選 |
json |
用戶頭像(1:小, 2:中, 3:大) | |
3.4.6 |
create_time |
必選 |
Int |
加入時(shí)間 | |
3.4.7 |
subject |
可選 |
json |
任教學(xué)科,老師時(shí)返回 | |
3.4.7.1 |
subject_id |
必選 |
string |
學(xué)科id | |
3.4.7.2 |
subject_name |
必選 |
string |
學(xué)科名 | |
3.4.8 |
subject_names |
必選 |
string |
學(xué)科名的集合(語(yǔ)文/數(shù)學(xué)) | |
3.4.9 |
role_type |
必選 |
string |
角色類型(header_teacher班主任;teacher老師;member成員) |
請(qǐng)求示例 http://api.tze.cn/user/openapi/org/get-class-member-list?top_org_id=***&org_id=***&accessToken={{accessToken}} 返回示例 { "code": "000000", "message": "成功", "result": { "page": 1, "page_size": 10, "count": 3, "member_list": [ { "user_id": "c55be4f8-6704-11e9-82a9-0200f7699d5b", "name": "zzzz", "gender": "2", "user_type": 1, "role_type": "teacher", "avatar_list": { "1": "", "2": "", "3": "" }, "create_time": 1554963535, "subject": [ { "subject_id": "11", "subject_name": "品德與生活(社會(huì))", }, { "subject_id": "13", "subject_name": "語(yǔ)文", }, { "subject_id": "23", "subject_name": "武術(shù)2", } ] }, { "user_id": "c51b125c-6704-11e9-82a9-0200f7699d5b", "name": "yyyy", "gender": "2", "role_type": "teacher", "avatar_list": { "1": "", "2": "", "3": "" }, "create_time": 1554963535, "subject": [] }, { "user_id": "8d23c4ce-666f-11e9-944a-0200f74753a1", "name": "xxxx", "gender": "2", "role_type": "teacher", "avatar_list": { "1": "", "2": "", "3": "" }, "create_time": 1554963535, "subject": [] } ] }, "_timestamp": "1559131523.8804", "_runtime": "0.0747" }
序號(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)的值 |