---
name: "SmartAlarmAbility.getBuiltInAlarmList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/panel-sdk", version: "1.8.0" }
title: "getBuiltInAlarmList"
---

## SmartAlarmAbility.getBuiltInAlarmList

> [VERSION] @ray-js/panel-sdk >= 1.8.0

> 💡 Supports single devices only; group environments are not supported. Built-in alarms are configured for the product on the Tuya IoT Platform; users can only enable/disable them and cannot add or delete. Note: The response example is for reference only and includes fields beyond the defined response parameters. Do not use any data other than the parameters defined here; otherwise, it may cause application errors.

### Description

Query the product’s built-in alarm list by device ID

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `devId` | `string` | No | Device ID; if omitted, the current device is used |

### Return Value

Type: `Promise<BuiltInAlarmList>`

Built-in alarm list

### Referenced Types

##### `type` BuiltInAlarmList

```typescript
export type BuiltInAlarmList = BuiltInAlarmRule[];
```

##### `type` BuiltInAlarmRule

| Property | Type | Description |
| --- | --- | --- |
| `auditStatus` | `number` | Review status |
| `boundForPanel` | `boolean` | Whether it is bound to a scene panel |
| `boundForWiFiPanel` | `boolean` | Whether it is bound to a WiFi scene panel |
| `enabled` | `boolean` | Whether enabled |
| `i18nData` | `BuiltInAlarmI18nData` | Multilingual data body |
| `id` | `string` | Rule ID |
| `localLinkage` | `boolean` | Whether it is a local linkage |
| `name` | `string` | Rule name |
| `newLocalScene` | `boolean` | Whether it is an App-controlled local linkage |
| `stickyOnTop` | `boolean` | Whether to display the scene on the home page |

##### `type` BuiltInAlarmI18nData

| Property | Type | Description |
| --- | --- | --- |
| `name` | `AlarmLocaleText` | Multilingual name |
| `content` | `AlarmLocaleText` | Multilingual content |

##### `type` AlarmLocaleText

| Property | Type | Description |
| --- | --- | --- |
| `en` | `string` | English text |
| `zh` | `string` | Chinese text |


### Examples

#### Example

```typescript
const alarmList = await sdm.alarm.getBuiltInAlarmList();
alarmList.forEach(alarm => {
  console.log(alarm.id, alarm.name, alarm.enabled);
});
```