海康云眸·普教 API
  1. 消息类型定义
海康云眸·普教 API
  • 产品介绍
  • 能力概览
  • 错误码表
  • 快速入门
    • 接口调用说明
    • 生成授权凭证档
    • 生成access_token
      POST
  • 开发指南
    • 消息通道
    • 接口说明
      • 请求数据
      • 认证管理
  • API列表
    • 基础服务
      • 学校管理
        • 查询学校(教育局)信息
        • 查询教育局下的学校信息
        • 第三方公众号token更新
      • 班级管理
        • 新增班级
        • 修改班级
        • 删除班级
        • 查询班级信息
        • 班级毕业
        • 班级升级
      • 部门管理
        • 新增部门
        • 删除部门
        • 修改部门
        • 查询部门信息
      • 教职工管理
        • 新增教职工
        • 删除教职工
        • 修改教职工
        • 查询教职工信息
        • 教职工部门调整
      • 学生管理
        • 新增学生
        • 删除学生
        • 修改学生
        • 查询学生信息
        • 学生调班
        • 通过学号获取学生信息
        • 添加教学班学生
        • 删除教学班学生
        • 查询教学班学生信息
      • 家长管理
        • 新增家长
        • 删除家长
        • 修改家长
        • 查询家长信息
      • 设备管理
        • 查询所有设备组织
        • 查询设备监控通道
        • 查询家长关联设备信息
        • 查询学校中设备信息
        • 添加设备(非物联设备)
        • 删除设备(非物联设备)
        • 查询学校中指定类型设备数量
        • 远程开门
        • 查询场地空气质量
        • 物联能耗数据查询
        • 物联设备控制接口
      • 设备确权
        • 确权流程说明
        • 自动确权
        • 下线确认
        • 上线确认
      • 场地管理
        • 新增场地
        • 删除场地
        • 修改场地
        • 查询场地信息
        • 场地中新增人员
        • 场地中删除人员
      • 用户管理(旧)
        • 默认角色列表
        • 新增用户
        • 删除用户
        • 修改用户信息
        • 获取登录码
      • 用户管理
        • 默认角色列表
        • 变更说明
        • 新增用户
        • 删除用户
        • 修改用户信息
        • 获取登录码
        • 批量查询UserId
    • 视频接入
      • 获取视频直播地址
      • 获取视频预览地址
      • 局端下属学校取流认证
    • 学生请假管理
      • 新增请假单
      • 删除请假单
      • 查询学生请假信息
    • 教学管理
      • 课表管理
        • 课表数据同步
        • 课表数据同步结果查询
        • 家长读取学生的课表信息
        • 查询行政班或教学班的课表
      • 课程库管理
        • 查询行政班或教学班的班级课程库
        • 查询校本课程库信息
        • 查询校本课程库详细信息
        • 删除班级课程
        • 添加班级课程
        • 修改班级课程
        • 删除校本课程库
        • 添加校本课程库
        • 修改校本课程库
        • 删除校本课程
        • 添加校本课程
        • 修改校本课程
      • 查询学期信息
    • 门禁权限管理
      • 门禁权限下发
    • 电子班级
      • 班级管理
        • 人脸识别参数配置
        • 获取资源类发布内容
        • 获取相册类发布内容
        • 获取视频类发布内容
        • 发布资源类内容(班级公告、校园宣传、紧急通知、校园新闻、校园公告、学习资料)
        • 发布相册类内容(班级相册、校园相册)
        • 发布视频类内容(班级视频、校园视频)
        • 发布考试计划
        • 撤销发布内容
        • 发布班级值日信息
        • 发布倒计时(班级倒计时、校园倒计时)
        • 添加班级值日项信息
        • 查询值日项信息
        • 修改班级值日项信息
        • 删除班级值日项信息
      • 留言管理
        • 新增留言
        • 家长读取学生的留言记录
    • 访客管理
      • 访客预约登记
      • 删除访客预约
    • 第三方跳转(旧)
      • 第三方跳转登录云眸普教对接规范
    • 第三方跳转
      • 第三方跳转登录云眸普教对接规范
    • 消息通道
      • 创建消费者
      • 消费消息
      • 提交偏移量
    • 消息类型定义
      • 消息类型定义
  • 移动端SDK
    • Android
    • IOS
    • 错误码对照表
  1. 消息类型定义

消息类型定义

消息类型描述
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事件IDString64是
dateTime事件时间(UTC+08:00)String25是
deviceSerial设备序列号String9是
deviceType设备类型String16否[10250]门禁设备[10252]电子班牌[10256]热成像设备
channelNo设备监控点号String16否
channelName设备监控点名称String128是
eventType事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
eventDescription事件描述String255否
pictureURL图片URLString255否
detailInfo事件详情Object否
eventComment备注String128否
schoolId学校IDString32是
tenantId租户IDString32否

detailInfo字段说明:

字段名描述类型长度是否必填备注
personId人员IDString32是
personNo人员工号/学号String20是
personName人员名称String30是
personType人员类型Integer是[0]未知[1]教职工[2]学生[3]家长
cardNo卡号String20否
outInType出入类型Integer否[-1]未知[0]入门[1]出门
bodyTemperature体温String8否例如:“36.50”表示体温为36.50摄氏度
healthCode健康码String8否[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事件IDString64是
dateTime事件时间(UTC+08:00)String25是
deviceSerial设备序列号String9是
deviceType设备类型String16否[10250]门禁设备[10252]电子班牌[10256]热成像设备
channelNo设备监控点号String16否
channelName设备监控点名称String128是
eventType事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
eventDescription事件描述String255否
pictureURL图片URLString255否
detailInfo事件详情Object否
eventRemark备注String128否
schoolId学校IDString32是
tenantId租户IDString32否

detailInfo字段说明:

字段名描述类型长度是否必填备注
mask是否佩戴口罩String8否
temperatureList体温信息List否
personId人员IDString32否
personNo人员工号/学号String20否
personName人员名称String30否
personType人员类型Integer否[0]未知[1]教职工[2]学生[3]家长
organization所属组织/班级String64否
checkType检测类型String8否[0]手动[1]自动
healthCode健康码String8否[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事件IDString64是
dateTime事件时间(UTC+08:00)String25是
deviceSerial设备序列号String9是
deviceType设备类型String16否[10250]门禁设备[10252]电子班牌[10256]热成像设备
channelNo设备监控点号String16否
channelName设备监控点名称String128是
eventType事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
eventDescription事件描述String255否
eventComment备注String128否
schoolId学校IDString32是
tenantId租户IDString32否

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
classData班级信息Object是
schoolId学校IDString32是
tenantId租户IDString32否

classData字段说明:

字段名描述类型长度是否必填备注
classId班级IDString32是
studyLevel所属学段Integer是[0]幼儿园[1]小学[2]初中[3]高中[4]其他
gradeIndex所属年级Integer是[1]一年级[2]二年级[3]三年级[4]四年级[5]五年级[6]六年级[7]七年级[8]八年级[9]九年级[10]十年级
className班级名称String20是
classCode班级编号String20是
adviserId班主任IDString32否
monitorId班长IDString32是
classAlias班级别名String15是
classSlogan班级口号String32否
comment备注String64否
unionId关联IDString64否

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
classData部门信息Object是
schoolId学校IDString32是
tenantId租户IDString32否

departmentData字段说明:

字段名描述类型长度是否必填备注
departmentId部门IDString32是
departmentName部门名称String20是
departmentCode部门编号String20否
parentId部门所属父节点IDString32是
comment备注String64否
unionId关联IDString64否

消息示例:

         {
             "eventType":"ResourceEvent",
             "eventCode":"10004",
             "departmentData":
             {
                 "departmentId":"6514484bc11397508cab7870c633216b",
                 "departmentName":"数据组",
                 "departmentCode":"503",
                 "parentId":"fd8fe4f53fa449c4b9e640956030478b",
                 "comment":"备注信息",
                 "unionId":"6514484bc11397508cab7870c633216b"
             },
             "schoolId":"f38fe4f53fa449c4b9e640956030478b",
             "tenantId":"f38fe4f53fa449c4b9e640956030478b"
         }
        

学生事件消息

education_message_student消息格式:

字段名描述类型长度是否必填备注
eventType事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
studentData学生信息List是
schoolId学校IDString32是
tenantId租户IDString32否

studentData字段说明:

字段名描述类型长度是否必填备注
studentId学生IDString32是
studentName学生姓名String20是
studentNumber学号String20是
studentType学生类型Integer是[0]走读生[1]住校生
studentSex性别Integer是[1]男[2]女
classId所属班级IDString32是
card学生卡信息String255否最多支持5张卡, 以逗号分隔
certificateType证件类型Integer否[1]身份证
certificateNumber证件号码String20否
birthDate出生日期String32否
entryDate入学日期String32否
graduateDate毕业日期String32否
phoneNumber手机号String11否
nation民族String8否
personNative籍贯String32否
address居住地String64否
comment备注String64否
unionId关联IDString64否

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
staffData教职工信息List是
schoolId学校IDString32是
tenantId租户IDString32否

staffData字段说明:

字段名描述类型长度是否必填备注
staffId教职工IDString32是
staffName教职工姓名String20是
staffNumber工号String20是
staffSex性别Integer是[1]男[2]女
departmentId所属部门IDString32是
card教职工卡信息String255否最多支持5张卡, 以逗号分隔
certificateType证件类型Integer否[1]身份证
certificateNumber证件号码String20否
birthDate出生日期String32否
entryDate入职日期String32否
positionName职位名称String32否
phoneNumber手机号String11否
nation民族String8否
personNative籍贯String32否
address居住地String64否
comment备注String64否
unionId关联IDString64否

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
parentData家长信息List是
schoolId学校IDString32是
tenantId租户IDString32否

parentData字段说明:

字段名描述类型长度是否必填备注
parentId家长IDString32是
parentName家长姓名String30是
parentType家长类型Integer是[1]爸爸 [2]妈妈 [3]爷爷 [4]奶奶 [5]外公 [6]外婆 [7]其他亲属
studentId所属学生IDString32是
phoneNumber手机号String11否
comment备注String64否
unionId关联IDString64否

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
accessStateData门禁权限下发状态Object是
schoolId学校IDString32是
tenantId租户IDString32否

accessStateData字段说明:

字段名描述类型长度是否必填备注
operateId操作IDString32否
personId人员IDString32是
personName人员姓名String30是
personType人员类型Integer是[1]教职工 [2]学生 [3]家长
deviceId设备IDString32是
deviceName设备名称String32是
accessState下发状态String8是[SUCCESS]成功[FAILED] 失败
stateDescription状态描述String32否
issuedTime下发时间(UTC+08:00)String25是

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
leaveMessageData留言事件详情Object是
schoolId学校IDString32是
tenantId租户IDString32否

leaveMessageData字段说明:

字段名描述类型长度是否必填备注
dateTime留言时间(UTC+08:00)String25是
timestamp时间戳Long是
studentId学生IDString32是
studentNo学号String20是
studentName学生姓名String30是
dataType留言类型Integer是[0]文字 [1]语音
content留言内容String255否
sendPersonType发送人员类型Integer否[0]家长 [1]学生
fileUrl语音URLString255否
voiceTime语音时长(秒)Integer否
parents家长信息List否
deviceSerial设备序列号String16是

parents字段说明:

字段名描述类型长度是否必填备注
parentPhone家长手机号String11否
parentId家长IDString32否
parentName家长姓名String30否

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
attendanceMessageData课堂考勤事件详情Object是
schoolId学校IDString32是
tenantId租户IDString32否

attendanceMessageData字段说明:

字段名描述类型长度是否必填备注
eventId事件IDString64是
dateTime留言时间(UTC+08:00)String25是
timestamp时间戳Long是
courseSectionId本节课IDString32是
personId人员IDString32是
personNo工号/学号String20是
personName人员姓名String30是
personType人员类型Integer是[1]教职工 [2]学生
certificationType认证方式String8否[card]刷卡[face]刷脸
cardNo卡号String20否
teacherId任课教师IDString32否
teacherName任课教师名称String30否
status考勤状态String30否normal:正常, beLate:迟到, leave:请假
classId班级IDString32否
className班级名称String20否
section课节String20否
startTime本节课开始时间String8否
endTime本节课结束时间String8否
courseId课程IDString32否
faceUrl人脸URLString255否

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
personAuthMessageData人员认证事件详情Object是
schoolId学校IDString32是
tenantId租户IDString32否

personAuthMessageData字段说明:

字段名描述类型长度是否必填备注
eventId事件IDString64是
dateTime留言时间(UTC+08:00)String25是
timestamp时间戳Long是
deviceSerial本节课IDString32是
deviceType工号/学号String20是
deviceName人员姓名String30是
personId人员IDString32是
personNo工号/学号String20是
personName人员姓名String30是
personType人员类型Integer是[1]教职工 [2]学生
certificationType认证方式String8否[card]刷卡[face]刷脸
cardNo卡号String20否

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
intercomMessageData对讲事件详情Object是
schoolId学校IDString32是
tenantId租户IDString32否

intercomMessageData字段说明:

字段名描述类型长度是否必填备注
eventId事件IDString64是
dateTime留言时间(UTC+08:00)String25是
timestamp时间戳Long是
deviceSerial设备序列号(主叫方)String9是
deviceType设备类型String16否
deviceName设备名称String32否
channelNo设备监控点号String16否
channelName设备监控点名称String128否
intercomState对讲状态Integer否[0]未接通[1]接通[2]挂断
eventDescription事件描述String255否[card]刷卡[face]刷脸
receiver被呼叫方Object否
roomId对讲房间号String32否
msgBody扩展消息String255否

receiver消息格式:

字段名描述类型长度是否必填备注
receiverId被呼叫方IDString32否

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
transparentDataUpload透传数据详情Object是
schoolId学校IDString32是
tenantId租户IDString32否

消息示例:

         {
             "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事件类型String64是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
visitorEventData访客事件详情Object是
schoolId学校IDString32是
tenantId租户IDString32否

visitorEventData 消息格式:

字段名描述类型长度是否必填备注
eventId事件IDString64是
dateTime事件时间(UTC+08:00)String25是
timestamp时间戳Long是
deviceSerial设备序列号String9是
deviceType设备类型String否
channelNo设备监控点号String16否
channelName设备监控点名称String128否
eventDescription事件描述String255否
pictureURL访客人脸照片String512是
eventComment事件备注String255否
visitorInfo访客信息Object是

visitorInfo 消息格式:

字段名描述类型长度是否必填备注
visitorId访客IDString32是
visitorName访客姓名String32是
visitorType预约类型Integer是0-预约,1-非预约,2-预约随行
visitorSex性别Integer否1-男,2-女
registerStatus状态Integer是0-已登记,1-未登记,2-已签离,3-超期自动签离,4-超期未登记
appointmentVisitTime预约到访时间String25否
appointmentLeaveTime预约离开时间String25否
receptionistName接待人名称String32否
receptionistId接待人IDString32否
plateNo访客车牌号String64否
company访客公司String64否
belongings携带物品String255否
thermometryUnit温度单位String32否celsius-摄氏度(默认),fahrenheit-华氏度,kelvin-开尔文
currTemperature访客体温String16否精确到小数点后一位

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
leaveData请假事件详情Object是
schoolId学校IDString32是
tenantId租户IDString32否

leaveData字段说明:

字段名描述类型长度是否必填备注
leaveId请假IDString32是
personId人员IDString32是
personName人员姓名String30是
personNo工号/学号String20是
personType人员类型Integer是[1]教职工 [2]学生
startTime请假开始时间(UTC+08:00)String25是
endTime请假结束时间(UTC+08:00)String25是
leaveType请假类型Integer是0:病假 1:事假 2:其他
leaveReason请假原因String255是

消息示例:

         {
             "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事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
schoolAttendanceData校园考勤消息详情Object是
schoolId学校IDString32是
tenantId租户IDString32否

schoolAttendanceData字段说明:

字段名描述类型长度是否必填备注
attendanceRecordId校园考勤消息IDString32是
tenantId租户IDString32是
dateTime考勤日期String10是
personnelId人员IDString32是
peopleType人员类型Intgeger是0:学生 1:老师
personnelName人员姓名String30是
personnelNo学号/工号String20是
departmentId班级/部门IDString32是
departmentName班级/部门名称String50是
pictureUrl考勤人脸String255是
facePicUrl平台上传的人脸String255是
eventTime打卡时间String19是
globalStatus综合考勤状态Intgeger是0:正常,1:迟到,2:早退,3:请假,4:缺勤,5:异常
timeIntervaGroupId时段组IDString32是
timeIntervaGroupName时段组名称String50是
timeIntervalNameId时段IDString32是
timeIntervalName时段名称String50是
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时段签到应打卡时间String19是
signinClockinTime时段签到实际打卡时间String19是
signoutTime时段签退应打卡时间String19是
signoutClockinTime时段签退实际打卡时间String19是
earliestSigninTime时段签到最早打卡时间String19是
latestSigninTime时段签到最晚打卡时间String19是
earliestSignoutTime时段签退最早打卡时间String19是
latestSignoutTime时段签退最晚打卡时间String19是
signinClockinDevice签到打卡点位String100是
signoutClockinDevice签退打卡点位String100是

消息示例:

         {
             "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事件IDString64是
dateTime事件时间(UTC+08:00)String25是
deviceSerial设备序列号String16是
deviceType设备类型String16否[10250]门禁设备[10252]电子班牌[10256]热成像设备
deviceName设备名称String64否
channelNo设备监控点号String16否
channelName设备监控点名称String128是
eventType事件类型String32是详见事件类型对照表
eventCode事件码String8是详见事件码对照表
eventDescription事件描述String255否
detailInfo学生体检数据消息详情Object否
schoolId学校IDString32是
tenantId租户IDString32否

detailInfo 字段说明:

字段名描述类型长度是否必填备注
personId人员IDString32是
personNo人员工号/学号String20是
personName人员名称String30是
personType人员类型Integer是[0]未知[1]教职工[2]学生[3]家长
organization所属组织/班级String64否
pictureURL人脸urlString255否
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访客人证消息

【海康云眸】API开发者 微信交流群

用微信扫右侧二维码,加入【海康云眸】API开发者 交流群,互助沟通

扫码加入交流群
上一页
提交偏移量
下一页
Android
Built with