开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
    • 按设备类型浏览
    • 设备能力
    • 事件总览
      • 事件总表
      • 设备状态
      • 绑定与授权
      • 侦测告警
      • 门铃与门锁
      • 服务
      • 概述与公共负载
      • 事件消息类型定义
      • 事件消息格式定义
    • 权限码
    • 错误码
    • 告警与能力消息
    • 常见问题
    • 历史能力与推送类型
  • API 参考
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
能力事件(capabilityEvent)
通用报警消息
设备或通道上下线
设备报警

概述与公共负载

概述与公共负载

各事件的完整示例仍在 事件消息格式定义。下面只列该页示例里重复出现的字段。

能力事件(capabilityEvent)

订阅 setMessageCallback 的 capabilityEvent 后,能力事件与属性变化走统一外壳(与 接收设备消息、接收告警 推送 body 一致),不是下文历史推送类型表的 did/cid/desc 结构。

JSON 字段说明
msgType等于能力 eventId,如 detection.motion.detected;属性上报为 device.property.report
deviceId设备序列号
productId产品型号
channelId通道级事件返回;设备级事件不出现
outputData该事件业务字段;无则为 {}
time上报时间,Unix 秒
localTime设备本地 yyyyMMddTHHmmss
alarmId告警 id,用于查询/删除
token联动云录像时出现

各 /events/* 事件页样例只展开 outputData;外壳字段以本表与 接收设备消息 为准。

通用报警消息

以下字段适用于 旧版报警推送(如 alarm 回调、msgType 为画面变化/移动检测等旧格式),与 capabilityEvent 外壳不同。

画面变化、移动检测、区域入侵三则示例都包含这些字段:

JSON 字段说明
id消息 id
appId开发者 appId
did设备序列号
cid通道号
msgType消息类型
type类型值
time报警时间
utcTimeUTC 报警时间
cname设备通道名称
remark备注
token关联云录像 token;仅 platForm 为 4 的设备报警消息会携带
subType子类型,示例为 Alarm
skip扩展字段,示例为空对象 {}
action动作,示例为 start
desc各 msgType 的业务字段;区域入侵时 desc.region 为入侵区域名称

设备或通道上下线

msgType 为 online 或 offline。cid 为 -1 表示设备上下线,非 -1 表示具体通道。部分型号设备会返回 pid(与 productId 能力相关)。同页示例还有 dname(设备名称)、iotFlag、userId。

设备报警

msgType 为 iotEvent。通道号字段名是 channelId,不是 cid。content.event 对应物模型中的事件种类,content.localTime 是事件本地时间,content.outputData 在示例中为空对象。

上文 legacy 小节与 事件消息格式定义 第一~三节一致;msgType 枚举见 事件消息类型定义。对照副本:历史事件报文格式 · 历史事件类型(msgType)。

服务
事件消息类型定义