Getting Started

Install

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

Import

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

Android Requirements

SMS Retriever 需要在 Android 设备上安装 Google Play 服务。该插件不请求任何权限。 READ_SMS Your 验证 SMS 必须包含由 RECEIVE_SMS 生成用于分发应用的签名密钥的哈希值。 Debug、release 和 Play App Signing 构建可以具有不同的哈希值。

监听验证 SMS getHashString()复制到剪贴板

停止观看

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();

SMS Retriever 需要在 Android 设备上安装 Google Play 服务。该插件不请求任何权限。

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

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

继续从 Getting Started

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