开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
    • 按设备类型浏览
    • 设备能力
    • 事件总览
    • 权限码
    • 错误码
    • 告警与能力消息
      • device.message.list(接收告警)
      • device.message.list(查询告警历史)
      • device.message.search(按类型检索告警)
      • device.message.detail(查询单条告警)
      • device.message.delete(删除告警)
      • 事件总表
    • 常见问题
    • 历史能力与推送类型
  • API 参考
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能详情
请求地址
最小权限
传入参数说明
样例输入
返回 data 字段说明
样例输出
错误码

device.message.search(按类型检索告警)

device.message.search:按类型检索告警

功能详情

按消息类型检索能力事件历史。返回结构和 查询告警历史 相同:data.count、data.nextAlarmId、data.messages。messages[] 里每条与 接收告警 的上报报文相同。msgType 等于 eventId。

历史 alarm / deviceStatus 推送类型不在本接口检索;见 接收设备消息。

beginTime / endTime 为设备本地时间 yyyyMMdd'T'HHmmss(引号只表示字母 T 是字面量),例如 20201022T000000。不要传 Unix 秒,也不要和校时接口的 UTC 混用。

平台字段(token、thumbUrl、picUrlArray、labelType、智见相关)不在能力项的 outputData 里。

请求地址

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.message.search

最小权限

管理员操作自己绑定的设备不需要权限。操作被分享设备需要报警消息权限。子用户绑定不需要。子账号按条校验事件所属能力的 share/sub 权限码(见 权限码),非常用 Alarm 一名概览。只返回有权事件,不因此整单 DV2011。设备须已绑定。

传入参数说明

参数名参数类型是否必填默认值合法值参数说明
tokenString是管理员、子用户或子账号 accessToken
deviceIdString是设备序列号
productIdString否可省略。传了且与该设备实际型号不一致 → DV2009
channelIdString否通道号,IPC 常见 "0"。不要传 -1不传只查设备级;传只查该通道
labelTypeString是如 humanAlarm消息类型标签
beginTimeString是设备本地 yyyyMMddTHHmmss起始时间,例如 20201022T000000
endTimeString是设备本地 yyyyMMddTHHmmss结束时间,例如 20201022T235959
nextAlarmIdString否首页可不传"-1" 或上一批返回值首页 "-1" 或不传;后续传上一批的 nextAlarmId

样例输入

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "channelId": "0",
 "labelType": "humanAlarm",
 "beginTime": "20201022T000000",
 "endTime": "20201022T235959",
 "nextAlarmId": "-1"
 }
}

返回 data 字段说明

参数名参数类型参数说明
countInt本批条数
nextAlarmIdString下一批起点。没有更多时不返回
messagesArray本批告警对象,字段见下表

messages[] 告警对象

参数名参数类型参数说明
msgTypeString等于 eventId,如 detection.motion.detected
deviceIdString设备序列号
productIdString型号
channelIdString通道级事件返回;设备级不返回
outputDataObject该事件的字段。没有则为 {}
timeInt上报时间,Unix 秒
localTimeString设备本地 yyyyMMddTHHmmss
alarmIdString告警 id,用于 detail / delete / 翻页
tokenString联动云录像时出现
thumbUrlString缩略图。有图才返回
picUrlArrayArray告警图。有时效,尽快转存
labelTypeString消息类型标签
aiCopyWritingString开通智见云存储或 AI 智见套餐时才有
securityRiskLevelInt开通智见才有;与 接收告警 推送一致(1~10)。经 Mix 后偶现为等级文案 string
aiTagArray开通智见才有;与 g04 推送一致。经 Mix 后偶现为单标签 string
feedbackObject仅历史查询。type:String;result:Array<String>(见 m05 样例)

样例输出

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "count": 1,
 "nextAlarmId": "116257862023505xxxx",
 "messages": [
 {
 "msgType": "detection.motion.detected",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "channelId": "0",
 "outputData": {
 "extendContext": {
 "handleBit": 1
 }
 },
 "time": 1673406989,
 "localTime": "20230111T111629",
 "alarmId": "116257862023505xxxx",
 "token": "f2dc8c09eeae4b5bad6abf522c93d825",
 "thumbUrl": "https://example.imou.com/pic/thumb.jpg",
 "picUrlArray": ["https://example.imou.com/pic/alarm1.jpg"],
 "labelType": "humanAlarm",
 "feedback": {
 "type": "1",
 "result": ["1"]
 }
 }
 ]
 }
 }
}

错误码

本接口可能返回下列码。

无权事件按条过滤,不因此整单失败。

include 未找到:06.dv20-message.md

device.message.list(查询告警历史)
device.message.detail(查询单条告警)