---
name: "getRemainingInfo"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "getRemainingInfo - 获取剩余通知次数。"
summary: "获取剩余通知次数。"
---

## getRemainingInfo

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

### 描述

获取剩余通知次数

### 参数

无


### 返回值

类型: `Promise<RemainingInfo>`

剩余短信与语音通知次数

##### RemainingInfo

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `message` | `number` | 剩余短信通知次数 |
| `phone` | `number` | 剩余语音通知次数 |

### 示例代码

#### 示例

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