企业微信 API
企业内部开发第三方应用开发智慧硬件开发
企业内部开发第三方应用开发智慧硬件开发
  1. 设备接入
  • 硬件直连接入
    • 概述
    • 设备接入
      • 接入协议概述
      • 接口调用
        • 获取SecretNo
        • 获取服务器时间
        • 设备注册网络
        • 设备激活
        • 设备心跳
        • 获取最新固件信息
        • 上传日志文件
        • 设备登录二维码
        • 上报设备异常事件
        • 获取设备绑定企业信息
        • 触发云端下发指令
      • 回调通知
        • 企业绑定设备事件
        • 企业解绑设备事件
        • 固件升级指令
        • 上传日志文件指令
        • 重启设备指令
      • 蓝牙相关协议
        • 蓝牙识别及配网协议
        • 蓝牙识别及配网SDK
      • 附录
        • 设备比对版本号流程
        • 设备报警及日志上传流程
    • 考勤/门禁设备
      • 接口调用
        • 全量获取用户数据
        • 增量获取用户数据
        • 检查UserId合法性
        • 获取UserId的变更信息
        • 获取通讯录最新版本号
        • 上传识别特征值
        • 增量获取访客数据
        • 获取访客列表最新版本号
        • 上报考勤打卡/门禁通行记录
        • 上报体温检测记录
        • 异步补录体温检测记录
        • 获取设备自助录入开关状态
        • 获取健康码信息
        • 指纹/人脸多算法版本协议
      • 云端下发指令
        • 通讯录变更事件
        • 成员UserId变更事件
        • 访客列表变更事件
        • 设备自助录入开关变更事件
        • 识别信息录入指令
        • 取消识别信息录入指令
        • 远程开门/扫码开门指令
      • 附录
        • 全量拉取通讯录流程
        • 门禁通行规则语法说明
        • 访客UserId规则说明
        • 员工二维码校验规则
        • 访客二维码校验规则
    • 打印/扫描设备
      • 打印/扫描设备接入指引
      • 接口调用
        • 获取身份验证二维码
        • 获取打印任务列表
        • 下载打印文件
        • 上报打印任务状态
        • 上传打印机扫描文件
        • 上报设备自定义属性
        • 带扩展参数的文件上传协议
      • 回调通知
        • 打印任务推送事件
        • 打印任务删除事件
    • 无线投屏设备
      • 无线投屏设备接入指引
      • Andriod系统设备接入
  • 硬件云端接入
    • 设备接入
      • 接口调用
        • 获取设备型号调用凭证
        • 获取设备授权密钥
        • 获取设备调用凭证
        • 录入设备
        • 获取设备详情
        • 更新设备状态
        • 全量获取设备成员列表
        • 获取设备中指定成员的信息
        • 上报设备固件升级结果
      • 回调通知
        • 回调协议相关
        • 企业绑定设备事件
        • 企业解绑设备事件
        • 通讯录变更事件
        • 固件升级指令
        • 设备型号model_ticket推送事件
        • 查询设备SN合法性事件
    • 考勤/门禁设备
      • 接口调用
        • 上报考勤打卡记录
        • 上报体温检测记录
        • 上报门禁通行记录
        • 上报成员识别信息变化结果
        • 上报远程开门结果
      • 回调通知
        • 识别信息录入指令-录入指纹或人脸指令
        • 识别信息录入指令-取消录入指纹或人脸指令
        • 远程开门指令
        • 识别信息删除回调-删除指纹或人脸指令
    • 打印/扫描设备
      • 接口调用
        • 获取打印身份识别二维码
        • 获取打印任务列表
        • 获取打印文件
        • 上报打印任务状态
        • 上传扫描文件
        • 上报打印机状态变更
        • 返回转码后的打印文件
      • 回调通知
        • 推送打印任务
  1. 设备接入

接入协议概述

概要#

当企业启用硬件设备之后,设备可连接企业微信云端,调用相关接口,让设备提供的能力与企业通讯录结合,以实现更加完美的办公体验。目前支持接入的设备有考勤机、门禁、打印机等。

通讯协议#

设备与企业微信云端采用wss(WebSocket Secure)长连接协议。企业微信云端地址为:wss://openhw.work.weixin.qq.com/

设备联网流程#

img
1.
设备开机联网
2.
与企业微信云端建立长连接(地址为:wss://openhw.work.weixin.qq.com/)
3.
注册网络
4.
激活设备(已激活的设备直接跳过该步骤,待激活的设备一直轮询等待企业管理员关联绑定设备)
5.
订阅企业信息
6.
订阅之后,设备方可调用企业微信云端的获取固件最新信息等,并可同时接收企业微信云端下发的指令,例如设备绑定企业完成事件。

企业绑定设备时的匹配方式#

匹配方式的选择#

企业在使用设备之前,需要完成匹配绑定,厂商可为设备选择合适的匹配方式,目前有:输入SN、企业微信扫码(动态二维码与静态二维码)和蓝牙发现等几种方式。输入SN较为简单,不过安全级别相对较低。以下分别说明蓝牙发现、动态二维码、静态二维码三种方式。
img

蓝牙发现#

如果设备有蓝牙模块,可以使用蓝牙匹配方式进行绑定,我们开放了一套对接协议,设备对接之后,企业管理员可在手机端企业微信工作台进入蓝牙发现设备的界面完成设备的查找与绑定。具体协议参见:蓝牙识别及配网协议
上述的协议支持通过企业微信给设备配置wifi网络。用户在发现蓝牙设备之后,如果设备未连网,可让用户先完成配网,之后再进行绑定。设备也可以直接给用户展示以下二维码,用户扫码之后即进行蓝牙发现与配网的流程。
img该二维码的数据内容实际为一个url: https://open.work.weixin.qq.com/hw/f?t=bt
你也可以在设备屏幕上用该url生成二维码。

动态绑定二维码#

硬件设备显示屏上需要显示一个动态二维码,二维码是由一个url生成,url格式如:
https://open.work.weixin.qq.com/connect/hardware?sn=xxxxx&timestamp=1500133456&nonce=1234&signature=fdsaoiurewkjjaaa&type=qrcode
参数说明:
参数名是否必须类型描述
sn是String设备序列号
timestamp是Uint32UTC时间戳,需要每30分钟变更1次(建议10分钟刷新1次),企业微信会检查该时间戳是否在30分钟有效期内,过期会报二维码失效。
nonce是Uint64随机数
signature是String(40)设备签名,sha1(sort(sn、SecretNo、timestamp、nonce、type))。sort的含义是将参数值按照字母字典排序,然后从小到大拼接成一个字符串。SecretNo是由企业微信为每个设备生成的密钥,供应商可将其固化到设备上。
type是String此处固定为qrcode

静态绑定二维码#

若设备仅支持低安全级别,可以展示或者粘贴固定二维码,二维码内容为一个url。在企业微信服务商管理端登记设备后,导出的excel文件中包含该静态二维码url(需要以该url作为数据内容生成二维码)
url格式如:
https://open.work.weixin.qq.com/connect/hardware?hw_code=xxxx

【企业微信】API开发者 微信交流群

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

扫码加入交流群
上一页
概述
下一页
获取SecretNo
Built with