# @capgo/capacitor-android-sms-retriever 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/

版本：8\.1\.2
npm 元数据更新时间：2026-10-15T06:20:38.422Z
中文译文更新时间：2026-11-09T03:46:12.461Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-android-sms-retriever
原文对照：https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/?lang=original
项目主页：https://capgo.app/docs/plugins/android-sms-retriever/
源码仓库：https://github.com/Cap-go/capacitor-android-sms-retriever

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：91.1 kB，32 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2026-05-06T06:44:29.047Z
- 最新版本发布：2026-10-15T06:20:37.924Z
- 近 30 天下载量：42982（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

Android SMS Retriever和电话号码Hint APIs的电容插件.

## 安装

```sh
npm install @capgo/capacitor-android-sms-retriever
```

也可以使用：`pnpm add @capgo/capacitor-android-sms-retriever`、`yarn add @capgo/capacitor-android-sms-retriever`、`bun add @capgo/capacitor-android-sms-retriever`

## README

# @capgo/capor-android-sms-retriever (英语)

使用Google Play服务SMS Retriever在未经短信许可的情况下从Android上的短信中读取一次性代码,让用户用Phone Number Hint来取电话号码. 更平滑的登录和核查流量.

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-android-sms-retriever)](https://capgo.app/?ref=plugin_android_sms_retriever)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_android_sms_retriever)

14天无限自由审判. 不需要信用卡

> 🤖 **建筑与AI编码代理?** 安装 [Capgo 技能](https://capgo.app/skills/?ref=plugin_android_sms_retriever) 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 `@capgo/capacitor-android-sms-retriever` 在您的电容应用程序中: `npx skills add Cap-go/capgo-skills`。然后问你的经纪人: _加上@capgo/capor-android-sms-retriever到我的Capacitor应用上并把它接上_ [代理设置指南](https://capgo.app/agents/?ref=plugin_android_sms_retriever) • 妇女 [主机磁共振](https://capgo.app/docs/ai/mcp/?ref=plugin_android_sms_retriever)

![@capgo/capacitor-android-sms-retriever for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-android-sms-retriever/main/assets/github-social-preview.png)

## 主要特点

-   **短消息检索器**数字 : `startWatch()` 等待一个验证短消息和发送 `smsReceived`,与 `smsRetrieverTimeout` 财务报告和审定财务报表 `smsRetrieverError` 事件.
-   **没有短消息权限**: Google Play 服务发送匹配的消息, 所以你不请求 `READ_SMS`。 。 。 .
-   **应用散列**数字 : `getHashString()` 返回您服务器添加到短消息中的11个字符的散列.
-   **电话号码提示**数字 : `getPhoneNumber()` 显示系统拾取器并返回选定的SIM编号.
-   **随时停止**数字 : `stopWatch()` 取消活动监视.
-   **平台**:Android (英语). 仅限Android. iOS和网络不支持.

## 安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

然后使用下列提示:

```text
Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-android-sms-retriever` plugin in my project.
```

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
bun add @capgo/capacitor-android-sms-retriever
bunx cap sync android
```

## 机器人

此插件不请求短消息权限 。 短消息检索使用Google Play服务,并等待一个匹配的验证短消息,最多5分钟.

校验的短消息必须包含 app hash 返回 `getHashString()`。 。 。 .

## 使用量

```typescript
import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';

const { hash } = await AndroidSmsRetriever.getHashString();
console.log('SMS hash:', hash);

const received = await AndroidSmsRetriever.addListener('smsReceived', ({ message }) => {
  console.log('Verification SMS:', message);
});

await AndroidSmsRetriever.addListener('smsRetrieverTimeout', () => {
  console.log('SMS Retriever timed out');
});

await AndroidSmsRetriever.startWatch();

// Later, if needed:
await AndroidSmsRetriever.stopWatch();
await received.remove();
```

```typescript
const { phoneNumber } = await AndroidSmsRetriever.getPhoneNumber();
console.log(phoneNumber);
```

## API 密码

-   [`startWatch()`](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-startwatch)
-   [`stopWatch()`](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-stopwatch)
-   [`getHashString()`](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-gethashstring)
-   [`getPhoneNumber()`](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-getphonenumber)
-   [`addListener('smsReceived', ...)`](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-addlistenersmsreceived-)
-   [`addListener('smsRetrieverTimeout', ...)`](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-addlistenersmsretrievertimeout-)
-   [`addListener('smsRetrieverError', ...)`](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-addlistenersmsretrievererror-)
-   [`removeAllListeners()`](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-removealllisteners)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-type-aliases)

用于Google Play服务SMS Retriever和Phone Number Hint APIs的Android-唯一Capacitor插件.

### 开始监视( C)

```typescript
startWatch() => Promise<StartWatchResult>
```

开始通过Android的"SMS Retriever API"监听一次验证短消息.

Android 在匹配消息到达时或之后自动停止监听 5分钟短消息 恢复时间。 不需要短消息权限 .

**回返情况:** `Promise<[StartWatchResult](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-startwatchresult)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 停止监视( C)

```typescript
stopWatch() => Promise<StopWatchResult>
```

停止运行中的短消息 Retriever 手表,如果有的话.

**回返情况:** `Promise<[StopWatchResult](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-stopwatchresult)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 获取HashString ()

```typescript
getHashString() => Promise<GetHashStringResult>
```

获取已安装的应用程序签名的 11 个字符的 app 散列 .

为用于分发应用程序的签名密钥生成一次并附加它 以校验短消息.

**回返情况:** `Promise<[GetHashStringResult](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-gethashstringresult)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 获取 Phone 数字( )

```typescript
getPhoneNumber() => Promise<GetPhoneNumberResult>
```

显示Android的电话号码Hint UI并返回用户选择的基于SIM的电话号码.

**回返情况:** `Promise<[GetPhoneNumberResult](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-getphonenumberresult)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 添加倾听器( 已接收),...)

```typescript
addListener(eventName: 'smsReceived', listenerFunc: (event: SmsReceivedEvent) => void) => Promise<PluginListenerHandle>
```

聆听在QQlink start Watch 之后收到的验证短消息 .

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'smsReceived'` |
| **`listenerFunc`** | `(event: [SmsReceivedEvent](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-smsreceivedevent)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-pluginlistenerhandle)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 添加倾听器( sms RetrieverTimeout),..

```typescript
addListener(eventName: 'smsRetrieverTimeout', listenerFunc: () => void) => Promise<PluginListenerHandle>
```

听5分钟的短讯检索时间.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'smsRetrieverTimeout'` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-pluginlistenerhandle)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 添加倾听器( ssretriever Error",...)

```typescript
addListener(eventName: 'smsRetrieverError', listenerFunc: (event: SmsRetrieverErrorEvent) => void) => Promise<PluginListenerHandle>
```

在QQlink start Watch 后聆听短消息 Retriever 运行时间错误 .

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'smsRetrieverError'` |
| **`listenerFunc`** | `(event: [SmsRetrieverErrorEvent](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-smsretrievererrorevent)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-pluginlistenerhandle)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 删除所有收听器( )

```typescript
removeAllListeners() => Promise<void>
```

删除此插件的所有注册听众 .

**自:** 8.0.0 (单位:千美元)

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<PluginVersionResult>
```

获取本地 Capacitor 插件版本 .

**回返情况:** `Promise<[PluginVersionResult](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-pluginversionresult)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 接口

#### 开始观察结果

当短消息检索器开始观看时返回结果 .

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`status`** | `[SmsRetrieverStartStatus](https://npmcn.com/package/%40capgo/capacitor-android-sms-retriever/#readme-smsretrieverstartstatus)` | 原生身份由Android返回. | 8.0.0 (单位:千美元) |

#### 停止监视结果

当SMS Retriever观看停止时返回结果 .

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`status`** | `'SMS_RETRIEVER_DONE'` | 原生身份由Android返回. | 8.0.0 (单位:千美元) |

#### 获取 HashString 结果

由QQlink AndroidSmsRetriever Plugin.getHashString}返回结果.

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`hash`** | `string` | 11个字符的应用程序散列,必须附在验证短消息后. | 8.0.0 (单位:千美元) |

#### GetPhone 数字结果

由QQlink AndroidSmstriever Plugin.getPhone Number}返回的结果 .

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`phoneNumber`** | `string` | 电话号码由用户从Android的"电话号码提示UI"中选择. | 8.0.0 (单位:千美元) |

#### 插件听筒

| Prop | 类型 |
| --- | --- |
| **`remove`** | `() => Promise<void>` |

#### 接收事件

SMS Retriever 消息事件有效载荷.

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`message`** | `string` | Android的SMS Retriever API接收到的完整校验短消息. | 8.0.0 (单位:千美元) |

#### Smsretriever 错误事件

SMS Retriever 错误事件有效载荷 .

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`message`** | `string` | Android或Google Play服务返回出错消息. | 8.0.0 (单位:千美元) |

#### 插件变压器

插件版本有效载荷 .

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`version`** | `string` | 版本标识符由平台执行返回. | 8.0.0 (单位:千美元) |

### 类型异名

#### SmsRetriever 开始状态

状态值由 QQlink AndroidSmsRetriever Plugin. start Watch 返回 .

`'SMS_RETRIEVER_STARTED' | 'SMS_RETRIEVER_ALREADY_STARTED'`

## 常见问题

### @capgo/capacitor-android-sms-retriever 是什么？

Android SMS Retriever和电话号码Hint APIs的电容插件\.

### 如何安装 @capgo/capacitor-android-sms-retriever？

在项目目录运行 npm install @capgo/capacitor-android-sms-retriever，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-android-sms-retriever 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capgo/capacitor-android-sms-retriever 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-android-sms-retriever 可以商用吗？

@capgo/capacitor-android-sms-retriever 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-android-sms-retriever 的下载量有多少？

根据 npm 官方下载统计，@capgo/capacitor-android-sms-retriever 在 2026/10/09 – 2026/11/07 这 30 天内被下载 42,982 次，日均约 1,433 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capgo/capacitor-android-sms-retriever 还在维护吗？

最新版本 8\.1\.2 发布于 2026/10/15（25 天前）；至今共发布 16 个版本，其中过去 12 个月发布了 16 个；首次发布于 2026/05/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。