getAlarmMessage(查询设备告警消息)
getAlarmMessage:查询设备告警消息
遗留 HTTP 保留: 新接入可使用 告警消息(
device.message.list)对应能力。两套接口不是一对一替代。device.message.*只是相关入口,不是本 HTTP 的一对一替代。
功能说明
获取指定时间段内设备通道的告警消息列表(分页)。
遗留 OpenAPI 分页。能力事件历史见 查询告警历史(
device.message.list)。
请求地址
https://openapi-[DataCenter].easy4ip.com/openapi/getAlarmMessage
请求格式
子账号 token 最低权限
管理员使用自己的 accessToken。子账号须具备 Alarm 权限,资源 URI 为 cam:{deviceId}:{channelId}。详见 权限码。
请求参数
| 参数名 | 参数类型 | 是否必填 | 默认值 | 合法取值 | 参数说明 |
|---|---|---|---|---|---|
| token | String | 是 | 管理员或子账号 accessToken | ||
| deviceId | String | 是 | 设备序列号 | ||
| channelId | String | 是 | 通道号 | ||
| beginTime | String | 是 | 开始时间,yyyy-MM-dd HH:mm:ss | ||
| endTime | String | 是 | 结束时间,yyyy-MM-dd HH:mm:ss | ||
| count | Integer | 否 | 30 | [1,100] | 单次拉取条数,正整数 |
| nextAlarmId | String | 否 | "-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 字段
| 字段名 | 字段类型 | 字段说明 |
|---|---|---|
| count | Integer | 本次返回的告警条数 |
| alarms.token | String | 消息唯一标识,可用于关联云录像查询 |
| alarms.time | Long | 告警时间 UNIX 时间戳(秒) |
| alarms.channelId | String | 通道号 |
| alarms.name | String | 通道名称 |
| alarms.alarmId | Long | 消息 ID |
| alarms.localDate | String | 告警发生时设备本地时间 |
| alarms.type | Integer | 告警类型:0 人体红外;1 动态检测;2 未知告警;3 低电压告警;4 配件人体红外;5 移动传感器移动事件;6 移动传感器长期无移动;7 配件人体红外长期无告警;8 门磁告警;90 报警网关门磁检测;91 报警网关红外检测;92 报警网关低电量;93 报警网关防拆 |
| alarms.deviceId | String | 设备 ID |
| alarms.picurlArray | String[] | 告警图片 URL 列表 |
| alarms.thumbUrl | String | 缩略图 URL |
| nextAlarmId | Long | 当前列表最后一条消息的 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 |
TK1002 | token 无效或过期 | 重新获取 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。
