开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
    • 按设备类型浏览
    • 设备能力
    • 事件总览
      • 事件总表
      • 设备状态
      • 绑定与授权
      • 侦测告警
      • 门铃与门锁
      • 服务
      • 概述与公共负载
      • 事件消息类型定义
      • 事件消息格式定义
    • 权限码
    • 错误码
    • 告警与能力消息
    • 常见问题
    • 历史能力与推送类型
  • API 参考
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
一、通用报警消息(旧版推送)
画面变化消息格式:
移动检测消息格式:
区域入侵消息格式:
二、能力模型 设备报警消息(设备信息或设备二维码标签有 productId 字段)
设备移动检测消息格式:
设备人形检测消息格式:
设备区域入侵检测消息格式:
三、设备通道上下线消息
设备或通道上线消息格式:
设备或通道下线消息格式:
四、能力目录事件(capabilityEvent)

事件消息格式定义

事件消息格式示例

下文 一~三 为旧版 alarm/iot/deviceStatus 回调样例(did/cid/desc);msgType 枚举见 事件消息类型定义(历史对照)。能力目录事件(capabilityEvent,deviceId/outputData)见 四、能力目录事件 与 概述与公共负载。一~三节完整副本见 历史事件报文格式。

一、通用报警消息(旧版推送)

画面变化消息格式:

{
 "id": 2447736561,
 "appId": "lcdxxxxxxxxx", //开发者appId
 "did": "TESTQWERXXXX", //设备序列号
 "cid": 0, //通道号
 "msgType": "videoMotion", //消息类型
 "type": 1,
 "time": 1475052555, //报警时间
 "utcTime": 1475052555, //UTC报警时间
 "cname": "Front Door", //设备通道名称
 "remark": "",
 "token": "f2dc8c09eeae4b5bad6abf522c93d825", //关联云录像token
 "subType": "Alarm",
 "skip": {},
 "action": "start",
 "desc": {}
}

备注:

1、只有 platForm 为 4 的设备触发报警消息才会带上“token”字段

2、desc 字段在不同的消息类型中,存放不同的字段

移动检测消息格式:

{
 "id": 2447736570,
 "appId": "lcdxxxxxxxxx", //开发者appId
 "did": "TESTQWERXXXX", //设备序列号
 "cid": 0, //通道号
 "msgType": "mobileDetect", //消息类型
 "type": 167,
 "time": 1475052555, //报警时间
 "utcTime": 1475052555, //UTC报警时间
 "cname": "Front Door", //设备通道名称
 "remark": "",
 "token": "f2dc8c09eeae4b5bad6abf522c93d825", //关联云录像token
 "subType": "Alarm",
 "skip": {},
 "action": "start",
 "desc": {}
}

区域入侵消息格式:

{
 "id": 2447736563,
 "appId": "lcdxxxxxxxxx", //开发者appId
 "did": "TESTQWERXXXX", //设备序列号
 "cid": 0, //通道号
 "msgType": "crossRegionDetection", //消息类型
 "type": 10211,
 "time": 1475052555, //报警时间
 "utcTime": 1475052555, //UTC报警时间
 "cname": "Front Door", //设备通道名称
 "remark": "",
 "token": "f2dc8c09eeae4b5bad6abf522c93d825", //关联云录像token
 "subType": "Alarm",
 "skip": {},
 "action": "start",
 "desc": {
 "region": "区域1" //入侵区域名称
 }
}

二、能力模型 设备报警消息(设备信息或设备二维码标签有 productId 字段)

设备移动检测消息格式:

{
 "msgType": "iotEvent", //iotEvent 类型报警
 "appId": "lcdxxxxxxxxx", //开发者appId
 "userId": "user001",
 "did": "TESTQWERXXXX", //设备序列号
 "pid": "B2HP68AA", //productId(设备详情或标签有则返回)
 "dname": "Front Door Camera", //设备名称
 "channelId": "0", //通道号
 "alarmId": "1162578620235051004", //消息事件ID
 "time": "20250901195200", //报警时间
 "utcTime": "20250901T115200", //UTC报警时间
 "token": "f2dc8c09eeae4b5bad6abf522c93d825", //关联云录像token
 "content": {
 "event": "32000", //对应设备物模型中具体事件种类,32000代表移动检测
 "localTime": "20250901195200", //事件本地时间
 "outputData": {}
 }
}

设备人形检测消息格式:

{
 "msgType": "iotEvent", //iotEvent 类型报警
 "appId": "lcdxxxxxxxxx", //开发者appId
 "userId": "user001",
 "did": "TESTQWERXXXX", //设备序列号
 "pid": "B2HP68AA", //productId(设备详情或标签有则返回)
 "dname": "Front Door Camera", //设备名称
 "channelId": "0", //通道号
 "alarmId": "1162578620235051004", //消息事件ID
 "time": "20250901195200", //报警时间
 "utcTime": "20250901T115200", //UTC报警时间
 "token": "f2dc8c09eeae4b5bad6abf522c93d825", //关联云录像token
 "content": {
 "event": "33000", //对应设备物模型中具体事件种类,33000代表人形检测
 "localTime": "20250901195200", //事件本地时间
 "outputData": {}
 }
}

设备区域入侵检测消息格式:

{
 "msgType": "iotEvent", //iotEvent 类型报警
 "appId": "lcdxxxxxxxxx", //开发者appId
 "userId": "user001",
 "did": "TESTQWERXXXX", //设备序列号
 "pid": "YHVYZA5Q", //productId(设备详情或标签有则返回)
 "dname": "Front Door Camera", //设备名称
 "channelId": "0", //通道号
 "alarmId": "1162578620235051004", //消息事件ID
 "time": "20250901195200", //报警时间
 "utcTime": "20250901T115200", //UTC报警时间
 "token": "f2dc8c09eeae4b5bad6abf522c93d825", //关联云录像token
 "content": {
 "event": "312200", //对应设备物模型中具体事件种类,312200代表区域入侵
 "localTime": "20250901195200", //事件本地时间
 "outputData": {}
 }
}

三、设备通道上下线消息

设备或通道上线消息格式:

{
 "id": -1,
 "appId": "lcdxxxxxxxxx", //开发者appId
 "did": "TESTQWERXXXX", //设备序列号
 "cid": -1, //通道号,-1代表设备上线,非-1则代表具体通道上线
 "pid": "B2HP68AA", //productId;仅当设备带 productId 时返回
 "msgType": "online", //消息类型
 "type": 11,
 "time": 1475052555, //报警时间
 "utcTime": 1475052555, //UTC报警时间
 "cname": "Front Door", //通道名称
 "dname": "Front Door Camera", //设备名称
 "skip": {},
 "iotFlag": "false",
 "userId": 10001
}

设备或通道下线消息格式:

{
 "id": -1,
 "appId": "lcdxxxxxxxxx", //开发者appId
 "did": "TESTQWERXXXX", //设备序列号
 "cid": -1, //通道号,-1代表设备下线,非-1则代表具体通道下线
 "pid": "B2HP68AA", //productId;仅当设备带 productId 时返回
 "msgType": "offline", //消息类型
 "type": 12,
 "time": 1475052555, //报警时间
 "utcTime": 1475052555, //UTC报警时间
 "cname": "Front Door", //通道名称
 "dname": "Front Door Camera", //设备名称
 "skip": {},
 "iotFlag": "false",
 "userId": 10001
}

四、能力目录事件(capabilityEvent)

订阅 capabilityEvent(setMessageCallback)后,msgType 等于能力 eventId,业务字段在 outputData。索引见 事件总表,外壳字段见 概述与公共负载。完整字段说明以各能力 event 页为准(如 算法包下载结果)。接入见 接收设备消息 · 接收告警。

{
 "msgType": "algorithm.package.downloadResult",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "outputData": {
 "type": "1",
 "dwnResult": {
 "ret": "1",
 "url": "https://example/pkg.bin"
 }
 },
 "time": 1673406989,
 "localTime": "20230111T111629",
 "alarmId": "116257862023505xxxx"
}
事件消息类型定义
权限码