top

关闭

开发者登录

概述
开放平台概述
接入指南
开发者注册
应用接入规范
应用运营管理
标准规范
开发者协议
违规处理规范
登录服务协议
公共返回码说明
API索引
认证和基础数据类
资源服务类
调试工具
API调用说明
API调试工具
认证类接口

主要使用场景：第三方应用接入平台后，需要与平台会话保持一致时使用

1、验证ticket信息7.0

基础 需要授权

根据ticket验证ticket信息，ticket为一次性调用

前置条件

a.获取接口访问凭证：accessToken
b.获取用户会话ticket信息

请求说明

url https://api.lzeduyun.cn/user/openapi/user/verify-ticket-info?ticket=**&accessToken={{ACCESS_TOKEN}}
请求方式 get
是否需要鉴权 是
请求数限制 是
接口方向 第三方应用>开放平台

参数说明

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

1

ticket

必选

String

64

 ticket

返回说明

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

1

code

必选

string

结果编码

2

message

必选

string

结果描述

3

result

可选

json

结果对象

3.0

usession_id

必选

string

用户会话编号

3.1

user_id

必选

string

用户编号

3.2

platform_code

必选

string

平台编号

3.3

v_platform_code

必选

string

虚拟平台编号（多值用逗号分隔）

3.4

name

必选

string

用户姓名

3.5

gender

必选

int

性别（0:女，1:男，2:保密）

3.6

birthdate

必选

string

出生日期

3.7

status

必选

int

状态(0:未激活, 1:正常, 2:注销, 3:锁定, 4:安管锁定)

3.8

province_code

必选

string

所在省

3.9

city_code

必选

string

所在市

3.10

area_code

必选

string

所在区

3.11

user_family

必选

json数组

用户家庭关系(识别init_user_type等于0是学生, 或识别user_top_org里的user_type等于0是学生,反之user_family不为空的就是家长,)

3.11.1

bind_user_id

必选

string

被绑定的用户id

3.11.2

relation_name

必选

string

绑定的称谓

3.11.3

relation_type

必选

string

绑定的家庭关系(正数时:被绑定的是家长，负数时:被绑定的是学生)

3.12

user_org

必选

json数组

用户所属部门、班级等节点

3.12.1

org_id

必选

string

用户所属部门、班级等节点id

3.12.2

top_org_id

必选

string

部门、班级所属的机构、学校id

3.12.3

org_type

必选

string

组织类型 “1”: “机构” “2”: “学校” “3”: “校区” “4”: “部门” “5”: “学段” “6”: “年级” “7”: “班级” “8”: “企业机构” “9”: “教学工作室” “10”: “平台”

3.12.4

attr

必选

json数组

用户在部门、班级等节点里的独立属性数据(例如class_teacher_subject教师班级任教学科信息、class_header_teacher班级班主任标识、class_monitor_student班级班长标识)

3.12.5

org_name

必选

string

用户所在部门、班级等节点名称

3.12.6

top_org_name

必选

string

用户所在机构、学校的名称

3.12.7

top_school_id

可选

string

仅在当前节点是校区、学段、年级、班级时返回所在的校区id

3.12.8

top_school_name

可选

string

仅在当前节点是校区、学段、年级、班级时返回所在的校区名称

3.13

user_top_org

必选

json数组

用户所属机构、学校等组织

3.13.1

name

必选

string

用户在所属组织里的名称

3.13.2

org_type

必选

string

用户所属组织的组织类型

3.13.3

user_type

必选

string

用户在所属组织的用户类型

3.13.4

org_id

必选

string

用户所属组织的组织id

3.13.5

top_org_name

必选

string

用户所属组织的组织名称

3.14

user_role

必选

json数组

用户权限或用户岗位信息 ,使用文档六.12可单独查询用户权限。权限判断简单说明： 1、主管理员，查找user_role下top_org_id=组织id，且parent_id=1. 2、子管理员，查找user_role下top_org_id=组织id，且parent_id=2. 2.1、管理范围判断：查找power_name=sub_manager_department，且power_value包含all或者部门id 2.2、基础权限判断：查找power_name=sub_manager_app，且power_value包含all或者基础权限id 2.3、应用权限判断：查找power_name=sub_manager_campus，且power_value包含all或者应用id

3.14.1

parent_id

必选

string

当值为数字类型时，表示平台系统设置的默认角色，如1为主管理员，2为子管理员，更多默认角色列表参考接口十三.8 当值为字符串类型时，表示组织内自定义岗位，如 后勤管理 等，若想取得自定义岗位名称，可使用下面的role_id信息，通过接口六.4获取

3.14.2

role_id

必选

string

自定义角色/岗位id

3.14.3

top_org_id

必选

string

角色/岗位所属机构、学校等组织id

3.14.4

org_id

必选

string

角色/岗位所属部门id

3.14.5

role_type

必选

string

角色/岗位类型，0系统，1普通，2自定义，废弃

3.14.6

_power

必选

json数组

子管理员权限信息，包含部门管理范围、基础权限、应用权限三个部分

3.14.6.1

power_name

必选

string

权限类型 1、sub_manager_department：部门管理范围，如全学校、所在部门等 2、sub_manager_app：基础权限，将在以上部门管理范围配置权限，如成员管理、设置管理 3、sub_manager_campus：应用权限

3.14.6.2

power_value

必选

数组

权限值，与power_name关联。”all”表示全部权限，其他权限对应如下： 1、power_name为sub_manager_department表示部门管理范围。power_value取值，all:全学校，dep:所在部门及下级部门，部门ids：多个部门id逗号分隔，表示管理特定部门 2、power_name为sub_manager_app表示基础权限。power_value取值，1:成员管理，6:组织管理，7:班级管理，3:工作台管理，4:设置,5:门户管理，8:资源库管理，9:数据管理，10:权限管理，11:数据上报 3、power_name为sub_manager_campus表示应用权限，power_value取值参照接口六.17

3.15

avatar

必选

json

用户头像（1:小, 2:中, 3:大）

3.16

last_top_org_id

必选

string

最后切换的机构、学校等组织编号

3.17

last_top_org_name

必选

string

最后切换的机构、学校等组织名称

3.18

last_user_type

必选

int

最后所属的用户类型

3.19

init_user_type

必选

int

用户初始注册用户类型(0学生，1老师，2家长等等)

3.20

init_v_platform_code

必选

string

用户初始虚拟平码编码

示例

							请求示例
https://api.lzeduyun.cn/user/openapi/user/verify-ticket-info?ticket=**&accessToken={{ACCESS_TOKEN}}

返回示例
{
  "code": "000000",
  "message": "请求成功",
  "result": {
      "usession_id": "1291f592-7519-11e9-a1f3-0200f7934077"，
      "xxxx": "xxxx",
      "yyyy": "yyyy",
    }
}

参数说明

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

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

消息体的关键字对应的值