top
关闭

开发者登录

用户基本信息API

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

1、获取用户列表信息

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

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

orgId

必选

Body(json)

String

64

机构或者学校Id

2

userType

可选

Body(json)

String

1

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

3

start

必选

Body(json)

Int

8

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

4

end

必选

Body(json)

Int

8

获取结束记录下标

返回说明

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

1

retCode

必选

String

6

结果000000:成功

2

retDesc

必选

String

100

返回结果描述

3

start

必选

Int

8

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

4

end

必选

Int

8

获取结束记录下标

5

userList

可选

Json对象

0

用户信息

5.1

personId

可选

String

64

用户的统一ID;

5.2

name

可选

String

100

用户姓名

5.3

gender

可选

String

1

性别0是女,1为男

5.4

userType

可选

String

1

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

5.5

logoList

可选

Json对象

-

机构Id

5.5.1

logoType

可选

Int

1

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

5.5.2

logoUrl

可选

String

100

头像LOGO(外网绝对地址)

6

orgId

可选

String

64

学校Id

7

orgName

可选

String

100

学校名称

8

count

可选

Int

8

用户数量

示例

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

2、获取教师教学信息

获取教师的教学信息

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

personId

必选

Body(json)

String

64

用户ID

返回说明

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

1

retCode

必选

String

6

返回码

2

retDesc

可选

String

-

返回码描述

3

personId

可选

String

64

教师Id

4

name

可选

String

100

教师姓名

5

mainSubjectId

可选

String

64

主教学科Id

6

mainSubjectName

可选

String

50

主教学科名称

7

studyPhase

可选

String

2

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

8

teachList

可选

Json对象

-

任教信息列表

8.1

subjectId

可选

String

64

学科Id

8.2

subjectName

可选

String

50

学科名称

8.3

classId

可选

String

64

班级Id

8.4

className

可选

String

50

班级名称

示例

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

3、查询用户基本信息

返回用户基本信息,包含帐号及头像URL

前置条件

请求说明

url https://opengate.huijiaoyun.com/aamif/rest/get/baseUserInfo
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方平台>开放平台

参数说明

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

1

personid

必选

Body(json)

String

64

用户ID

返回说明

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

1

personid

必选

String

64

用户ID

2

name

必选

Stinrg

64

64

3

gender

必选

String

64

性别

4

signature

可选

String

-

署名

5

mobileno

可选

String

32

电话号码

6

email

可选

String

64

邮件

7

usertype

必选

String

32

用户类型

示例

							请求报文:
{
    "personid":"F6C68AAFA38D437CE040007F01001D3D"
}

应答报文:
{
    "result": "000000", 
    "userinfo": {
        "personid": "111", 
        "name": "name", 
        "gender": "1", 
        "signature": "1", 
        "mobileno": "mobile", 
        "email": "163.com", 
        "usertype": "2", 
        "platformCode": "19900101", 
        "accounts": [
            "xiaozhang", 
            "xiaoming"
        ], 
        "userlogolist": [
            {
                "logotype": "11", 
                "logourl": "111111"
            }, 
            {
                "logotype": "22", 
                "logourl": "222222"
            }
        ]
    }
}
						

4、获取用户基本信息

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

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

personId

必选

Body(json)

String

64

用户ID

返回说明

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

1

retCode

必选

String

6

返回码

2

retDesc

必选

String

100

返回码描述

3

userInfo

可选

Json对象

-

用户信息Json对象

3.1

personId

可选

String

64

用户的统一ID

3.2

name

可选

String

100

用户姓名

3.3

nickName

可选

String

100

昵称

3.4

gender

可选

String

1

性别0是女,1为男

3.5

userType

可选

String

1

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

3.6

logoList

可选

Json对象

-

头像LOGO(URL地址)列表

3.6.1

logoType

可选

Int

1

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

3.6.2

logoUrl

可选

String

100

头像LOGO(外网绝对地址)

3.7

regiTime

可选

String

20

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

3.8

orgId

可选

String

64

机构Id

3.9

oraName

可选

String

100

机构名称

3.10

userIdentity

可选

String

20

机构身份:
1:班主任
2:班长
3:管理员
4:教师
5:成员
支持返回多身份,多身份用逗号“,”进行分隔

3.11

relList

可选

Json对象

-

用户与班级关系身份信息

3.11.1

classId

可选

String

64

班级Id

3.11.2

className

可选

String

100

班级名称

3.11.3

identityId

可选

String

50

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

3.12

studentRollNo

可选

String

32

学籍号

3.13

address

可选

String

100

住址

3.14

phoneNumbers

可选

String

11

电话

示例

							请求报文:
        {
            "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"
  }
}
						

参数说明

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

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

消息体的关键字对应的值