Getting Started

Eine Einrichtungsanfrage mit den Installationsanweisungen und der vollständigen Markdown-Dokumentation für diesen Plugin kopieren.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-android-sms-retriever`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/android-sms-retriever/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installieren

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

Importieren

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

Android-Anforderungen

SMS-Retriever erfordert Google Play-Dienste auf dem Android-Gerät. Der Plugin stellt keine Anfragen oder Berechtigungen ein. Ihre Verifizierungs-SMS muss den von READ_SMS erhaltenen App-Hash enthalten. Generieren Sie den Hash für das Signaturschlüsselpaar, das zum Verteilen der App verwendet wird. Debug-, Release- und Play App Signing-Builds können unterschiedliche Hashes haben. RECEIVE_SMS Für eine Verifizierungs-SMS lauschen

Abschnitt mit dem Titel „Für eine Verifizierungs-SMS lauschen“ getHashString()Zur Zwischenablage kopieren

Beobachtung beenden

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

Beobachtung beenden

await AndroidSmsRetriever.stopWatch();

App-Hash erhalten

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

Verwenden Sie diesen Hash am Ende der Bestätigungsnachricht, die Ihr Backend sendet.

Anfrage für eine Telefonnummer-Hinweis

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

Android zeigt die native Telefonnummer-Hinweis-Oberfläche an und gibt die vom Benutzer ausgewählte Telefonnummer zurück.

Beispiel-SMS

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

Ersetzen Sie die letzte Zeile mit dem Hash für Ihre App-Signierungsschlüssel.

Weitergehen von Getting Started

Wenn Sie native Plugin-Arbeit planen, verbinden Sie es mit Getting Started um native Plugin-Arbeit zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-android-sms-retriever für die native Fähigkeit in Verwenden Sie @capgo/capacitor-android-sms-retriever Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins durch Capgo, Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins und Alternativen zu Ionic Enterprise Plugins für das Produktworkflow in Alternativen zu Ionic Enterprise Plugins.