告警

本文介绍了当前设备的所有报警操作。

注意：
1.如需使用告警接口请先为产品配置告警，具体操作参见设置告警。
2.使用 commonApi 需先安装依赖，点击此处安装依赖。

查询告警列表信息

名称

getDevAlarmList

描述

根据设备 ID 查询告警列表信息。

请求参数

参数	数据类型	说明	是否必填
devId	String	设备 ID	是

返回参数

参数	数据类型	说明
auditStatus	Number	审核状态
boundForPanel	Boolean	是否被场景面板绑定
boundForWiFiPanel	Boolean	是否被WIFI场景面板绑定
enabled	Boolean	是否启用
i18nData	{ name: { en: string; zh: string }	多语言数据体
id	String	规则ID
localLinkage	Boolean	是否为本地联动
name	String	规则名称
newLocalScene	Boolean	是否为APP管控本地联动
stickyOnTop	Boolean	场景是否显示在首页

请求示例

import { commonApi } from '@tuya/tuya-panel-api';

commonApi.alarmApi
  .getDevAlarmList(TYSdk.devInfo.devId)
  .then(response => {
    console.log(response);
    console.log(JSON.stringify(response));
  })
  .catch();

返回示例

{
     "auditStatus": 1,
     "boundForPanel": false,
     "boundForWiFiPanel": false,
     "enabled": true,
     "i18nData": {"name": { "en": "", "zh": "" }, "content": { "en": "", "zh": "" }},
     "id": "35ix",
     "iotAutoAlarm": false,
     "isLogicRule": false,
     "localLinkage": false,
     "name": "Wi-Fi 人体红外报警",
     "newLocalScene": false,
     "stickyOnTop": false
  }

启用或者禁用设备的告警

名称

setAlarmSwitch

描述

启用或者禁用设备的告警。

请求参数

参数	数据类型	说明	是否必填
devId	String	设备 ID	是
disabled	Boolean	是否禁用	否
ruleIds	String	规则 ID 串	是

返回参数

参数	数据类型	说明
response	Boolean	是否成功启用或者禁用设备的告警

请求示例

import { commonApi } from '@tuya/tuya-panel-api';

commonApi.alarmApi
  .setAlarmSwitch({
    devId: 'vdevo159297901023732',
    disabled: true, // 告警全部开启时，参数值为 false
    ruleIds: '3TIXnerlNHeJAugm,8skS74SGlVkwSdbD', // 告警全部开启时，该字段为空字符串
  })
  .then(response => {
    console.log(response);
    console.log(JSON.stringify(response));
  })
  .catch();

返回示例

true