1. 与核心版接口改动说明
知眸开放平台
  • 部署文档
  • 接口错误码
  • 更新记录
  • 授权
    • 授权接口
      POST
  • 应用
    • 获取应用列表
      GET
  • 任务
    • 开启任务
      POST
    • 获取任务列表
      GET
    • 结束任务
      DELETE
    • 更新任务配置
      PUT
    • 上传任务图片
      POST
    • 获取指定应用AI视频
      POST
    • 关闭指定应用AI视频
      DELETE
  • 回调
    • Mqtt任务数据订阅
    • 消息回调接口
      POST
  • 流媒体
    • 获取视频流
      POST
    • 释放视频流
      DELETE
  • 与核心版接口改动说明
    • 核心版卸载
    • 授权模块
    • 应用模块
    • 任务模块
    • 回调
  1. 与核心版接口改动说明

回调

4.1 MQTT回调#

1. event = start, event = stop, event = dummy_frame_start, event = dummy_frame_stop#

字段名旧版新版变更类型变更说明
zapk_id-string、必选新增字段应用包ID,即旧版apps下app_id
device_id-string、可选新增字段设备ID, 即旧版的device
business_idstring、可选string、可选无变更业务ID
eventstring、可选string、可选无变更事件
task_idstring、必选string、必选无变更任务ID
timestampinteger、必选integer、必选无变更时间戳
app_idstring、必选-删除字段字段已移除
devicestring、可选-删除字段字段已移除

2. 视频分析任务识别数据发布 event = frame#

字段名旧版新版变更类型变更说明
zapk_id-string、必选新增字段应用包ID,即旧版apps下app_id
device_id-string、可选新增字段设备ID, 即旧版的device
eventstring、必选string、必选无变更事件
task_idstring、必选string、必选无变更任务ID
business_idstring、可选string、可选无变更业务ID
timestampinteger、必选integer、必选无变更时间戳
dataobject、可选object、可选无变更事件数据
app_idstring、必选-删除字段字段已移除
devicestring、可选-删除字段字段已移除

2. data子级字段#

字段名旧版新版变更类型变更说明
dump-string、可选新增字段任务校验码, 即旧版的task_dump
close_code-integer、可选新增字段任务结束码,即旧版的close_reason,1: 主动关闭,2: 视频流结束,3: 任务超时(视频任务补黑帧超时
apps-array、必选新增字段应用结果列表, 即旧版的rules
frameobject、可选object、可选数据结构变化详见frame
task_dumpstring、必选-删除字段字段已移除
close_codeinteger、可选-删除字段字段已移除
rulesarray、必选-删除字段字段已移除

3. frame子级字段#

字段名旧版新版变更类型变更说明
enhance-integer、必选新增字段图片增强参数
idinteger、必选integer、必选无变更视频帧ID或图片ID
widthinteger、必选integer、必选无变更图片宽度
heightinteger、必选integer、必选无变更图片高度
flightobject、必选-删除字段字段已移除

4. apps子级字段#

字段名旧版新版变更类型变更说明
scene_instances-array、可选新增字段场景实例
app_id-string、必选无变更应用ID, 即旧版的rule_id
app_name-string、必选无变更应用名称, 即旧版的rule_name
imagestring、可选string、可选值变更base64->url
objectsarray、可选array、可选数据结构变化详见objects
app_idstring、必选-删除字段字段已移除
app_namestring、必选-删除字段字段已移除

5. objects子级字段#

字段名旧版新版变更类型变更说明
attr-object、可选新增字段属性识别结果
description-string、可选新增字段目标描述
class_idstring、必选string、必选无变更类别ID
namestring、必选string、必选无变更类别名称
colorstring、必选string、必选无变更颜色
xinteger、必选integer、必选无变更中心点X坐标
yinteger、必选integer、必选无变更中心点Y坐标
track_idinteger、可选integer、可选无变更跟踪ID
confidencenumber、必选number、必选无变更置信度
speed_pxinteger、可选-删除字段字段已移除
angle_pxinteger、可选-删除字段字段已移除
class_namestring、必选-删除字段字段已移除
attr_namestring、可选-删除字段字段已移除
attr_textstring、可选-删除字段字段已移除
attr_imagestring、可选-删除字段字段已移除
attrsarray、可选-删除字段字段已移除

4.2 消息回调 POST /#

请求方式、请求路径两版一致。

1. 回调根字段#

字段名旧版新版变更类型变更说明
zapk_id-string、必选新增字段应用包ID,即旧版apps下app_id
device_id-string、可选新增字段设备ID, 即旧版的device
eventstring、必选string、必选无变更start: 任务开始, stop: 任务关闭, message: 消息生成, dummy_frame_start: 补黑帧开始, dummy_frame_stop: 补黑帧结束
task_idstring、必选string、必选无变更任务ID
business_idstring、可选string、可选无变更业务ID
timestampinteger、必选integer、必选无变更时间戳
dataobject、可选object、可选无变更事件数据
app_idstring、必选-删除字段字段已移除
devicestring、可选-删除字段字段已移除

2. data子级字段#

字段名旧版新版变更类型变更说明
dump-string、可选新增字段任务校验码, 即旧版的task_dump
close_code-integer、可选新增字段任务结束码,即旧版的close_reason,1: 主动关闭,2: 视频流结束,3: 任务超时(视频任务补黑帧超时
apps-array、必选新增字段应用结果列表, 即旧版的rules
frameobject、可选object、可选数据结构变更详见frame
task_dumpstring、必选-删除字段字段已移除
close_codeinteger、可选-删除字段字段已移除
rulesarray、必选-删除字段字段已移除

3. frame子级字段#

字段名旧版新版变更类型变更说明
enhance-integer、必选新增字段图片增强参数
idinteger、必选integer、必选无变更视频帧ID或图片ID
widthinteger、必选integer、必选无变更图片宽度
heightinteger、必选integer、必选无变更图片高度
flightobject、必选-删除字段字段已移除

4. apps子级字段#

字段名旧版新版变更类型变更说明
scene_instances-string、可选新增字段场景实例
app_id-string、必选无变更应用ID, 即旧版的rule_id
app_name-string、必选无变更应用名称, 即旧版的rule_name
imagestring、可选string、可选值变更base64->url
objectsarray、可选array、可选数据结构变更详见objects
app_idstring、必选-删除字段字段已移除
app_namestring、必选-删除字段字段已移除

5. objects子级字段#

字段名旧版新版变更类型变更说明
attr-object、可选新增字段属性识别结果
description-string、可选新增字段目标描述
class_idstring、必选string、必选无变更类别ID
namestring、必选string、必选无变更类别名称
colorstring、必选string、必选无变更颜色
xinteger、必选integer、必选无变更中心点X坐标
yinteger、必选integer、必选无变更中心点Y坐标
track_idinteger、可选integer、可选无变更跟踪ID
confidencenumber、必选number、必选无变更置信度
class_namestring、必选-删除字段字段已移除
speed_pxinteger、可选-删除字段字段已移除
angle_pxinteger、可选-删除字段字段已移除
class_namestring、必选-删除字段字段已移除

6. attr子级字段#

字段名旧版新版变更类型变更说明
name-string、必选新增字段属性名称,即旧版attr_name
text-string、必选新增字段属性值,即旧版attr_box
box-object、必选新增字段框坐标

7. box子级字段#

字段名旧版新版变更类型变更说明
x-integer、必选新增字段左上角X坐标
y-integer、必选新增字段左上角Y坐标
w-integer、必选新增字段宽度
h-integer、必选新增字段高度
修改于 2026-06-25 10:35:30
上一页
任务模块
Built with