API开发者文档
  1. 消息推送管理
API开发者文档
  • 变更履历
  • 对接指南
    • 准备工作
  • 基础资源
    • 角色管理
      • 角色查询
      • 角色新增
      • 角色修改
      • 角色删除
      • 功能菜单查询
      • 角色功能菜单授权
    • 部门管理
      • 部门查询
      • 部门新增
      • 部门修改
      • 部门删除
      • 部门查询(根据我方部门编号)
    • 身份管理
      • 身份查询
    • 人员管理
      • 人员新增
      • 人员批量新增
      • 修改人员
      • 根据账号修改人员
      • 删除人员(根据第三方Id)
      • 删除人员(根据工/学号)
      • 人员更换部门
      • 个人信息查询
      • 个人详情查询
      • 个人详情查询(根据身份证号)
      • 人员详情列表查询(根据学校/政企8位编码)
      • 增量人员数据获取(根据人员变动时间)
      • 人员信息列表查询(根据我方班级/部门编号 (不返回uid))
      • 人员信息列表查询(根据第三方班级/部门编号)
      • 授权管理范围
      • 工/学号变更(根据第三方Id)
    • 家长管理
      • 家长查询
      • 家长新增
      • 家长修改
    • 人脸照片
      • 人脸照片更换(根据工/学号)
      • 人脸照片更换(根据第三方Id)
      • 人脸照片(根据第三方Id)
    • 场所区域管理
      • 场所区域查询
    • 一卡通管理
      • 卡挂失/解挂
      • 卡新增
      • 换卡
      • 卡销户
      • 卡通行有效期变更
      • 卡状态查询
    • 个人密码
      • 帐户密码变更
      • 卡密码变更
      • 帐户密码验证
    • 系统字典
      • 根据字典类别获取属性内容接口
    • 生成二维码字符串
      POST
  • 电子班牌
    • 教室管理
      • 教室查询
      • 教室新增
      • 教室修改
      • 教室删除
    • 课程管理
      • 课程修改
      • 课程删除
      • 课程新增
    • 设备管控
      • 重启设备
      • 关闭设备
    • 课表管理
      • 添加学年学期学期
      • 添加教室课表
      • 添加学生课表
      • 删除教室单节课表
      • 删除学生单节课表
      • 删除教室课表
      • 删除学生单节课表/给学生退课
      • 根据第三方教师id获取课程表
      • 根据教师工号获取课程表
      • 根据学生工号获取课程表
      • 根据班级id获取课程表
      • 根据设备编号获取课程表
    • 班级作业管理
      • 获取班级作业列表
      • 添加班级作业
      • 编辑班级作业
      • 删除班级作业
    • 通知管理
      • 获取所有学校通知
      • 添加学校/班级通知
      • 编辑学校/班级通知
      • 删除学校通知
    • 实时播报
      • 添加校园实时播报
      • 编辑校园实时播报
      • 删除校园实时播报
      • 添加班级实时播报
      • 编辑班级实时播报
      • 删除班级实时播报
    • 考勤管理
      • 根据课程id获取上课人员
      • 根据课程id获取本课程学生出勤汇总
      • 根据课程id获取本课程学生出勤明细
      • 课堂实时考勤数据统计分析
      • 课堂实时考勤数据详细
      • 获取电子班牌考勤明细
      • 获取教师授课考勤明细
    • 相册管理
      • 获取所有相册列表
      • 获取相册图片地址
      • 获取全部相册列表及内容
    • 班牌操作
      • 教室,班牌,班级关联绑定
      • 电子班牌远程开门
      • 教室,班牌,班级解绑
      • 电子班牌下载数据
      • 班牌刷新
      • 电子班牌初始化
      • 设备绑定班级教室教师接口
    • 家长留言信息管理
      • 家长留言接口(学生可在电子班牌端查看)
      • 根据日期获取学生给家长的留言信息
    • 设备信息管理
      • 获取班牌设备列表
    • 课程同步管理
      • 多作息课程同步
    • 班主任管理
      • 班主任简介设置
      • 关联班主任
      • 获取班主任和班级的绑定关系
  • 请假管理
    • 获取请假类别列表
    • 个人请假
    • 销假
    • 获取请假列表
    • 获取当前时间某人请假信息
  • 消息推送管理
    • 订阅消息推送报文格式
    • 可订阅消息查询
      GET
    • 消息推送订阅
      GET
    • 取消订阅
      GET
  1. 消息推送管理

订阅消息推送报文格式

#整体说明:第三方按下面格式开发消息接口接收消息报文即可

订阅消息编号:1001#

消息说明:订阅电子班牌设备签到明细
输入报文格式为:
[
    {
        "id": 30500,
        "signDate": "2021-12-24 11:19:15",
        "deviceName": "通行设备名称0511",
        "deviceCode": "通行设备编号0511",
        "iNOut": "进",
        "userId": 第三方人员Id,
        "accountNo": "工/学号123456",
        "personName": "姓名:流星雨",
        "personCardno": "卡号1395221254",
        "temperature": "36.3",
        "photoUrl": "http://192.168.20.12:11108/zhaoyang/uploadFile/Camera/2021-12-24/20211224111915-123456.jpg",
        "dataState": "签到"
    },
    {
        "id": 30501,
        "signDate": "2021-12-24 14:08:20",
        "deviceName": "0511",
        "deviceCode": "0511",
        "iNOut": "进",
        "userId": null,
        "accountNo": "123456",
        "personName": "流星雨",
        "personCardno": "1395221254",
        "temperature": "36.5",
        "photoUrl": "http://192.168.20.12:11108/zhaoyang/uploadFile/Camera/2021-12-24/20211224140820-123456.jpg",
        "dataState": "签到"
    }
] 
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:1002#

消息说明:订阅宿舍设备签到明细
输入报文格式为:
[
    {
        "id": 30391,
        "signDate": "2021-12-13 18:21:49",
        "deviceName": "归寝默认",
        "deviceCode": "1130",
        "iNOut": "进",
        "userId": null,
        "accountNo": "1015",
        "personName": "bjt",
        "personCardno": "1515194060",
        "temperature": "",
        "photoUrl": "http://192.168.20.12:11108/zhaoyang/uploadFile/Camera/2021-12-13/20211213182149-1015.jpg",
        "dataState": "禁止通过(不在归寝签到时段内)"
    },
    {
        "id": 30392,
        "signDate": "2021-12-13 18:21:56",
        "deviceName": "归寝默认",
        "deviceCode": "1130",
        "iNOut": "进",
        "userId": null,
        "accountNo": "1015",
        "personName": "bjt",
        "personCardno": "1515194060",
        "temperature": "",
        "photoUrl": "http://192.168.20.12:11108/zhaoyang/uploadFile/Camera/2021-12-13/20211213182156-1015.jpg",
        "dataState": "禁止通过(不在归寝签到时段内)"
    }
]
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:1003#

消息说明:订阅门禁设备签到明细
输出报文格式为:
[
    {
        "id": 30491,
        "signDate": "2021-12-23 18:00:48",
        "deviceName": "人脸信息测试",
        "deviceCode": "00240390_1305264",
        "InOut": "进",
        "userId": null,
        "accountNo": "陌生人",
        "personName": "陌生人",
        "personCardno": null,
        "temperature": "",
        "photoUrl": "http://192.168.20.12:11108/zhaoyang/uploadFile/Camera/2021-12-23/20211223180048-陌生人.jpg",
        "dataState": "禁止通过(陌生人)"
    },
    {
        "id": 30492,
        "signDate": "2021-12-23 18:09:50",
        "deviceName": "人脸信息测试",
        "deviceCode": "00240390_1305264",
        "InOut": "进",
        "userId": null,
        "accountNo": "陌生人",
        "personName": "陌生人",
        "personCardno": null,
        "temperature": "",
        "photoUrl": "http://192.168.20.12:11108/zhaoyang/uploadFile/Camera/2021-12-23/20211223180950-陌生人.jpg",
        "dataState": "禁止通过(陌生人禁止通过)"
    }
] 
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:1004#

消息说明:订阅推送通道签到明细
输出报文格式为:
[
    {
        "id": 30488,
        "signDate": "2021-12-23 15:28:11",
        "deviceName": "未填写",
        "deviceCode": "00240390_1357186",
        "InOut": "进",
        "userId": null,
        "accountNo": "123456",
        "personName": "流星雨",
        "personCardno": "1395221254",
        "temperature": "",
        "photoUrl": "http://192.168.20.12:11108/zhaoyang/uploadFile/Camera/2021-12-23/20211223152811-123456.jpg",
        "dataState": "禁止通过(不在通行时段内)"
    },
    {
        "id": 30489,
        "signDate": "2021-12-23 15:51:54",
        "deviceName": "05114",
        "deviceCode": "00240390_1357186",
        "InOut": "进",
        "userId": null,
        "accountNo": "陌生人",
        "personName": "陌生人",
        "personCardno": null,
        "temperature": "",
        "photoUrl": "http://192.168.20.12:11108/zhaoyang/uploadFile/Camera/2021-12-23/20211223155154-陌生人.jpg",
        "dataState": "禁止通过(陌生人禁止通过)"
    }
] 
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:1006#

消息说明:订阅会议签到明细
输出报文格式为:
[
    {
        "id": 1,
        "meetingId": "123456",
        "meetingname": "测试会议名称",
        "meetingdate": "会议日期",
        "meetingtime": "会议时间",
        "Originator": "参会人员账号",
        "signdatetime": "签到时间",
        "signstate": "签到状态",
        "photoUrl": ""
    },
    {
        "id": 2,
        "meetingId": "1234567",
        "meetingname": "测试会议名称",
        "meetingdate": "会议日期",
        "meetingtime": "会议时间",
        "Originator": "参会人员账号",
        "signdatetime": "签到时间",
        "signstate": "签到状态",
        "photoUrl": ""
    }
] 
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:1007#

消息说明:订阅全部设备通行明细
输入报文格式为:
[
    {
        "id": 30500,
        "signDate": "2021-12-24 11:19:15",
        "deviceName": "通行设备名称0511",
        "deviceCode": "通行设备编号0511",
        "deviceType": "门禁设备",
        "iNOut": "进",
        "userId": 第三方人员Id,
        "accountNo": "工/学号123456",
        "personName": "姓名:流星雨",
        "personCardno": "卡号1395221254",
        "temperature": "36.3",
        "photoUrl": "http://192.168.20.12:11108/zhaoyang/uploadFile/Camera/2021-12-24/20211224111915-123456.jpg",
        "dataState": "允许通行"
    },
    {
        "id": 30501,
        "signDate": "2021-12-24 14:08:20",
        "deviceName": "0511",
        "deviceCode": "0511",
        "deviceType": "门禁设备",
        "iNOut": "进",
        "userId": null,
        "accountNo": "123456",
        "personName": "流星雨",
        "personCardno": "1395221254",
        "temperature": "36.5",
        "photoUrl": "http://192.168.20.12:11108/zhaoyang/uploadFile/Camera/2021-12-24/20211224140820-123456.jpg",
        "dataState": "允许通行"
    }
] 
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:2001#

消息说明:消费明细推送订阅
第三方报文输入: 订阅编号:2001消费明细推送订阅的接收报文格式为:
[
    {
        "id": 12494,
        "userId": null,
        "spendDate": "2021-10-16 11:57:03",
        "deviceCode": "0004",
        "deviceName": "超市",
        "accountNo": "210111199408204213",
        "personName": "张宇",
        "spendPlace": "螺蛳粉",
        "spendConent": "土豆粉",
        "price": 0.01,
        "quantity": 1,
        "spendMoney": 0.01
    },
    {
        "id": 12495,
        "userId": null,
        "spendDate": "2021-10-16 11:57:08",
        "deviceCode": "0004",
        "deviceName": "超市",
        "accountNo": "210111199408204213",
        "personName": "张宇",
        "spendPlace": "螺蛳粉",
        " spendConent": "土豆粉",
        "price": 0.01,
        "quantity": 1,
        "spendMoney": 0.01
    }
]
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:2002#

消息说明:水控明细推送订阅
输出报文格式为:
[
    {
        "id": 343,
        "userId": null,
        "spendType": "水控消费",
        "spendDate": "2021-01-27 15:33:21",
        "deviceCode": "1101",
        "deviceName": "111",
        "accountNo": "111111",
        "personName": "测试11",
        "price": 0,
        "quantity": 0,
        "spendMoney": 0.53
    },
    {
        "id": 344,
        "userId": null,
        "spendType": "水控消费",
        "spendDate": "2021-01-27 15:33:51",
        "deviceCode": "1101",
        "deviceName": "111",
        "accountNo": "111111",
        "personName": "测试11",
        "price": 0,
        "quantity": 0,
        "spendMoney": 0.16
    }
]
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:3001#

消息说明:请假明细推送订阅
输出报文格式为:
[
    {
        "id": 318,
        "userId": "TWDEVS1200001463325",
        "beginDate": "2021-12-15 09:59",
        "endDate": "2021-12-15 23:59",
        "leaveType": "事假",
        "accountNo": "321456",
        "personName": "    吴翔test",
        "applyCausation": "1"
    },
    {
        "id": 319,
        "userId": "TWDEVS1200001440688",
        "beginDate": "2021-12-15 09:59",
        "endDate": "2021-12-15 23:59",
        "leaveType": "事假",
        "accountNo": "test000000031",
        "personName": "淄川生31",
        "applyCausation": "1"
    }
]
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:4001#

消息说明:访客来访登记明细
输出报文格式为:
[
    {
        "id": "1",
        "visitDate": "2019-02-12 12:00:00",
        "visitInfo": "来访事由",
        "type": "用户类型(访问,VIP等)",
        "personName": "姓名"
    },
    {
        "id": "2",
        "visitDate": "2019-02-12 12:00:00",
        "visitInfo": "来访事由",
        "type": "用户类型(访问,VIP等)",
        "personName": "姓名"
    }
]
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:5001#

消息说明:推送当前所有设备状态
输出报文格式为:
[
    {
        "deviceType": "宿舍通行",
        "deviceName": "1111",
        "deviceCode": " 1",
        "deviceState": "故障"
    },
    {
        "deviceType": "单向通行(进门读卡)",
        "deviceName": "6",
        "deviceCode": "0",
        "deviceState": "故障"
    },
    {
        "deviceType": "电子班牌",
        "deviceName": "乐舜演示机器",
        "deviceCode": "000081802012",
        "deviceState": "故障"
    },
    {
        "deviceType": "电子班牌",
        "deviceName": "000081802013",
        "deviceCode": "000081802013",
        "deviceState": "故障"
    }
]
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:8001#

消息说明:推送增量人员详细信息数据
输入报文格式为:
[
    {
        "cardState": "1",    //1正常 2挂失或冻结
        "cardNo": "人员卡号",
        "studentNO": "人员账号",
        "studentName": "人员姓名",
        "cardBalance": "卡内余额",
        "imgUrl": "图片URL地址,返回相对路径,调用时应 http://IP地址:端口号 + imgUrl",
        "createTime": "创建时间",
        "identityCode": "身份编号",
        "identityName": "身份名称",
        "depCode": "我方部门编号",
        "depName": "部门名称",
        "idCard": "身份证号",
        "validdate": "有效日期",
        "联系电话": "",
        "银行卡号": "",
        "gender": "性别",
        "typeId": "类型编号0:学生(正式员工)、1:老师(协力员工)",
        "IsSignAContract": "",
        "schoolCode": "8位学校编码"
    }
] 
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:9001#

消息说明:推送所有设备信息
输出报文格式为:
[
    {
        "deviceCode": "s0001",
        "deviceName": "测试",
        "deviceType": "消费管理",
        "deviceStatus": "离线",
        "lastOnlineTime": "",
        "IP":"",
        "groupName": "初始区域"
    },
    {
        "deviceCode": "8FOABBCPAJ00026",
        "deviceName": "K12",
        "deviceType": "电子班牌",
        "deviceStatus": "离线",
        "lastOnlineTime": "",
        "IP":"",
        "groupName": "初始区域"
    },
    {
        "deviceCode": "1112",
        "deviceName": "1112",
        "deviceType": "电子班牌",
        "deviceStatus": "离线",
        "lastOnlineTime": "",
        "IP":"",
        "groupName": "初始区域"
    }
]
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:9002#

消息说明:推送下发、删除人员档案
输出报文格式为:
[
  {
    "f_ControllerSN": "04320150_2472011",
    "State": "完成",
    "Command": "删除档案",
    "CommandContent": "[{\"Id\":73395}]",
    "time": null
  },
  {
    "f_ControllerSN": "04320150_2472011",
    "State": "完成",
    "Command": "新增档案",
    "CommandContent": "[{\"Id\":73395,\"AccountNo\":\"122999414\",\"PersonName\":\"彭守成\",\"ImgUrl\":\"http:\\/\\/172.168.2.10\\/04320150\\/images\\/default.jpg\",\"CardNo\":\"2903025485\",\"IDCard\":\"\"}]",
    "time": null
  },
  {
    "f_ControllerSN": "04320150_2471988",
    "State": "完成",
    "Command": "删除档案",
    "CommandContent": "[{\"Id\":73395}]",
    "time": null
  },
  {
    "f_ControllerSN": "04320150_2471988",
    "State": "完成",
    "Command": "新增档案",
    "CommandContent": "[{\"Id\":73395,\"AccountNo\":\"122999414\",\"PersonName\":\"彭守成\",\"ImgUrl\":\"http:\\/\\/172.168.2.10\\/04320150\\/images\\/default.jpg\",\"CardNo\":\"2903025485\",\"IDCard\":\"\"}]",
    "time": null
  },
  {
    "f_ControllerSN": "04320150_2471996",
    "State": "完成",
    "Command": "删除档案",
    "CommandContent": "[{\"Id\":73395}]",
    "time": null
  }
]
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

订阅消息编号:XFMX_001#

消息说明:消费明细信息推送
输出报文格式为:
[
        {
            "Id": "我方流水号",
            "UserId": "第三方id",
            "UserType": "身份类型(学生/老师)",
            "AccountNo": "工号/学号",
            "TradeType": "交易类型(充值/消费)",
            "strPayMode": "交易类别",
            "MerchantName": "商户名称",
            "MerchantType": "商户类型",
            "TradeTime": "入账时间",
            "SpendTime": "消费时间",
            "TradeMoney": 0, --交易金额
            "PreTradeMoney": 0, --交易前金额 
            "AfterTradeMoney": 0, --交易后金额
            "spendPlace": "交易窗口",
            "windows_number": "窗口机号",
            "zfType": "支付类型(区分洗澡和食堂消费超市消费)",
            "sex": "性别"
        }
]
第三方报文接收成功后返回结果0成功1失败
{"code": 0,"Msg": "成功"}

## 订阅消息编号:XFMX_001

消息说明:消费明细信息推送
输出报文格式为:
[
{
            "Id": "我方流水号",
            "UserId": "第三方id",
            "UserType": "身份类型(学生/老师)",
            "AccountNo": "工号/学号",
            "TradeType": "交易类型(充值/消费)",
            "strPayMode": "交易类别",
            "MerchantName": "商户名称",
            "MerchantType": "商户类型",
            "TradeTime": "入账时间",
            "SpendTime": "消费时间",
            "TradeMoney": 0, --交易金额
            "PreTradeMoney": 0, --交易前金额
            "AfterTradeMoney": 0, --交易后金额
            "spendPlace": "交易窗口",
            "windows_number": "窗口机号",
            "zfType": "支付类型(区分洗澡和食堂消费超市消费)",
            "sex": "性别"
        }
]

第三方报文接收成功后返回结果0成功1失败 
{"code": 0,"Msg": "成功"}
上一页
获取当前时间某人请假信息
下一页
可订阅消息查询
Built with