Erste Schritte

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

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

Nutze dann diesen Prompt:

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

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

npm install @capgo/capacitor-android-sms-retriever
npx cap sync android

Quickstart

Auf die einmalige SMS warten, das OTP extrahieren und den Retriever starten, bevor der Nutzer einen code anfordert.

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

const smsListener = await AndroidSmsRetriever.addListener('smsReceived', ({ message }) => {
  const code = message.match(/\b\d{4,8}\b/)?.[0];
  if (code) submitCode(code);
  // The SMS also ends with your 11-character app hash; validate it separately from the OTP.
});

await AndroidSmsRetriever.startWatch();

// When the flow completes:
await smsListener.remove();
await AndroidSmsRetriever.stopWatch();

Häufige Stolperfallen

• Hash: SMS-Templates müssen den App-Retriever-Hash enthalten.
• Timeout: Watch neu starten, wenn Nutzer einen neuen code anfordern.
• Play Services: auf dem Gerät erforderlich.

Importieren

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

Android-Voraussetzungen

SMS Retriever benötigt Google Play Services auf dem Android-Gerät. Das Plugin fordert keine READ_SMS oder RECEIVE_SMS Berechtigungen an.

Deine Verifizierungs-SMS muss den App-Hash enthalten, der von getHashString()zurückgegeben wird. Generiere den Hash für den Signing-Key, mit dem die App verteilt wird. Debug-, Release- und Play App Signing-Builds können unterschiedliche Hashes haben.

Auf Verifizierungs-SMS warten

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

Überwachung stoppen

await AndroidSmsRetriever.stopWatch();

App-Hash abrufen

const { hash } = await AndroidSmsRetriever.getHashString();
console.log(hash);

Verwende diesen Hash am Ende der Verifizierungs-SMS, die dein Backend sendet.

Telefonnummer-Hinweis anfordern

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

Android zeigt das native Phone Number Hint UI an und gibt die vom Nutzer gewählte Telefonnummer zurück.

Beispiel-SMS

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

Ersetze die letzte Zeile durch den Hash deines App-Signing-Keys.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte Um die Arbeit an nativen Plugins zu planen, verbinde sie mit @capgo/capacitor-android-sms-retriever verwenden für die native Funktion in Using @capgo/capacitor-android-sms-retriever, Capgo Plugin-Verzeichnis für den Produkt-Workflow im Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo für das Implementierungsdetail in Capacitor Plugins von Capgo, Plugins hinzufügen oder aktualisieren für das Implementierungsdetail beim Hinzufügen oder Aktualisieren von Plugins, und Ionic Enterprise Plugin-Alternativen für den Produkt-Workflow bei den Ionic Enterprise Plugin-Alternativen.