主要使用场景:用户信息接口7.0
查询班级成员列表
无
url | https://opengate-basic.cq.smartedu.cn/user/openapi/org/get-class-member-list?top_org_id=***&org_id=***&accessToken={{accessToken}} |
请求方式 | get |
是否需要鉴权 | 是 |
请求数限制 | 否 |
接口方向 | 第三方应用->开放平台 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
top_org_id |
必选 |
String |
学校id | |
2 |
org_id |
必选 |
String |
班级id | |
3 |
page |
可选 |
Int |
分页,默认1 | |
4 |
page_size |
可选 |
Int |
数量,默认10,上限100 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
code |
必选 |
String |
结果编码,000000:成功, 100001:失败 | |
2 |
message |
必选 |
String |
结果描述 | |
3 |
result |
必选 |
json |
结果 | |
3.1 |
page |
必选 |
Int |
分页 | |
3.2 |
page_size |
必选 |
Int |
查询量 | |
3.3 |
count |
必选 |
Int |
总数 | |
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学生,1老师) | |
3.4.5 |
avatar_list |
必选 |
json |
用户头像(1:小, 2:中, 3:大) | |
3.4.6 |
create_time |
必选 |
Int |
加入时间 | |
3.4.7 |
subject |
可选 |
json |
任教学科,老师时返回 | |
3.4.7.1 |
subject_id |
必选 |
string |
学科id | |
3.4.7.2 |
subject_name |
必选 |
string |
学科名 | |
3.4.8 |
subject_names |
必选 |
string |
学科名的集合(语文/数学) | |
3.4.9 |
role_type |
必选 |
string |
角色类型(header_teacher班主任;teacher老师;member成员) |
请求示例 https://opengate-basic.cq.smartedu.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": "品德与生活(社会)", }, { "subject_id": "13", "subject_name": "语文", }, { "subject_id": "23", "subject_name": "武术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" }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:text |
1.1 |
text |
必选 |
Json |
- |
text消息体 |
1.1.1 |
content |
必选 |
String |
消息内容 |
{ "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 |
对应业务的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消息在业务系统对应的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 |
自定义的附件数目。此数字仅供显示,不作验证 |
|
5.2.5 |
author |
可选 |
String |
自定义的作者名字 |
|
5.2.6 |
form |
可选 |
Json数组 |
消息体的表单,最多6个 |
|
5.2.7 |
key |
可选 |
String |
消息体的关键字 |
|
5.2.8 |
value |
可选 |
String |
消息体的关键字对应的值 |