top
关闭

开发者登录

用户基本信息API

主要使用场景:需要获取单个或者多个用户信息以及单个教师的教学信息时使用

1、获取用户基本信息

根据用户Id获取用户的基本信息。

前置条件

a、获取接口访问凭证:accessToke

请求说明

url http://opengate.huijiaoyun.com/baseInfo/user/getUserById?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

personId

必选

String

64.0

用户ID

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

必选

String

6.0

返回码

2

retDesc

必选

String

100.0

返回码描述

3

userInfo

可选

Json对象

-

用户信息Json对象

3.1

personId

可选

String

54

用户的统一ID

3.2

name

可选

String

100.0

用户姓名

3.3

nickName

可选

String

100.0

昵称

3.4

gender

可选

String

1.0

性别
0:女
1:男

3.5

userType

可选

String

1.0

用户类型
0:学生
1:老师
2:家长
3:机构
4:学校
5:学校工作人员

3.6

logoList

可选

Json对象

-

头像LOGO(URL地址)列表

3.6.1

logoType

可选

Int

1.0

浏览渠道
1:小
2:中
3:大

3.6.2

logoUrl

可选

String

100.0

头像LOGO(外网绝对地址)

3.7

regiTime

可选

String

20.0

注册时间 YYYY-MM-DD 00:00:00

3.8

orgId

可选

String

64.0

机构Id

3.9

oraName

可选

String

100.0

机构名称

3.10

userIdentity

可选

String

2.0

机构身份
1:班主任
2:班长
3:管理员
4:教师
5:成员

3.11

relList

可选

Json对象

-

用户与班级关系身份信息

3.11.1

classId

可选

String

64.0

班级Id

3.11.2

className

可选

String

100.0

班级名称

3.11.3

identityId

可选

String

50

用户在班级中的身份:
1:班主任
2:班长
3:管理员
4:教师
5:成员
6:教研员
7:教务员
8:信息员

示例

							请求报文:
        {
            "personId" : "******",
        }
 应答报文:
{
  "retCode": "000000",
  "retDesc": "success",
  "userInfo": {
    "gender": "0",
    "name": "周**",
    "oraName": "东***中学",
    "orgId": "033f4cda3792495da0d5c28dda9****",
    "personId": "10cda06c25224f4e931c198c******",
    "regiTime": "2016-12-12 17:01:56",
    "relList": [
      {
        "classId": "4569580254c74856bca2d830f******",
        "className": "七年级*班",
        "identityId": "4"
      },
      {
        "classId": "ca2a1b8f748a47498d747242******",
        "className": "八年级*班",
        "identityId": "4"
      }
    ],
    "userIdentity": "3,4",
    "userType": "1"
  }
}
						

2、获取用户列表信息

获取机构下的用户列表信息。

前置条件

a、获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/baseInfo/user/getUserList?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

orgId

必选

String

64.0

机构或者学校Id

2

userType

可选

String

1.0

用户类型
0:学生
1:老师
2:家长
3:机构
4:学校
5:学校工作人员
6:机构工作人员

3

start

必选

Int

8.0

获取开始记录下标,从1开始

4

end

必选

Int

8.0

获取结束记录下标

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

必选

String

6.0

结果
000000:成功

2

retDesc

必选

String

100.0

返回结果描述

3

start

必选

Int

8.0

获取开始记录下标,从1开始

4

end

必选

Int

8.0

获取结束记录下标

5

userList

可选

Json对象

-

用户信息

5.1

personId

可选

String

64.0

用户的统一ID

5.2

name

可选

String

100.0

用户姓名

5.3

gender

可选

String

1.0

性别
0:女
1:男

5.4

userType

可选

String

1.0

用户类型
0:学生
1:老师
2:家长
3:机构
4:学校
5:学校工作人员
6:机构工作人员

5.5

logoList

可选

Json对象

-

头像LOGO(URL地址)列表

5.5.1

logoType

可选

Int

1.0

浏览渠道
1:小
2:中
3:大

5.5.2

logoUrl

可选

String

100.0

头像LOGO(外网绝对地址)

6

orgId

可选

String

64.0

学校Id

7

orgName

可选

String

100.0

学校名称

8

count

可选

Int

8.0

用户数量

示例

							请求报文:
{
    "start" : 1,
    "end" : 2,
"orgId" : "SDFGHJKLKJHGFD******"
}
应答报文:
{
    "retCode": "000000",
"retDesc": "success",
    "start": 1,
    "end": 2,
    "count": "100",
    "userList": [
        {
        "personId": "******",
        "name": "张******",
    "userType": "0"
    }
    ],
"orgId" : "SDFGHJKLKJHGFD******",
    "orgName": "杭州市*****中学"
  }
						

3、获取教师教学信息

获取教师的教学信息

前置条件

a、获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/baseInfo/user/getTeachingInfo?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

personId

必选

String

64.0

用户ID

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

必选

String

6.0

返回码

2

retDesc

可选

String

100

返回码描述

3

personId

可选

String

64.0

教师Id

4

name

可选

String

100.0

教师姓名

5

mainSubjectId

可选

String

64.0

主教学科Id

6

mainSubjectName

可选

String

50.0

主教学科名称

7

studyPhase

可选

String

2

学段:
0:小学
1:初中
2:高中
3:学前

8

teachList

可选

Json数组

-

任教信息列表

8.1

subjectId

可选

String

64.0

学科Id

8.2

subjectName

可选

String

50.0

学科名称

8.3

classId

可选

String

64.0

班级Id

8.4

className

可选

String

50.0

班级名称

示例

							请求报文:
{
    "personId":"*******"
}
应答报文:
{
   "retCode": "000000",
   "retDesc": "success",
   "name": "何***",
   "personId": "F259F9A3120D7692E0401******",
   "teachList": []
}
						

4、查询成员信息

查询成员信息。根据注册时间倒序返回.如查询是群时,则按加入群组的时间倒序返回

前置条件

获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/baseInfo/user/queryMember?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

groupId

必选

String

32

群组ID,可为机构ID、学校ID、 班级ID、群组ID、好友群组ID、 兴趣小组ID等

2

type

可选

JSON[]

-

成员类型 默认5 学生:0 老师:1 家长:2 机构:3 学校:4 工作人员:5 机构工作人员:6 社会学习者:7 如合作伙伴或资源提供商:9 其他:11 散户:12

3

identity

可选

JSON[]

-

identity是一个json数组: 0.社区创建者 1:社区管理员 2:社区助学者 3:社区成员

4

gender

可选

String

1

性别;1:男 ;0:女;

5

start

可选

Int

6

查询记录开始下标

6

end

必选

Int

6

查询记录结束下标

7

name

必选

String

100

真实姓名(模糊匹配前置条件)

8

auditStatus

可选

JSON[]

-

按社区成员状态查询成员: 0:正常(早批通过) 1:待审批 2:已拒绝 3:已删除

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

必选

String

6

结果编码 000000:成功 100001:失败 100099:参数错误

2

retDesc

可选

String

100

结果描述

3

start

必选

Int

6

查询开始位置

4

end

必选

Int

6

查询结束位置

5

count

必选

Int

6

总记录条数

6

dataList

可选

JSON[]

-

-

6.1

personId

可选

String

32

用户的统一ID

6.2

mobnum

可选

String

18

手机号码

6.3

email

可选

String

100

邮箱

6.4

name

可选

String

64

用户姓名

6.5

nickName

可选

String

64

昵称

6.6

areaCode

可选

String

8

用户归属地区域

6.7

name

可选

String

64

姓名

6.8

gender

可选

String

6

性别 0是女,1为男

6.9

birthday

可选

String

18

生日

6.10

userType

可选

String

6

用户类型 学生:0 老师:1 家长:2 机构:3

6.11

address

可选

String

100

通讯地址

6.12

postcode

可选

String

6

邮编

6.13

userlogoList

可选

JSON[]

-

头像LOGO(URL地址)列表

6.13.1

logoType

可选

String

6

浏览渠道: 1:小; 2:中; 3:大;

6.13.2

logoUrl

可选

String

100

头像LOGO(URL地址)

6.14

interests

可选

String

100

兴趣,多个兴趣之间用分号分开

6.15

profession

可选

String

100

职业

6.16

credType

可选

String

6

证件类型: 0:身份证 1:护照 2:军人证 3:其他

6.17

idcard

可选

String

18

证件号码

6.18

singature

可选

String

100

签名

6.19

fansCount

可选

Int

6

粉丝数

6.20

teachesubjectList

可选

JSON[]

-

如登录用户为教师,则返回所教学科,JSON数组

6.20.1

userClassId

可选

String

32

用户所在班级id

6.20.2

userClassName

可选

String

64

用户所在班级名称

6.20.3

classNum

可选

Int

6

班级成员数

6.21

orgId

可选

String

32

用户所在机构\学校id

6.22

orgName

可选

String

64

用户所在机构\学校名称

6.23

orgIdentity

可选

JSON[]

-

用户在机构身份: 1:管理员 2:成员 3:教研员; 4:教务员; 5:信息员,

6.24

account

可选

String

64

用户账号

6.25

status

可选

Int

1

状态; 1:正常 2:锁定

6.26

studentRollNo

可选

String

16

学籍号

6.27

studentExamNo

可选

String

16

考号

6.28

classId

可选

String

32

用户所在班级id

6.29

className

可选

String

64

班级名称

示例

							请求参数:
{
    groupId: d4e8b27470db410f82548f1a9bf3aa82,
    type: [ 0 ],
    start: 0,
    end: 2
}
返回参数:
{
    dataList: [
        {
            account: tybb01,
            fansCount: 0,
            gender: 1,
            name: 北北,
            orgId: d4e8b27470db410f82548f1a9bf3aa82,
            orgName: 天喻测试小学,
            personId: c96561c9be7148d1b04b048c6384d61e,
            status: 1,
            userlogoList: [],
            userType: 0
        },
        {
            account: tydd01,
            fansCount: 0,
            gender: 1,
            name: 东东,
            orgId: d4e8b27470db410f82548f1a9bf3aa82,
            orgName: 天喻测试小学,
            personId: 95016c8fddea4c43a53b30d821841eb2,
            status: 1,
            userlogoList: [],
            userType: 0
        }
    ],
    retCode: 000000,
    count: 4,
    start: 0,
    end: 2
}
						

5、获取用户信息

用户登录门户后,通过该接口获取用户信息

前置条件

a.获取接口访问凭证:accessToken

请求说明

url http://ip:port/baseInfo/user/getUserInfo/openRest/{personid}?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

必选

String

6

返回码

2

retDesc

可选

String

100

返回码描述

3

userInfo

可选

json

-

用户信息,JSON对象

3.1

personId

可选

String

32

用户id

3.2

phoneNumbers

可选

String

16

手机号码

3.3

birthday

可选

String

16

生日

3.4

gender

可选

String

1

性别

3.5

name

可选

String

64

姓名

3.6

userType

可选

String

1

用户类型:学生:0老师:1家长:2机构:3学校:4学校工作人员:5机构工作人员:6

3.7

regiTime

可选

String

16

注册时间

3.8

platformCode

可选

String

6

平台编码

3.9

platformName

可选

String

6

平台名称

3.10

comefrom

可选

String

1

来源

3.11

idcardno

可选

String

16

身份证

3.12

fnasCount

可选

String

16

粉丝数

3.13

isLeader

可选

String

1

是否为领导0:不为领导1:为领导3:推荐领导

3.14

isFamousTeacher

可选

String

1

是否为名师0:不为名师1:为名师3:推荐名师

3.15

lastLoginTime

可选

String

16

最后登陆时间

3.16

loginCount

可选

String

6

登录次数

3.17

userLogoList

可选

JSON

100

头像LOGO(URL地址)列表

3.17.1

logoType

可选

String

1

浏览渠道:1:小;2:中;3:大;

3.17.2

logoUrl

可选

String

100

头像LOGO(URL地址)

3.18

orgId

可选

String

32

所在机构\学校id

3.19

orgName

可选

String

64

所在机构\学校名称

3.20

proviceName

可选

String

6

省份

3.21

cityName

可选

String

6

城市

3.22

proviceCode

可选

String

6

省份编码

3.23

cityCode

可选

String

6

城市编码

3.24

orgIdentity

可选

String

1

在机构身份:1:班主任;2:班长;3:管理员;4:教师;5:普通成员 6:教研员,7:教务员,8:信息员

3.25

account

可选

String

16

账号

3.26

teacheSubjectList

可选

JSON

64

所教学科

3.26.1

subjectId

可选

String

32

学科id

3.26.2

subjectName

可选

String

32

学科名称

3.26.3

teachMaterialId

可选

String

32

教材id

3.26.4

teachMaterialName

可选

String

64

教材名称

3.26.5

classId

可选

String

32

班级id

3.26.6

className

可选

String

32

班级名称

3.26.7

foundTime

可选

String

64

班级成立年份

3.26.8

classIdentity

可选

json[]

-

所在班级身份: 1:班主任 2:班长 3:管理员4: 教师 5:成员

3.27

dataExFrom

可选

json[]

-

数据来源

3.28

areaCode

可选

String

6

地区编码

3.29

areaName

可选

String

64

地区名称

3.30

introduce

可选

String

64

个人简介

3.31

studentClassId

可选

String

32

学生所在班级id

3.32

studentClassName

可选

String

100

学生所在班级名称

3.33

studentRollNo

可选

String

32

学籍号

示例

参数说明

请求参数消息体-文本类
序号 字段名 约束 类型 长度 说明

1

msgType

必选

String

10

消息类型,此时固定为:text

1.1

text

必选

Json

-

text消息体

1.1.1

content

必选

String

消息内容

示例

{
	"msgtype": "text",
	"text": {
		"content": "zhxy msg text test 12"
	}
}
											

参数说明

请求参数消息体-link类
序号 字段名 约束 类型 长度 说明

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"
	}
}
											

参数说明

请求参数消息体-oa类
序号 字段名 约束 类型 长度 说明

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

消息体的关键字对应的值