device.message.delete(删除告警)
device.message.delete:删除告警
功能详情
按 alarmId 或时间范围删除能力事件历史。指定 alarmId 时该条无权 → DV2011。按时间范围时只删有权域的事件。未传 alarmId 且未传完整 beginTime/endTime 时间窗 → DV2001。
仅 legacy alarm / deviceStatus 推送、未入库为能力事件历史的报文,不能通过本接口删除;见 接收设备消息。
beginTime / endTime 为设备本地时间 yyyyMMdd'T'HHmmss(引号只表示字母 T 是字面量),例如 20201022T000000。不要传 Unix 秒,也不要和校时接口的 UTC 混用。
请求地址
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.message.delete
最小权限
管理员操作自己绑定的设备不需要权限。操作被分享设备需要报警消息权限。子用户绑定不需要。子账号按条校验事件所属能力的 share/sub 权限码(见 权限码)。按条删除无权返回 DV2011;按时间范围只删有权事件,不因此整单 DV2011。设备须已绑定。
传入参数说明
| 参数名 | 参数类型 | 是否必填 | 默认值 | 合法值 | 参数说明 |
|---|---|---|---|---|---|
token | String | 是 | 管理员、子用户或子账号 accessToken | ||
deviceId | String | 是 | 设备序列号 | ||
productId | String | 否 | 可省略。传了且与该设备实际型号不一致 → DV2009 | ||
channelId | String | 否 | 通道号,IPC 常见 "0"。不要传 -1 | 不传只删设备级;传只删该通道 | |
alarmId | String | 条件 | 按条删除时必填 | ||
beginTime | String | 条件 | 设备本地 yyyyMMddTHHmmss | 无 alarmId 时必填 | |
endTime | String | 条件 | 设备本地 yyyyMMddTHHmmss | 无 alarmId 时必填 |
样例输入
{
"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",
"alarmId": "116257862023505xxxx"
}
}
按时间范围删除时不传 alarmId,改为传 beginTime / endTime(及可选 channelId)。
返回 data 字段说明
无业务字段。成功时 code 为 "0",data 为 {}。
样例输出
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {}
}
}
错误码
本接口可能返回下列码。
未传 alarmId 且时间窗不完整 → DV2001(见上)。alarmId 与时间范围至少传一种。
include 未找到:06.dv20-message.md
