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

指纹/人脸多算法版本协议

1.订阅企业信息#

当企业取消授权后secret失效,当调用登录或者激活接口返回企业未授权时,设备应清空所有数据,重新进行激活。
若设备已经获取过secret并保存,下次联网时可以跳过active,直接发起subscribe_corp。
请求包体:
参数说明:
参数名是否必须类型描述
req_id是String请求的id,自行保证不会重复即可
secret是String凭证密钥
firmware_version是String当前固件版本号
ext_args否object额外参数
fp_algorithm否array(string)该设备支持的指纹算法,"default"为默认值,最多支持5个,仅当设备支持采集指纹时支持该参数,订阅后企业微信会按照本参数优先级选择指纹下发(在数组位置越靠前优先级越高)
fa_algorithm否array(string)该设备支持的人脸算法,"default"为默认值,最多支持5个,仅当设备支持采集人脸时支持该参数,订阅后企业微信会按照本参数优先级选择人脸下发(在数组位置越靠前优先级越高)
返回结果:
参数说明:
参数名描述
req_id透传请求的req_id
errcode错误码
errmsg错误码描述

2.上传用户数据#

用户录入指纹或人脸信息后,将信息同步至云端。最多200人。
请求包体:
参数说明:
参数名是否必须类型描述
req_id是string请求的id,自行保证不会重复即可
userid是string成员id(字符串),长度为1-128个字节。当为访客userid时,参见访客userid规则说明
user_type否Uint32成员的类型: 0:企业员工 1:访客 不填则默认值为0
fa_list否Array(object)人脸数据列表,当fa_list存在时,忽略fa的值
fa_algorithm否string人脸数据算法,没有该字段或者为"default"则为默认算法
fa_list: id否string人脸数据编号,支持0-11,共12个人脸数据
fa_list:data否string人脸数据base64编码,可不填,如果填入空串则表示删除
fp_algorithm否string指纹数据算法, 没有该字段或者为"default"则为默认算法
fp否Array(object)指纹数据
fp: id否string指纹编号, 支持0-9,共十个指纹
fp:data否string指纹数据(base64),如果填入空串则表示删除
oper_id否String录入指纹的操作id,由3.2 (进入录入信息)或者3.7(推送成员录制人脸事件)下发下去。
errcode否int32本次操作的返回值,0表示录入成功, 非0表示失败,非0的具体错误码可以机器自行定义。
errmsg否string本次操作的结果描述, 如果录入成功请填写”ok”。其他errmsg可以机器自行定义。
**注:**oper_id,errcode,errmsg这三个参数填写时机为:在操作界面录入单个成员指纹1min内调用upload_userinfo接口。如果设备断网,后续网络恢复后的补推可以不填写。
访客或者企业内成员通过企业微信app录制也需要传回oper_id,页面会根据回传的errcode和errmsg展示录制结果。
企业微信允许第三方应用设置访客人脸。此处建议设备访客的信息补推一律都不要合并,且尽量带上oper_id,errcode,errmsg,方便企业微信通知第三方应用每个访客的录制结果。
返回结果:
参数说明:
参数名描述
req_id透传请求的req_id
errcode错误码
errmsg错误码描述
fail_list上传失败的用户, 返回值为userid

3.全量拉取用户信息#

设备每次登录成功之后,需要比对本地通讯录版本号和云端最大的版本号,如果不一致则设备需要主动调用该接口。
本接口为分页接口,每页数据返回时会同时返回当前云端的最大版本号,如果同步到最后一页的过程中版本号有变化则需要重新开始同步。
请求包体:
参数说明:
参数名是否必须类型描述
req_id是string请求的id,自行保证不会重复即可
offset是Uint32偏移量(范围是该机器设置的考勤人员列表)
limit是Uint32本次同步的人数(最高200)
is_req_fp_info否Uint32默认1, 0:不返回fp数据列表, 1:才返回
is_req_fa_info否Uint32默认1, 0:不返回fa数据列表, 1:才返回
返回结果:
参数说明:
参数名描述
req_id透传请求的req_id
errcode错误码
errmsg错误码描述
is_lasttrue/false 表示是否最后一页数据
userid成员id(字符串),长度为1-64个字节。
openvid成员id(uint64), 可用于二维码签名校验
user_type成员的类型: 0:企业员工 1:访客 本接口固定均为0
fp_ver指纹版本号
fa_ver人脸版本号
pass_rule_list放行规则列表,id为编号,rule为具体规则,其解析语法请参考附录门禁放行规则语法说明
effect_time规则生效时间
fp成员指纹信息(base64), id,data数据同上传用户数据
fa成员脸部识别信息(base64)
fa_list成员脸部识别信息(base64),id,data数据同上传用户数据
name成员姓名,utf8编码,长度为1-64个字节
perm_version当前云端通讯录版本号
fa_algorithm人脸算法,没有该字段或者为"default"则为默认算法
fp_algorithm指纹算法,没有该字段或者为"default"则为默认算法
注:成员没有放行规则或者放行规则为空时,建议默认行为是员工通行,访客不可通行。

4.增量拉取用户信息#

设备收到成员增量同步的指令后主动调用该接口。
请求包体:
参数说明:
参数名是否必须类型描述
req_id是string请求的id,自行保证不会重复即可
userids是array(string)Userid列表,最多200人
is_req_fp_info否Uint32默认1, 0:不返回fp数据列表, 1:才返回
is_req_fa_info否Uint32默认1, 0:不返回fa数据列表, 1:才返回
返回结果:
参数说明:
参数名描述
req_id透传请求的req_id
errcode错误码
errmsg错误码描述
userid成员id(字符串),长度为1-64个字节
openvid成员id(uint64) , 可用于二维码签名校验
user_type成员的类型: 0:企业员工 1:访客 本接口固定均为0
fp_ver指纹版本号
fa_ver人脸版本号
pass_rule_list放行规则列表,id为编号,rule为具体规则,其解析语法请参考附录门禁放行规则语法说明
effect_time规则生效时间
fp成员指纹信息(base64), id,data数据同上传用户数据
fa_list成员脸部识别信息(base64),id,data数据同上传用户数据
name成员姓名
fp_algorithm指纹算法,为空时表示默认算法
fa_algorithm人脸算法,为空时表示默认算法
注:成员没有放行规则或者放行规则为空时,建议默认行为是员工通行,访客不可通行。

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

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

扫码加入交流群
上一页
获取健康码信息
下一页
通讯录变更事件
Built with