开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
    • 直播地址
    • 推送配置
    • 云存储
    • 资源池额度管理
    • 旧版接口(不再维护)
      • 门锁(遗留)
      • 告警消息(遗留)
        • deleteAlarmMessage(删除设备告警消息)
        • getAlarmMessage(查询设备告警消息)
        • getAlarmMessageById(根据 id 查询告警详情)
      • 设备查询(已弃用)
      • 设备维护(遗留)
      • 设备操作(遗留)
      • 设备使能(遗留)
      • 动检配置(遗留)
      • 收藏点(遗留)
      • 定时巡航(遗留)
      • 本地录像配置(遗留)
      • 音量(遗留)
      • 存储(遗留)
      • 图像与视频(遗留)
      • 时区(遗留)
      • Wi-Fi(遗留)
      • 本地录像查询(遗留)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能说明
请求地址
请求格式
子账号 token 最低权限
请求参数
请求示例
返回 data 字段
响应示例
错误码
相关参考

getAlarmMessage(查询设备告警消息)

getAlarmMessage:查询设备告警消息

遗留 HTTP 保留: 新接入可使用 告警消息(device.message.list)对应能力。两套接口不是一对一替代。 device.message.* 只是相关入口,不是本 HTTP 的一对一替代。

功能说明

获取指定时间段内设备通道的告警消息列表(分页)。

遗留 OpenAPI 分页。能力事件历史见 查询告警历史(device.message.list)。

请求地址

https://openapi-[DataCenter].easy4ip.com/openapi/getAlarmMessage

请求格式

POST JSON 请求体见 请求约定;签名见 签名。

子账号 token 最低权限

管理员使用自己的 accessToken。子账号须具备 Alarm 权限,资源 URI 为 cam:{deviceId}:{channelId}。详见 权限码。

请求参数

参数名参数类型是否必填默认值合法取值参数说明
tokenString是管理员或子账号 accessToken
deviceIdString是设备序列号
channelIdString是通道号
beginTimeString是开始时间,yyyy-MM-dd HH:mm:ss
endTimeString是结束时间,yyyy-MM-dd HH:mm:ss
countInteger否30[1,100]单次拉取条数,正整数
nextAlarmIdString否"-1"""、"-1" 或上次返回的 nextAlarmId下一条告警消息 ID(分页游标)

请求示例

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603350704,
 "nonce":"245db3c7-1689-4893-ac30-cbd7a9d8d153"
 },
 "id":"9f05aa70-91fd-4d35-8b06-cd2ece55346b",
 "params":{
 "count":"10",
 "beginTime":"2020-10-22 00:00:00",
 "endTime":"2020-10-22 23:59:59",
 "deviceId":"TESTQWERXXXX",
 "channelId":"0",
 "nextAlarmId":"-1",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

返回 data 字段

字段名字段类型字段说明
countInteger本次返回的告警条数
alarms.tokenString消息唯一标识,可用于关联云录像查询
alarms.timeLong告警时间 UNIX 时间戳(秒)
alarms.channelIdString通道号
alarms.nameString通道名称
alarms.alarmIdLong消息 ID
alarms.localDateString告警发生时设备本地时间
alarms.typeInteger告警类型:0 人体红外;1 动态检测;2 未知告警;3 低电压告警;4 配件人体红外;5 移动传感器移动事件;6 移动传感器长期无移动;7 配件人体红外长期无告警;8 门磁告警;90 报警网关门磁检测;91 报警网关红外检测;92 报警网关低电量;93 报警网关防拆
alarms.deviceIdString设备 ID
alarms.picurlArrayString[]告警图片 URL 列表
alarms.thumbUrlString缩略图 URL
nextAlarmIdLong当前列表最后一条消息的 ID,用于下次分页

响应示例

{
 "result":{
 "msg":"操作成功.",
 "code":"0",
 "data":{
 "alarms":[
 {
 "alarmId":"1726360834259136",
 "name":"TP1S-1842",
 "time":1603350842,
 "localDate":"2020-10-22 15:14:02",
 "type":"1",
 "thumbUrl":"https://storage.example.com/alarm/07540ab39e82488490b232977c333c9e_0_thumb.dav?Expires=1603437367&AccessKeyId=EXAMPLE&Signature=EXAMPLE",
 "deviceId":"TESTQWERXXXX",
 "picurlArray":[
 "https://storage.example.com/alarm/07540ab39e82488490b232977c333c9e_0.jpg?Expires=1603437367&AccessKeyId=EXAMPLE&Signature=EXAMPLE"
 ],
 "channelId":"0",
 "token":"07540ab39e82488490b232977c333c9e"
 },
 {
 "alarmId":"1726360340019392",
 "name":"TP1S-1842",
 "time":1603350721,
 "localDate":"2020-10-22 15:12:01",
 "type":"1",
 "thumbUrl":"https://storage.example.com/alarm/ccea3589e6484646b0bc9f97f45dd8c5_0_thumb.dav?Expires=1603437367&AccessKeyId=EXAMPLE&Signature=EXAMPLE",
 "deviceId":"TESTQWERXXXX",
 "picurlArray":[
 "https://storage.example.com/alarm/ccea3589e6484646b0bc9f97f45dd8c5_0.jpg?Expires=1603437367&AccessKeyId=EXAMPLE&Signature=EXAMPLE"
 ],
 "channelId":"0",
 "token":"ccea3589e6484646b0bc9f97f45dd8c5"
 }
 ],
 "count":2,
 "nextAlarmId":1726360340019392
 }
 },
 "id":"9f05aa70-91fd-4d35-8b06-cd2ece55346b"
}

错误码

本接口可能返回下列码;完整分组见 错误码 与 能力错误码。

网关与鉴权(SN / TK / OP)

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

更多见 错误码 · OP/SN/TK。

子账号(SUB)

错误码错误码说明下一步
SUB1001–SUB1002子账号无接口权限在 addPolicy 中补策略
SUB1005子账号 token 过期重新 subAccountToken
SUB1006子账号与设备无授权核对 Resource 与设备序列号
SUB1008子账号未绑定应用先创建并绑定子账号

更多见 错误码 · SUB。

设备访问与通道(DV10xx)

错误码错误码说明下一步
DV1007设备离线或超时等设备上线
DV1009设备正忙稍后重试
DV1012分享/授权设备权限不足核对子账号 Permission / Resource
DV1019能力集不支持确认型号与能力列表
DV1020通道离线检查通道状态
DV1026不支持此功能换接口或升级固件
DV1028未绑定或通道不存在核对 deviceId / channelId

更多见 错误码 · DV。

相关参考

  • 开发规范
  • 公共约定
  • 本模块索引
deleteAlarmMessage(删除设备告警消息)
getAlarmMessageById(根据 id 查询告警详情)