跳过内容

开始

GitHub

您可以使用我们的 AI-Assisted Setup 来安装插件。将 Capgo 技能添加到您的 AI 工具中,使用以下命令:

终端窗口
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示:

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

如果您更喜欢手动设置,请按照以下命令安装插件并遵循以下平台特定的说明:

终端窗口
bun add @capgo/capacitor-android-sms-retriever
bunx cap sync android

导入

导入
import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';

Android 要求

Android 要求

SMS Retriever 需要在 Android 设备上安装 Google Play 服务。该插件不会请求 READ_SMSRECEIVE_SMS 需要 Google Play 服务才能在 Android 设备上使用。该插件不会请求

权限。 getHashString()您的验证短信必须包含由返回的应用程序哈希生成的应用程序哈希。 生成用于分发应用程序的签名密钥的哈希。 Debug、Release 和 Play App Signing 构建可以具有不同的哈希。

等待验证短信

标题:等待验证短信
import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';
const received = await AndroidSmsRetriever.addListener('smsReceived', ({ message }) => {
const code = message.match(/\b\d{6}\b/)?.[0];
console.log('Verification code:', code);
});
const timeout = await AndroidSmsRetriever.addListener('smsRetrieverTimeout', () => {
console.log('SMS Retriever timed out');
});
const errors = await AndroidSmsRetriever.addListener('smsRetrieverError', ({ message }) => {
console.error('SMS Retriever error:', message);
});
await AndroidSmsRetriever.startWatch();
// Remove listeners when the verification flow is done.
await received.remove();
await timeout.remove();
await errors.remove();
await AndroidSmsRetriever.stopWatch();

获取应用程序哈希

标题:获取应用程序哈希
const { hash } = await AndroidSmsRetriever.getHashString();
console.log(hash);

在您的后端发送的验证短信末尾使用此哈希。

请求电话号码提示

标题:请求电话号码提示
const { phoneNumber } = await AndroidSmsRetriever.getPhoneNumber();
console.log(phoneNumber);

Android会显示原生电话号码提示UI并返回用户选择的电话号码。

<#> 123456 is your verification code.
FA+9qCX9VSu

将最后一行替换为您的应用签名密钥的哈希值。

如果您正在使用 开始 来规划原生插件工作,连接它与 使用@capgo/capacitor-android-sms-retriever 为使用@capgo/capacitor-android-sms-retriever的原生能力 Capgo 插件目录 为Capgo插件目录中的产品工作流 Capacitor由Capgo提供的插件 为Capacitor由Capgo提供的插件中的实现细节 添加或更新插件 为添加或更新插件中的实现细节,并 Ionic企业插件替代品 为Ionic企业插件替代品中的产品工作流