---
name: "getDoorbellService"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "getDoorbellService - Get doorbell notification service information."
summary: "Get doorbell notification service information."
---

## getDoorbellService

> [VERSION] @ray-js/lock-sdk >= 1.0.0

### Description

Get doorbell notification service info

### Parameters

None


### Return Value

Type: `Promise<LinkageRule>`

Doorbell linkage rule summary (truthy when rules exist; detail fields returned by the cloud)

##### LinkageRule

| Property | Type | Description |
| --- | --- | --- |
| `background` | `string` |  |
| `code` | `string` |  |
| `description` | `string` |  |
| `displayColor` | `string` |  |
| `icon` | `string` |  |
| `order` | `number` |  |
| `title` | `string` |  |
| `ruleId` | `string` |  |
| `ruleVO` | `Object` |  |

##### LinkageRule.ruleVO properties

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `actions` | `Object[]` | Yes | - |  |
| `auditStatus` | `number` | Yes | - |  |
| `boundForPanel` | `boolean` | Yes | - |  |
| `boundForWiFiPanel` | `boolean` | Yes | - |  |
| `code` | `string` | Yes | - |  |
| `commonField` | `string` | Yes | - |  |
| `conditions` | `Object[]` | Yes | - |  |
| `containDeviceDelete` | `boolean` | Yes | - |  |
| `coverIcon` | `string` | Yes | - |  |
| `description` | `string` | Yes | - |  |
| `disableTime` | `number` | Yes | - |  |
| `displayColor` | `string` | Yes | - |  |
| `enabled` | `boolean` | Yes | - |  |
| `forceCloudTrigger` | `boolean` | Yes | - |  |
| `gmtCreate` | `number` | Yes | - |  |
| `gmtModified` | `number` | Yes | - |  |
| `id` | `string` | Yes | - |  |
| `iotAutoAlarm` | `boolean` | Yes | - |  |
| `isAlarmIssue` | `boolean` | Yes | - |  |
| `isLogicRule` | `boolean` | Yes | - |  |
| `linkageType` | `number` | Yes | - |  |
| `localLinkage` | `boolean` | Yes | - |  |
| `matchType` | `number` | Yes | - |  |
| `name` | `string` | Yes | - |  |
| `needCleanGidSid` | `boolean` | Yes | - |  |
| `needValidOutOfWork` | `boolean` | Yes | - |  |
| `newLocalScene` | `false` | Yes | - |  |
| `offGwSync` | `boolean` | Yes | - |  |
| `offGwSyncSuccess` | `boolean` | Yes | - |  |
| `orderWeight` | `number` | Yes | - |  |
| `outOfWork` | `number` | Yes | - |  |
| `ownerId` | `string` | Yes | - |  |
| `panelType` | `number` | Yes | - |  |
| `permissionCode` | `string` | Yes | - |  |
| `ruleGenre` | `number` | Yes | - |  |
| `ruleSource` | `number` | Yes | - |  |
| `ruleType` | `number` | Yes | - |  |
| `scenarioRule` | `boolean` | Yes | - |  |
| `status` | `true` | Yes | - |  |
| `stickyOnTop` | `false` | Yes | - |  |
| `subMatchType` | `number` | Yes | - |  |


##### LinkageRule.ruleVO.actions[] properties

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `actionExecutor` | `string` | Yes | - |  |
| `actionStrategy` | `string` | Yes | - |  |
| `attribute` | `number` | Yes | - |  |
| `devDelMark` | `boolean` | Yes | - |  |
| `enabled` | `boolean` | Yes | - |  |
| `entityId` | `string` | Yes | - |  |
| `executorProperty` | `Object` | Yes | - |  |
| `extraProperty` | `Object` | Yes | - |  |
| `gmtModified` | `number` | Yes | - |  |
| `id` | `string` | Yes | - |  |
| `offGwSync` | `boolean` | Yes | - |  |
| `orderNum` | `number` | Yes | - |  |
| `ruleId` | `string` | Yes | - |  |
| `status` | `boolean` | Yes | - |  |


##### LinkageRule.ruleVO.actions[].executorProperty properties

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `topic` | `string` | Yes | - |  |
| `customParameters` | `Record<string, any>` | Yes | - |  |


##### LinkageRule.ruleVO.actions[].extraProperty properties

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `entityName` | `string` | Yes | - |  |
| `iconUrl` | `string` | Yes | - |  |
| `statusDescript` | `string` | Yes | - |  |
| `type` | `string` | Yes | - |  |


##### LinkageRule.ruleVO.conditions[] properties

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `attribute` | `number` | Yes | - |  |
| `condType` | `number` | Yes | - |  |
| `devDelMark` | `boolean` | Yes | - |  |
| `enabled` | `boolean` | Yes | - |  |
| `entityId` | `string` | Yes | - |  |
| `entityName` | `string` | Yes | - |  |
| `entitySubIds` | `string` | Yes | - |  |
| `entityType` | `number` | Yes | - |  |
| `expr` | `any[]` | Yes | - |  |
| `exprDisplay` | `"远程开锁 : Unlock"` | Yes | - |  |
| `extraInfo` | `Record<string, any>` | Yes | - |  |
| `handleStrategy` | `string` | Yes | - |  |
| `iconUrl` | `string` | Yes | - |  |
| `id` | `string` | Yes | - |  |
| `orderNum` | `number` | Yes | - |  |
| `ruleId` | `string` | Yes | - |  |
| `serviceProvider` | `string` | Yes | - |  |
| `support` | `number` | Yes | - |  |


### Examples

#### Example

```ts
import { getDoorbellService } from '@ray-js/lock-sdk';
const service = await getDoorbellService();
```