橙电科技零售柜套件开放平台
  1. 事件回调通知
橙电科技零售柜套件开放平台
  • 接入流程和鉴权
    • 获取访问令牌
      POST
  • 开放资源api
    • ping设备
      GET
    • 刷新设备硬件状态缓存
      GET
    • 获取设备硬件状态信息
      GET
    • 获取设备硬件信息
      GET
    • 检查设备是否可以开门
      GET
    • 下发指令操作设备开门
      POST
    • 设备开锁指令
      POST
    • 设置灯光
      POST
    • 设置设备音量
      POST
    • 设备重启系统
      POST
    • 重传订单视频文件
      POST
    • 设备风扇参数设置
      POST
    • 设备风扇操作
      POST
  • 事件回调通知
    • 接收事件回调通知 POST
      POST
  1. 事件回调通知

接收事件回调通知 POST

POST
/callback
本接口为接收事件回调通知,目前支持:设备上下线通知和设备开门订单流程通知
💡准备好webhook回调URL接口后,联系研发@ddd配置到线上系统中

应用场景#

设备上下线通知#

用户将收到设备在线状态变更的实时通知

设备开门订单流程通知#

在通过下单【设备开门】/openapi/device/open接口操作设备开门之后,系统会对设备从开门到关门流程的每个步骤进行通知。

事件汇总#

事件类型事件描述
online_status设备上下线状态通知
start_buy标志订单开始,表示设备确认订单
bs_openlock_closedoor门锁状态:开锁关门(首次:等待用户拉开柜门;二次:用户关门待自动落锁)
bs_openlock_opendoor门锁状态:开锁开门,表示用户正在购物中
bs_closelock_closedoor门锁状态:关锁关门,表示用户已完成商品挑选
fail_end_buy订单异常结束,告知异常原因
success_end_buy订单正常结束,告知两个摄像头录像信息
success_end_buy_camera1camera1 摄像头视频重传
success_end_buy_camera2camera2 摄像头视频重传
success_end_buy_allcamera1和camera2 摄像头视频重传
bs_open_camera_fail有一/二个摄像头开启失败;因设备配备双摄像头,如只有一个故障的话,不影响订单
bs_close_camera_fail有一/二个摄像头关闭失败;因设备配备双摄像头,如只有一个故障的话,不影响订单

不同类型消息体示例和字段说明#

online_status - 设备上下线通知#

字段名类型描述
eventstring事件类型
deviceNostring设备号
onlineStatusint设备在线状态 0未激活,1在线,2离线
lastOnlineTimelong最近一次在线时间,时间戳格式,单位:毫秒级

start_buy - 订单开始 / bs_openlock_closedoor - 开锁关门 / bs_openlock_opendoor - 开锁开门 / bs_closelock_closedoor - 关锁关门#

字段名类型描述
eventstring事件类型
deviceNostring设备号
orderIdstring订单号
outTradeNostring用户自定义订单号
datetimestring事件产生时间

fail_end_buy - 订单异常结束#

字段名类型描述
eventstring事件类型
deviceNostring设备号
orderIdstring订单号
outTradeNostring用户自定义订单号
datetimestring事件产生时间
errMsgstring异常结束原因
videoInfosarray[obj]摄像头录像信息,当errMsg为“bs_opendoor_overtime”时有值
obj.camerastring两个值[camera1,camera2],标志对应摄像头
obj.videoTimeint录像时间,单位:秒
obj.videoUrlstring录像存储地址
fail_end_buy - errMsg 汇总#
errMsg描述备注
bs_openlock_opendoor门锁异常下单前,调用canOpen`/openapi/check/device/canOpen)可以规避该异常
bs_openlock_closedoor门锁异常下单前,调用canOpen`/openapi/check/device/canOpen)可以规避该异常
bs_closelock_opendoor门锁异常下单前,调用canOpen`/openapi/check/device/canOpen)可以规避该异常
have_orders_running冰柜有其他订单正在运行下单前,调用canOpen`/openapi/check/device/canOpen)可以规避该异常
no_open_door没有开门常见事件 - 是指用冰柜锁打开了,但是用户一直没有拉开门;本事件没有视频上报
bs_opendoor_overtime购物超时常见事件 - 是指用户拉开冰柜门了,但是一直没有关门,超过购物超时时间阈值后,系统会停止录像,并上报该购物超时事件;本事件有视频上报
open_camera摄像头启动失败如果主机的两个摄像头全部坏了,则会报该异常;注: 该异常情况下,设备不会开锁;本事件有视频上报
openlock_error开锁失败硬件异常事件,如门变形导致锁没打开;本事件没有视频上报

success_end_buy 订单正常结束 /success_end_buy_all 2个视频重传#

字段名类型描述
eventstring事件类型
deviceNostring设备号
orderIdstring订单号
outTradeNostring用户自定义订单号
datetimestring事件产生时间
videoInfosarray[obj]摄像头录像信息
obj.camerastring两个值[camera1,camera2],标志对应摄像头
obj.videoTimeint录像时间,单位:秒
obj.videoUrlstring录像存储地址

success_end_buy_camera1 视频1重传 /success_end_buy_camera2 视频2重传#

字段名类型描述
eventstring事件类型
deviceNostring设备号
orderIdstring订单号
outTradeNostring用户自定义订单号
datetimestring事件产生时间
videoInfosarray[obj]摄像头录像信息
obj.camerastring一个值[camera1,camera2],标志对应摄像头
obj.videoTimeint录像时间,单位:秒
obj.videoUrlstring录像存储地址

bs_open_camera_fail / bs_close_camera_fail 开关摄像头异常#

字段名类型描述
eventstring事件类型
deviceNostring设备号
orderIdstring订单号
outTradeNostring用户自定义订单号
datetimestring事件产生时间
videoInfosarray[obj]摄像头信息
obj.camerastring两个值[camera1,camera2],标志对应摄像头
obj.videoTimeint忽略
obj.videoUrlstringtrue 为正常工作,false 为异常

请求参数

Header 参数

Body 参数application/json

示例
{}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://ai.mjyun.com/v1//callback' \
--header 'event: online_status' \
--header 'deviceNo: PCAI232200119' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功
application/json
Body

示例
{}
修改于 2025-10-21 15:09:03
上一页
设备风扇操作
Built with