消息类型定义
消息类型 | 描述 |
---|---|
education_event_access | 门禁事件消息 |
education_event_alarm | 报警事件消息 |
education_event_state | 状态事件消息 |
education_message_class | 班级事件消息 |
education_message_department | 部门事件消息 |
education_message_student | 学生事件消息 |
education_message_staff | 教职工事件消息 |
education_message_parent | 家长事件消息 |
education_message_access_state | 门禁权限下发状态消息 |
education_class_brand_leave_message | 班牌留言事件消息 |
education_class_brand_class_attendance_message | 班牌课堂考勤事件消息 |
education_class_brand_person_auth_message | 班牌人员认证事件消息 |
education_event_intercom | 对讲事件消息 |
education_class_brand_trans_parent_upload_message | 班牌数据透传消息 |
education_event_visitor | 访客事件消息 |
education_message_leave | 请假事件消息 |
education_school_attendance_message | 校园考勤消息 |
education_event_physical_exam | 学生体检数据消息 |
门禁事件消息
education_event_access消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventId | 事件ID | String | 64 | 是 | |
dateTime | 事件时间(UTC+08:00) | String | 25 | 是 | |
deviceSerial | 设备序列号 | String | 9 | 是 | |
deviceType | 设备类型 | String | 16 | 否 | [10250]门禁设备[10252]电子班牌[10256]热成像设备 |
channelNo | 设备监控点号 | String | 16 | 否 | |
channelName | 设备监控点名称 | String | 128 | 是 | |
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
eventDescription | 事件描述 | String | 255 | 否 | |
pictureURL | 图片URL | String | 255 | 否 | |
detailInfo | 事件详情 | Object | 否 | ||
eventComment | 备注 | String | 128 | 否 | |
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
detailInfo字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
personId | 人员ID | String | 32 | 是 | |
personNo | 人员工号/学号 | String | 20 | 是 | |
personName | 人员名称 | String | 30 | 是 | |
personType | 人员类型 | Integer | 是 | [0]未知[1]教职工[2]学生[3]家长 | |
cardNo | 卡号 | String | 20 | 否 | |
outInType | 出入类型 | Integer | 否 | [-1]未知[0]入门[1]出门 | |
bodyTemperature | 体温 | String | 8 | 否 | 例如:“36.50”表示体温为36.50摄氏度 |
healthCode | 健康码 | String | 8 | 否 | [0]绿码[1]黄码[2]红码[3]未申领 |
消息示例:
{
"eventId":"5c063628b8894d44dcad133e",
"dateTime":"2018-05-21T12:06:00+08:00",
"deviceSerial":"C29895884",
"deviceType":"10250",
"channelNo":"1",
"channelName":"校门口监控点1",
"eventType":"AccessEvent",
"eventCode":"10114",
"eventDescription":"AccessControllerEvent",
"pictureURL":"https://pic.hik-cloud.com/edu/face/001.JPG",
"detailInfo":{
"personId":"5c063628b8894d44dcad133e",
"personNo":"16842567",
"personName":"张三",
"personType":1,
"cardNo":"201736547",
"outInType":1,
"bodyTemperature":"36.50",
"healthCode":"0"
},
"eventComment":"",
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
报警事件消息
education_event_alarm消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventId | 事件ID | String | 64 | 是 | |
dateTime | 事件时间(UTC+08:00) | String | 25 | 是 | |
deviceSerial | 设备序列号 | String | 9 | 是 | |
deviceType | 设备类型 | String | 16 | 否 | [10250]门禁设备[10252]电子班牌[10256]热成像设备 |
channelNo | 设备监控点号 | String | 16 | 否 | |
channelName | 设备监控点名称 | String | 128 | 是 | |
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
eventDescription | 事件描述 | String | 255 | 否 | |
pictureURL | 图片URL | String | 255 | 否 | |
detailInfo | 事件详情 | Object | 否 | ||
eventRemark | 备注 | String | 128 | 否 | |
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
detailInfo字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
mask | 是否佩戴口罩 | String | 8 | 否 | |
temperatureList | 体温信息 | List | 否 | ||
personId | 人员ID | String | 32 | 否 | |
personNo | 人员工号/学号 | String | 20 | 否 | |
personName | 人员名称 | String | 30 | 否 | |
personType | 人员类型 | Integer | 否 | [0]未知[1]教职工[2]学生[3]家长 | |
organization | 所属组织/班级 | String | 64 | 否 | |
checkType | 检测类型 | String | 8 | 否 | [0]手动[1]自动 |
healthCode | 健康码 | String | 8 | 否 | [0]绿码[1]黄码[2]红码[3]未申领 |
消息示例:
{
"eventId":"5c063628b8894d44dcad133e",
"dateTime":"2018-05-21T12:06:00+08:00",
"deviceSerial":"C29895884",
"deviceType":"10254",
"channelNo":"1",
"channelName":"校门口监控点1",
"eventType":"AlarmEvent",
"eventCode":"10203",
"eventDescription":"fielddetection",
"pictureURL":"https://pic.hik-cloud.com/edu/face/001.JPG",
"detailInfo":{
"mask":"yes",
"temperatureList":["36.50"],
"personId":"5c063628b8894d44dcad133e",
"personNo":"16842567",
"personName":"张三",
"personType":1,
"organization":"语文组",
"checkType":"1",
"healthCode":"0"
},
"eventRemark":"",
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
状态事件消息
education_event_state消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventId | 事件ID | String | 64 | 是 | |
dateTime | 事件时间(UTC+08:00) | String | 25 | 是 | |
deviceSerial | 设备序列号 | String | 9 | 是 | |
deviceType | 设备类型 | String | 16 | 否 | [10250]门禁设备[10252]电子班牌[10256]热成像设备 |
channelNo | 设备监控点号 | String | 16 | 否 | |
channelName | 设备监控点名称 | String | 128 | 是 | |
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
eventDescription | 事件描述 | String | 255 | 否 | |
eventComment | 备注 | String | 128 | 否 | |
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
消息示例:
{
"eventId":"5c063628b8894d44dcad133e",
"dateTime":"2018-05-21T12:06:00+08:00",
"deviceSerial":"C29895884",
"deviceType":"10250",
"channelNo":"1",
"channelName":"校门口监控点1",
"eventType":"StateEvent",
"eventCode":"10301",
"eventDescription":"ONLINE",
"eventComment":"",
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
班级事件消息
education_message_class消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
classData | 班级信息 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
classData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
classId | 班级ID | String | 32 | 是 | |
studyLevel | 所属学段 | Integer | 是 | [0]幼儿园[1]小学[2]初中[3]高中[4]其他 | |
gradeIndex | 所属年级 | Integer | 是 | [1]一年级[2]二年级[3]三年级[4]四年级[5]五年级[6]六年级[7]七年级[8]八年级[9]九年级[10]十年级 | |
className | 班级名称 | String | 20 | 是 | |
classCode | 班级编号 | String | 20 | 是 | |
adviserId | 班主任ID | String | 32 | 否 | |
monitorId | 班长ID | String | 32 | 是 | |
classAlias | 班级别名 | String | 15 | 是 | |
classSlogan | 班级口号 | String | 32 | 否 | |
comment | 备注 | String | 64 | 否 | |
unionId | 关联ID | String | 64 | 否 |
消息示例:
{
"eventType":"ResourceEvent",
"eventCode":"10001",
"classData":
{
"classId":"6514484bc11397508cab7870c633216b",
"studyLevel":1,
"gradeIndex":1,
"className":"5(3)班",
"classCode":"503",
"adviserId":"fd8fe4f53fa449c4b9e640956030478b",
"monitorId":"c242a6d58bb4485e99cd5c3e8c1cc570",
"classAlias":"班级别名",
"classSlogan":"班级口号",
"comment":"备注信息",
"unionId":"6514484bc11397508cab7870c633216b"
},
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
部门事件消息
education_message_department消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
classData | 部门信息 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
departmentData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
departmentId | 部门ID | String | 32 | 是 | |
departmentName | 部门名称 | String | 20 | 是 | |
departmentCode | 部门编号 | String | 20 | 否 | |
parentId | 部门所属父节点ID | String | 32 | 是 | |
comment | 备注 | String | 64 | 否 | |
unionId | 关联ID | String | 64 | 否 |
消息示例:
{
"eventType":"ResourceEvent",
"eventCode":"10004",
"departmentData":
{
"departmentId":"6514484bc11397508cab7870c633216b",
"departmentName":"数据组",
"departmentCode":"503",
"parentId":"fd8fe4f53fa449c4b9e640956030478b",
"comment":"备注信息",
"unionId":"6514484bc11397508cab7870c633216b"
},
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
学生事件消息
education_message_student消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
studentData | 学生信息 | List | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
studentData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
studentId | 学生ID | String | 32 | 是 | |
studentName | 学生姓名 | String | 20 | 是 | |
studentNumber | 学号 | String | 20 | 是 | |
studentType | 学生类型 | Integer | 是 | [0]走读生[1]住校生 | |
studentSex | 性别 | Integer | 是 | [1]男[2]女 | |
classId | 所属班级ID | String | 32 | 是 | |
card | 学生卡信息 | String | 255 | 否 | 最多支持5张卡, 以逗号分隔 |
certificateType | 证件类型 | Integer | 否 | [1]身份证 | |
certificateNumber | 证件号码 | String | 20 | 否 | |
birthDate | 出生日期 | String | 32 | 否 | |
entryDate | 入学日期 | String | 32 | 否 | |
graduateDate | 毕业日期 | String | 32 | 否 | |
phoneNumber | 手机号 | String | 11 | 否 | |
nation | 民族 | String | 8 | 否 | |
personNative | 籍贯 | String | 32 | 否 | |
address | 居住地 | String | 64 | 否 | |
comment | 备注 | String | 64 | 否 | |
unionId | 关联ID | String | 64 | 否 |
消息示例:
{
"eventType":"ResourceEvent",
"eventCode":"10007",
"studentData":
[{
"studentId":"6514484bc11397508cab7870c633216b",
"studentName":"张三",
"studentNumber":"14484",
"studentType":1,
"studentSex":1,
"classId":"fd8fe4f53fa449c4b9e640956030478b",
"card":"14484,14485",
"certificateType":1,
"certificateNumber":"125324200001013615",
"birthDate":"2000-01-01",
"entryDate":"2010-01-01",
"graduateDate":"2016-01-01",
"phoneNumber":"15246235245",
"nation":"汉",
"personNative":"北京",
"address":"北京",
"comment":"备注信息",
"unionId":"6514484bc11397508cab7870c633216b"
}],
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
教职工事件消息
education_message_staff消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
staffData | 教职工信息 | List | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
staffData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
staffId | 教职工ID | String | 32 | 是 | |
staffName | 教职工姓名 | String | 20 | 是 | |
staffNumber | 工号 | String | 20 | 是 | |
staffSex | 性别 | Integer | 是 | [1]男[2]女 | |
departmentId | 所属部门ID | String | 32 | 是 | |
card | 教职工卡信息 | String | 255 | 否 | 最多支持5张卡, 以逗号分隔 |
certificateType | 证件类型 | Integer | 否 | [1]身份证 | |
certificateNumber | 证件号码 | String | 20 | 否 | |
birthDate | 出生日期 | String | 32 | 否 | |
entryDate | 入职日期 | String | 32 | 否 | |
positionName | 职位名称 | String | 32 | 否 | |
phoneNumber | 手机号 | String | 11 | 否 | |
nation | 民族 | String | 8 | 否 | |
personNative | 籍贯 | String | 32 | 否 | |
address | 居住地 | String | 64 | 否 | |
comment | 备注 | String | 64 | 否 | |
unionId | 关联ID | String | 64 | 否 |
消息示例:
{
"eventType":"ResourceEvent",
"eventCode":"10010",
"staffData":
[{
"staffId":"6514484bc11397508cab7870c633216b",
"staffName":"张三",
"staffNumber":"14484",
"staffSex":1,
"departmentId":"fd8fe4f53fa449c4b9e640956030478b",
"card":"14484,14485",
"certificateType":1,
"certificateNumber":"125324200001013615",
"birthDate":"2000-01-01",
"entryDate":"2019-01-01",
"positionName":"主任",
"phoneNumber":"15246235245",
"nation":"汉",
"personNative":"北京",
"address":"北京",
"comment":"备注信息",
"unionId":"6514484bc11397508cab7870c633216b"
}],
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
家长事件消息
education_message_parent消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
parentData | 家长信息 | List | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
parentData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
parentId | 家长ID | String | 32 | 是 | |
parentName | 家长姓名 | String | 30 | 是 | |
parentType | 家长类型 | Integer | 是 | [1]爸爸 [2]妈妈 [3]爷爷 [4]奶奶 [5]外公 [6]外婆 [7]其他亲属 | |
studentId | 所属学生ID | String | 32 | 是 | |
phoneNumber | 手机号 | String | 11 | 否 | |
comment | 备注 | String | 64 | 否 | |
unionId | 关联ID | String | 64 | 否 |
消息示例:
{
"eventType":"ResourceEvent",
"eventCode":"10013",
"parentData":
[{
"parentId":"6514484bc11397508cab7870c633216b",
"parentName":"张三",
"parentType":1,
"studentId":"fd8fe4f53fa449c4b9e640956030478b",
"phoneNumber":"13358745129",
"comment":"备注信息",
"unionId":"6514484bc11397508cab7870c633216b"
}],
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
门禁权限下发状态消息
education_message_access_state消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
accessStateData | 门禁权限下发状态 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
accessStateData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
operateId | 操作ID | String | 32 | 否 | |
personId | 人员ID | String | 32 | 是 | |
personName | 人员姓名 | String | 30 | 是 | |
personType | 人员类型 | Integer | 是 | [1]教职工 [2]学生 [3]家长 | |
deviceId | 设备ID | String | 32 | 是 | |
deviceName | 设备名称 | String | 32 | 是 | |
accessState | 下发状态 | String | 8 | 是 | [SUCCESS]成功[FAILED] 失败 |
stateDescription | 状态描述 | String | 32 | 否 | |
issuedTime | 下发时间(UTC+08:00) | String | 25 | 是 |
消息示例:
{
"eventType":"ResourceEvent",
"eventCode":"10016",
"accessStateData":{
"personId":"11d01df7b6cb45078486d28592d26618",
"personName":"张三",
"personType":1,
"deviceId":"1053359bc54648799daa0fb6f40f3e78",
"deviceName":"门禁设备",
"accessState":"FAILED",
"accessDescription":"设备不在线",
"issuedTime":"2019-07-21T12:30:27+08:00"
},
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
班牌留言事件消息
education_class_brand_leave_message消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
leaveMessageData | 留言事件详情 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
leaveMessageData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
dateTime | 留言时间(UTC+08:00) | String | 25 | 是 | |
timestamp | 时间戳 | Long | 是 | ||
studentId | 学生ID | String | 32 | 是 | |
studentNo | 学号 | String | 20 | 是 | |
studentName | 学生姓名 | String | 30 | 是 | |
dataType | 留言类型 | Integer | 是 | [0]文字 [1]语音 | |
content | 留言内容 | String | 255 | 否 | |
sendPersonType | 发送人员类型 | Integer | 否 | [0]家长 [1]学生 | |
fileUrl | 语音URL | String | 255 | 否 | |
voiceTime | 语音时长(秒) | Integer | 否 | ||
parents | 家长信息 | List | 否 | ||
deviceSerial | 设备序列号 | String | 16 | 是 |
parents字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
parentPhone | 家长手机号 | String | 11 | 否 | |
parentId | 家长ID | String | 32 | 否 | |
parentName | 家长姓名 | String | 30 | 否 |
消息示例:
{
"eventType":"ClassBrandEvent",
"eventCode":"10401",
"leaveMessageData":{
"dateTime":"2020-05-01T12:25:30+08:00",
"timestamp":1,
"studentId":"11d01df7b6cb45078486d28592d26618",
"studentNo":"stu120",
"studentName":"张三",
"dataType":0,
"content":"我知道了",
"fileUrl":"",
"voiceTime":0,
"parents":[{
"parentPhone":"15623512659",
"parentId":"21ddfdf7b6cb45078486d28592d26618",
"parentName":"张爸爸"
}],
"deviceSerial": "D31649430"
},
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
班牌课堂考勤事件消息
education_class_brand_class_attendance_message消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
attendanceMessageData | 课堂考勤事件详情 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
attendanceMessageData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventId | 事件ID | String | 64 | 是 | |
dateTime | 留言时间(UTC+08:00) | String | 25 | 是 | |
timestamp | 时间戳 | Long | 是 | ||
courseSectionId | 本节课ID | String | 32 | 是 | |
personId | 人员ID | String | 32 | 是 | |
personNo | 工号/学号 | String | 20 | 是 | |
personName | 人员姓名 | String | 30 | 是 | |
personType | 人员类型 | Integer | 是 | [1]教职工 [2]学生 | |
certificationType | 认证方式 | String | 8 | 否 | [card]刷卡[face]刷脸 |
cardNo | 卡号 | String | 20 | 否 | |
teacherId | 任课教师ID | String | 32 | 否 | |
teacherName | 任课教师名称 | String | 30 | 否 | |
status | 考勤状态 | String | 30 | 否 | normal:正常, beLate:迟到, leave:请假 |
classId | 班级ID | String | 32 | 否 | |
className | 班级名称 | String | 20 | 否 | |
section | 课节 | String | 20 | 否 | |
startTime | 本节课开始时间 | String | 8 | 否 | |
endTime | 本节课结束时间 | String | 8 | 否 | |
courseId | 课程ID | String | 32 | 否 | |
faceUrl | 人脸URL | String | 255 | 否 |
消息示例:
{
"eventType":"ClassBrandEvent",
"eventCode":"10402",
"attendanceMessageData":{
"eventId":"5c063628b8894d44dcad133e",
"dateTime":"2020-05-01T12:25:30+08:00",
"timestamp":1,
"courseSectionId":"11d01df7b6cb45078486d28592d26618",
"personId":"11d01df7b6cb45078486d28592d26618",
"personNo":"stu120",
"personName":"张三",
"personType":1,
"certificationType":"card",
"cardNo":"",
"teacherId":"21ddfdf7b6cb45078486d28592d26618",
"teacherName":"张老师",
"status":"normal",
"classId":"11d01df7b6cb45078486d28592d26618",
"className":"五二班",
"section":1,
"startTime":"",
"endTime":"",
"courseId":"11d01df7b6cb45078486d28592d26618",
"faceUrl":"https://pic.hik-cloud.com/edu/face/cacb9e77-1f03-407c-93cf-5325ecd70643.JPEG"
},
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
班牌人员认证事件消息
education_class_brand_person_auth_message消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
personAuthMessageData | 人员认证事件详情 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
personAuthMessageData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventId | 事件ID | String | 64 | 是 | |
dateTime | 留言时间(UTC+08:00) | String | 25 | 是 | |
timestamp | 时间戳 | Long | 是 | ||
deviceSerial | 本节课ID | String | 32 | 是 | |
deviceType | 工号/学号 | String | 20 | 是 | |
deviceName | 人员姓名 | String | 30 | 是 | |
personId | 人员ID | String | 32 | 是 | |
personNo | 工号/学号 | String | 20 | 是 | |
personName | 人员姓名 | String | 30 | 是 | |
personType | 人员类型 | Integer | 是 | [1]教职工 [2]学生 | |
certificationType | 认证方式 | String | 8 | 否 | [card]刷卡[face]刷脸 |
cardNo | 卡号 | String | 20 | 否 |
消息示例:
{
"eventType":"ClassBrandEvent",
"eventCode":"10403",
"personAuthMessageData":{
"eventId":"5c063628b8894d44dcad133e",
"dateTime":"2020-05-01T12:25:30+08:00",
"timestamp":1,
"deviceSerial":"178200711",
"deviceType":"10252",
"deviceName":"五三班班牌",
"personId":"11d01df7b6cb45078486d28592d26618",
"personNo":"stu120",
"personName":"张三",
"personType":1,
"certificationType":"card",
"cardNo":""
},
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
对讲事件消息
education_event_intercom消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
intercomMessageData | 对讲事件详情 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
intercomMessageData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventId | 事件ID | String | 64 | 是 | |
dateTime | 留言时间(UTC+08:00) | String | 25 | 是 | |
timestamp | 时间戳 | Long | 是 | ||
deviceSerial | 设备序列号(主叫方) | String | 9 | 是 | |
deviceType | 设备类型 | String | 16 | 否 | |
deviceName | 设备名称 | String | 32 | 否 | |
channelNo | 设备监控点号 | String | 16 | 否 | |
channelName | 设备监控点名称 | String | 128 | 否 | |
intercomState | 对讲状态 | Integer | 否 | [0]未接通[1]接通[2]挂断 | |
eventDescription | 事件描述 | String | 255 | 否 | [card]刷卡[face]刷脸 |
receiver | 被呼叫方 | Object | 否 | ||
roomId | 对讲房间号 | String | 32 | 否 | |
msgBody | 扩展消息 | String | 255 | 否 |
receiver消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
receiverId | 被呼叫方ID | String | 32 | 否 |
消息示例:
{
"eventType":"IntercomEvent",
"eventCode":"10501",
"intercomMessageData":{
"eventId":"5c063628b8894d44dcad133e",
"dateTime":"2020-05-01T12:25:30+08:00",
"timestamp":1,
"deviceSerial":"178200711",
"deviceType":"10252",
"deviceName":"五三班班牌",
"channelNo":"2",
"channelName":"stu120",
"intercomState":1,
"eventDescription":"张三",
"receiver":{
"receiverId":"f38fe4f53fa449c4b9e640956030478b"
},
"roomId":"2",
"msgBody":""
},
"schoolId":"f38fe4f53fa449c4b9e640956030478b",
"tenantId":"f38fe4f53fa449c4b9e640956030478b"
}
班牌数据透传消息
education_class_brand_trans_parent_upload_message消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
transparentDataUpload | 透传数据详情 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
消息示例:
{
"eventType":"ClassBrandEvent",
"eventCode":"10404",
"transparentDataUpload": {
"protocol":"HTTP",
"channelID":1,
"dateTime":"2021-04-20T19:08:19+08:00",
"activePostCount":1,
"eventType":"HEOPFormattedEvent",
"eventState":"active",
"eventDescription":"HEOP Formatted Event",
"serialNumber":"D65334538",
"HEOPFormattedEvent": {
"cmdType":"request",
"srcPersonid":"srcId",
"targetPersonid":"targetId"
}
},
"schoolId":"f3d7d4f709554eb2b17901888bbdbb13",
"tenantId":"a6c19373fb0d421fb1bb726a219c8571"
}
访客事件
education_event_visitor消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 64 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
visitorEventData | 访客事件详情 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
visitorEventData 消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventId | 事件ID | String | 64 | 是 | |
dateTime | 事件时间(UTC+08:00) | String | 25 | 是 | |
timestamp | 时间戳 | Long | 是 | ||
deviceSerial | 设备序列号 | String | 9 | 是 | |
deviceType | 设备类型 | String | 否 | ||
channelNo | 设备监控点号 | String | 16 | 否 | |
channelName | 设备监控点名称 | String | 128 | 否 | |
eventDescription | 事件描述 | String | 255 | 否 | |
pictureURL | 访客人脸照片 | String | 512 | 是 | |
eventComment | 事件备注 | String | 255 | 否 | |
visitorInfo | 访客信息 | Object | 是 |
visitorInfo 消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
visitorId | 访客ID | String | 32 | 是 | |
visitorName | 访客姓名 | String | 32 | 是 | |
visitorType | 预约类型 | Integer | 是 | 0-预约,1-非预约,2-预约随行 | |
visitorSex | 性别 | Integer | 否 | 1-男,2-女 | |
registerStatus | 状态 | Integer | 是 | 0-已登记,1-未登记,2-已签离,3-超期自动签离,4-超期未登记 | |
appointmentVisitTime | 预约到访时间 | String | 25 | 否 | |
appointmentLeaveTime | 预约离开时间 | String | 25 | 否 | |
receptionistName | 接待人名称 | String | 32 | 否 | |
receptionistId | 接待人ID | String | 32 | 否 | |
plateNo | 访客车牌号 | String | 64 | 否 | |
company | 访客公司 | String | 64 | 否 | |
belongings | 携带物品 | String | 255 | 否 | |
thermometryUnit | 温度单位 | String | 32 | 否 | celsius-摄氏度(默认),fahrenheit-华氏度,kelvin-开尔文 |
currTemperature | 访客体温 | String | 16 | 否 | 精确到小数点后一位 |
消息示例:
{
"eventType": "VisitorEvent",
"eventCode": "10601",
"visitorEventData": {
"eventId": "20210401E15186268_22f41d4707a94ae9b6ec8669331288f2_1619077555000",
"dateTime": "2021-02-20T15:46:16+08:00",
"timestamp": 1619077076000,
"deviceSerial": "E62533254",
"deviceType": "10250",
"channelNo": "2",
"eventDescription": "访客人证消息",
"pictureURL": "https://open.ys7.com/api/lapp/mq/downloadurl?appKey=787905cc336e49ff68b01efe4ea70150&fileKey=ISAPI_FILES/E62533254/20210220152258076-E62533254-2-12200$encrypt=2,2021-02-22T15:46:18,0e54f3b85e04d553c470da1c66238429",
"visitorInfo": {
"visitorId": "336623198999155348",
"visitorName": "张三",
"visitorType": 1,
"visitorSex": 2,
"registerStatus": 1,
"thermometryUnit": "celsius",
"currTemperature": "36.4"
}
},
"schoolId": "d9d74c57a4004b55555f66a266d3d0b0",
"tenantId": "d9d74c57a4004b55555f66a266d3d0b0"
}
请假事件消息
education_message_leave消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
leaveData | 请假事件详情 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
leaveData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
leaveId | 请假ID | String | 32 | 是 | |
personId | 人员ID | String | 32 | 是 | |
personName | 人员姓名 | String | 30 | 是 | |
personNo | 工号/学号 | String | 20 | 是 | |
personType | 人员类型 | Integer | 是 | [1]教职工 [2]学生 | |
startTime | 请假开始时间(UTC+08:00) | String | 25 | 是 | |
endTime | 请假结束时间(UTC+08:00) | String | 25 | 是 | |
leaveType | 请假类型 | Integer | 是 | 0:病假 1:事假 2:其他 | |
leaveReason | 请假原因 | String | 255 | 是 |
消息示例:
{
"eventType": "ResourceEvent",
"eventCode": "10021",
"leaveData": {
"leaveId": "b0d9c93331f3441fb222860c78cf64ac",
"personId": "96d870198a2d4d755558b8d6d5a88e26",
"personName": "小孟",
"personNo": "221082",
"personType": 1,
"startTime": "2021-05-25T14:50:00+08:00",
"endTime": "2021-05-25T20:50:59+08:00",
"leaveType": 0,
"leaveReason": "病假"
},
"schoolId": "af5c03fc34d11234567800136a415aa0",
"tenantId": "af5c03fc34d11234567800136a415aa0"
}
校园考勤消息
education_school_attendance_message消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
schoolAttendanceData | 校园考勤消息详情 | Object | 是 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
schoolAttendanceData字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
attendanceRecordId | 校园考勤消息ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 是 | |
dateTime | 考勤日期 | String | 10 | 是 | |
personnelId | 人员ID | String | 32 | 是 | |
peopleType | 人员类型 | Intgeger | 是 | 0:学生 1:老师 | |
personnelName | 人员姓名 | String | 30 | 是 | |
personnelNo | 学号/工号 | String | 20 | 是 | |
departmentId | 班级/部门ID | String | 32 | 是 | |
departmentName | 班级/部门名称 | String | 50 | 是 | |
pictureUrl | 考勤人脸 | String | 255 | 是 | |
facePicUrl | 平台上传的人脸 | String | 255 | 是 | |
eventTime | 打卡时间 | String | 19 | 是 | |
globalStatus | 综合考勤状态 | Intgeger | 是 | 0:正常,1:迟到,2:早退,3:请假,4:缺勤,5:异常 | |
timeIntervaGroupId | 时段组ID | String | 32 | 是 | |
timeIntervaGroupName | 时段组名称 | String | 50 | 是 | |
timeIntervalNameId | 时段ID | String | 32 | 是 | |
timeIntervalName | 时段名称 | String | 50 | 是 | |
signStatus | 时段考勤状态 | Intgeger | 是 | 0:正常,1:迟到,2:早退,3:请假,4:缺勤,5:异常 | |
signInStatus | 时段签到状态 | Intgeger | 是 | 0:正常,1:迟到,2:早退,3:请假,4:缺勤,5:异常 | |
signOutStatus | 时段签退状态 | Intgeger | 是 | 0:正常,1:迟到,2:早退,3:请假,4:缺勤,5:异常 | |
signinTime | 时段签到应打卡时间 | String | 19 | 是 | |
signinClockinTime | 时段签到实际打卡时间 | String | 19 | 是 | |
signoutTime | 时段签退应打卡时间 | String | 19 | 是 | |
signoutClockinTime | 时段签退实际打卡时间 | String | 19 | 是 | |
earliestSigninTime | 时段签到最早打卡时间 | String | 19 | 是 | |
latestSigninTime | 时段签到最晚打卡时间 | String | 19 | 是 | |
earliestSignoutTime | 时段签退最早打卡时间 | String | 19 | 是 | |
latestSignoutTime | 时段签退最晚打卡时间 | String | 19 | 是 | |
signinClockinDevice | 签到打卡点位 | String | 100 | 是 | |
signoutClockinDevice | 签退打卡点位 | String | 100 | 是 |
消息示例:
{
"eventType": "ClassBrandEvent",
"eventCode": "10405",
"schoolAttendanceData": {
"attendanceRecordId": "0e2ee7b0132eee39de7618b1a454ce5",
"tenantId": "e55522222c6148c755555ad0e828ba0a",
"dateTime": "2021-09-24",
"personnelId": "5b425d412345444dae24436e59d8034a",
"peopleType": 0,
"personnelName": "王五",
"personnelNo": "1111",
"departmentId": "441631594560461ab2fe720531d01dd9",
"departmentName": "俏脸扮看",
"pictureUrl": "https://pbpic.hik-cloud.com/minerva/classbrand/2021/9/23/e51596111161445680384ad0e828ba0a/D66036666/202109241478440338.jpg",
"facePicUrl": "https://pbpic.hik-cloud.com/minerva/face/repository/0/e51596111161445680384ad0e828ba0a/161427540/face13d0e49e82314baca2b887f75609.jpg",
"eventTime": "2021-09-24 18:14:00",
"globalStatus": 4,
"timeIntervaGroupId": "f9c95c333c704d858e924702168c7a58",
"timeIntervaGroupName": "花飘万家雪时段组",
"timeIntervalNameId": "57711d7ae9e24232332a6ce58b336f2b",
"timeIntervalName": "花飘万家雪时段2",
"signStatus": 4,
"signInStatus": 4,
"signOutStatus": 2,
"signinTime": "2021-09-24 14:00:00",
"signoutTime": "2021-09-24 19:00:00",
"signoutClockinTime": "2021-09-24 18:14:00",
"earliestSigninTime": "2021-09-24 13:00:00",
"latestSigninTime": "2021-09-24 15:00:00",
"earliestSignoutTime": "2021-09-24 18:00:00",
"latestSignoutTime": "2021-09-24 22:00:00",
"signoutClockinDevice": "D66036666-3sPuY6"
},
"schoolId": "e51596111161445680384ad0e828ba0a",
"tenantId": "e51596111161445680384ad0e828ba0a"
}
学生体检数据消息
education_event_physical_exam消息格式:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
eventId | 事件ID | String | 64 | 是 | |
dateTime | 事件时间(UTC+08:00) | String | 25 | 是 | |
deviceSerial | 设备序列号 | String | 16 | 是 | |
deviceType | 设备类型 | String | 16 | 否 | [10250]门禁设备[10252]电子班牌[10256]热成像设备 |
deviceName | 设备名称 | String | 64 | 否 | |
channelNo | 设备监控点号 | String | 16 | 否 | |
channelName | 设备监控点名称 | String | 128 | 是 | |
eventType | 事件类型 | String | 32 | 是 | 详见事件类型对照表 |
eventCode | 事件码 | String | 8 | 是 | 详见事件码对照表 |
eventDescription | 事件描述 | String | 255 | 否 | |
detailInfo | 学生体检数据消息详情 | Object | 否 | ||
schoolId | 学校ID | String | 32 | 是 | |
tenantId | 租户ID | String | 32 | 否 |
detailInfo 字段说明:
字段名 | 描述 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
personId | 人员ID | String | 32 | 是 | |
personNo | 人员工号/学号 | String | 20 | 是 | |
personName | 人员名称 | String | 30 | 是 | |
personType | 人员类型 | Integer | 是 | [0]未知[1]教职工[2]学生[3]家长 | |
organization | 所属组织/班级 | String | 64 | 否 | |
pictureURL | 人脸url | String | 255 | 否 | |
weight | 体重 | double | 否 | ||
height | 身高 | double | 否 | ||
bmi | 身体质量指数 | double | 否 | ||
bodyfat | 体脂率 | double | 否 | ||
water | 体水分 | double | 否 | ||
muscle | 骨骼肌 | double | 否 | ||
musclem | 肌肉量 | double | 否 | ||
bone | 骨量 | double | 否 | ||
lbm | 去脂体重 | double | 否 | ||
protein | 蛋白质 | double | 否 | ||
subfat | 皮下脂肪 | double | 否 | ||
visfat | 内脏等级 | double | 否 | ||
bodyAge | 体年龄 | double | 否 | ||
bodyShape | 体型 | double | 否 | ||
bmr | 基础代谢 | double | 否 | ||
Score | 身体评分 | double | 否 |
消息示例:
{
"eventId":"544befdec0264c84bea1ba0f26b6ddb3",
"dateTime":"2021-12-20 14:05:32",
"deviceSerial":"D37722406",
"channelNo":"",
"channelName":"",
"eventType":"AccessEvent",
"eventCode":"10116",
"eventDescription":"学生体检数据消息",
"detailInfo":{
"personId":"230334e958074d2f9916135c37bc9378",
"personNo":"72201171401122715612",
"personName":"冯天天",
"personType":"2",
"organization":"课堂考勤&校园考勤班级",
"pictureURL":"https://open.ys7.com/api/lapp/mq/downloadurl?appKey=787905cc702249ff92201ef222a70150&fileKey=ISAPI_FILES/D37722406/20211223140421093-D37722406-2-10000-2$encrypt=2,2021-12-23T14:05:32,5189b40731932095c586a4e49e7aa87f",
"weight":5700,
"height":17000,
"bmi":19.3,
"bodyfat":20.7,
"water":56.9,
"muscle":50.7,
"musclem":48.56,
"bone":2.57,
"lbm":45.56,
"protein":17.6,
"subfat":50.2,
"visfat":8.8,
"bodyAge":27,
"bodyShape":4,
"bmr":1390,
"Score":99
},
"schoolId":"b74b10d5fcc54eb6ab9c8e873333336e",
"tenantId":"2b9006ccb50e49a19aaedf411111c1ab",
"deviceType":"10250",
"deviceName":"D37722406"
}
事件类型对照表
消息码 | 消息描述 |
---|---|
AccessEvent | 门禁事件 |
AlarmEvent | 报警事件 |
StateEvent | 状态事件 |
ResourceEvent | 资料变更事件 |
ClassBrandEvent | 班牌事件 |
IntercomEvent | 对讲事件 |
VisitorEvent | 访客事件 |
事件码对照表
100开头的为资料事件码,101开头的为门禁事件码,102开头的为报警事件码,103开头的为状态事件码,104开头的为班牌事件码,105开头的为对讲事件码,106开头的为访客事件码
消息码 | 消息描述 |
---|---|
10001 | 班级新增 |
10002 | 班级修改 |
10003 | 班级删除 |
10004 | 部门新增 |
10005 | 部门修改 |
10006 | 部门删除 |
10007 | 学生新增 |
10008 | 学生修改 |
10009 | 学生删除 |
10010 | 教职工新增 |
10011 | 教职工修改 |
10012 | 教职工删除 |
10013 | 家长新增 |
10014 | 家长修改 |
10015 | 家长删除 |
10016 | 门禁人脸权限下发 |
10017 | 门禁卡片权限下发 |
10021 | 请假新增消息 |
10022 | 请假修改消息 |
10023 | 请假删除消息 |
10101 | 刷卡开门 |
10104 | 二维码开门 |
10109 | 组合认证人脸加刷卡开锁 |
10114 | 人脸开门 |
10115 | 刷卡抓图 |
10116 | 学生体检数据消息 |
10202 | 黑名单报警 |
10203 | 区域入侵报警 |
10204 | 越界侦测报警 |
10212 | 人员密度报警 |
10213 | 温湿度报警 |
10214 | 陌生人报警 |
10215 | 人脸抓拍报警 |
10216 | 一键报警 |
10217 | 人脸比对报警 |
10218 | 重点人员报警 |
10219 | 体温异常报警 |
10220 | 体温检测消息 |
10224 | 健康码报警 |
10301 | 设备上线状态事件 |
10302 | 设备离线状态事件 |
10401 | 留言消息 |
10402 | 课堂考勤消息 |
10403 | 人员认证消息 |
10404 | 班牌数据透传消息 |
10405 | 校园考勤消息 |
10501 | 班牌对讲事件 |
10601 | 访客人证消息 |