删除告警
删除告警
功能详情
按 alarmId 或时间范围删除。指定 alarmId 时该条无权 → DV2011。按时间范围时只删有权域的事件。两种都没传返回参数错误。
beginTime / endTime 为设备本地时间 yyyyMMdd'T'HHmmss(引号只表示字母 T 是字面量),例如 20201022T000000。不要传 Unix 秒,也不要和校时接口的 UTC 混用。
请求地址
POST https://openapi.lechange.cn/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 与时间范围至少传一种。
网关
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SN1001 | 签名异常 | 按 签名 核对 sign |
TK1002 | token 无效或过期 | 重新获取 token |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1039 | 分钟级限流 | 等到下一分钟再试 |
OP1040 | 调用超限 | 降低频率 |
DV1007 | 设备离线或超时 | 等设备上线 |
DV20xx
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV2001 | propertyId / serviceId / eventId 非法或不在能力目录;或 alarmId 不存在/未映射 | 查告警时 msgType 用目录 eventId;detail 的 alarmId 须来自同账号 list/search 翻页 |
DV2007 | channelId 与 scope 不符 | 通道级必传,设备级不传 |
DV2009 | productId 与设备实际型号不一致 | 去掉 productId 或改成实际型号 |
DV2011 | 无该能力权限 | 见 权限码。list / search 按条过滤无权事件,不因此整单失败 |
DV2012 | 设备不存在 | 核对序列号 |
DV2013 | 设备未绑定 | 先绑定 |