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

通讯录变更事件

POST
https://127.0.0.1/suite/receive
当设备可用范围内有新增或减少人员时,或者可用范围内的人员的userid发生变化时,企业微信回调事件到厂商在设备型号详情中登记的回调URL
服务商的响应必须在1000ms内完成
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://127.0.0.1/suite/receive' \
--header 'Content-Type: application/json' \
--data-raw '{
    "msg_type":"event",
    "base_info":{
        "req_id":"xxx",
        "device_sn":"xxx",
        "createtime":1658332800,
        "model_id":"xxx",
        "auth_corpid":"xxx",
        "service_corpid":"xxx"
    },
    "event":{
        "event_type":"contact_change",
        "perm_version":5,
        "create_user":[
            {
                "open_userid":"xxxt",
                "user_type":0
            },
            {
                "open_userid":"xxxy",
                "user_type":0
            }
        ],
        "update_user":[
            {
                "open_userid":"xxxu",
                "user_type":0
            }
        ],
        "delete_user":[
            {
                "open_userid":"xxxi",
                "user_type":0
            }
        ]
    }
}'
响应示例响应示例
{}

请求参数

Query 参数
msg_signature
string 
可选
示例值:
3a7b08bb8e6dbce3c9671d6fdb69d15066227608
timestamp
string 
可选
示例值:
1403610513
nonce
string 
可选
示例值:
380320359
Body 参数application/json
msg_type
string 
必需
用于表示本消息是 事件event 还是指令 command,此处固定为event , 对应command节点数据有效
base_info
object 
固定字段基础数据
必需
req_id
string 
必需
请求req_id,可以用于排重
device_sn
string 
必需
设备序列号,在第三方管理端登记的SN
createtime
integer 
必需
事件触发时间戳(unix 时间戳 单位:秒)
model_id
string 
必需
设备型号modelid
auth_corpid
string 
必需
绑定设备企业的corpid
service_corpid
string 
必需
硬件提供商企业corpid
event
object 
指令数据
必需
event_type
string 
必需
指令类型,通讯录成员范围变更,此处固定为 contact_change
perm_version
integer 
必需
当前云端通讯录版本号,版本号严格递增(每次增加1),当推送版本号跟考勤机版本号之间出现空洞(>=2)时,说明考勤机可能遗漏推送事件,考勤机应记录下来,选择一定的时间全量拉取通讯录。
create_user
array [object {2}] 
新增成员列表
必需
update_user
array [object {2}] 
必需
更新成员指纹信息成员列表
delete_user
array [object {2}] 
删除成员列表
必需
示例

返回响应

🟢200成功
application/json
Body
object {0}

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

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

扫码加入交流群
上一页
企业解绑设备事件
下一页
固件升级指令
Built with