Getting Started

Ein Setup-Prompt mit den Installations-Schritten und der vollständigen Markdown-Guideline 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';

Anforderungen für Android

SMS-Retriever erfordert Google Play-Dienste auf dem Android-Gerät. Die Erweiterung stellt keine Anfragen oder Berechtigungen ein. READ_SMS Ihr Verifizierungs-SMS muss den vom RECEIVE_SMS Erzeugen Sie den Hash für das Signierungs-Zertifikat, das zum Verteilen der App verwendet wird. Debug-, Release- und Play App Signing-Builds können unterschiedliche Hashes haben.

Ein SMS-Verifizierungscode abrufen getHashString()Abschnitt mit dem Titel “Ein SMS-Verifizierungscode abrufen”

In die Zwischenablage kopieren

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

In die Zwischenablage kopieren

await AndroidSmsRetriever.stopWatch();

Hole Die App-Hash

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

Verwende diese Hash am Ende der Bestätigungsnachricht, die von deinem Backend gesendet wird.

Anfrage Einer 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

Ersetze die letzte Zeile mit der Hash für deine App-Signierungs-Schlüssel.

Bleib weiterhin bei Getting Started

Wenn Sie Getting Started verwenden Getting Started um native Plugin-Arbeit zu planen, verbinden Sie es mit Mit @capgo/capacitor-android-sms-retriever für die native Fähigkeit in Mit @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 von Capgo, Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins, und Ionic Enterprise Plugin Alternativen für das Produktworkflow in Ionic Enterprise Plugin Alternativen.