Getting Started

Installer

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

Importer

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

Exigences Android

Le récupérateur de SMS nécessite les services Google Play sur le dispositif Android. Le plugin n'obtient pas les permissions. READ_SMS Votre SMS de vérification doit inclure l'empreinte de l'application retournée par RECEIVE_SMS Générez l'empreinte pour la clé de signature utilisée pour distribuer l'application. Les builds Debug, release et Play App Signing peuvent avoir des empreintes différentes.

Écouter Un SMS De Vérification getHashString()Section intitulée « Écouter Un SMS De Vérification »

Copier dans le presse-papier

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

Copier dans le presse-papier

await AndroidSmsRetriever.stopWatch();

Obtenez L'Hash De L'Application

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

Utilisez cet hash à la fin du SMS de vérification envoyé par votre serveur backend.

Demander Un Aide-Mémoire De Numéro De Téléphone

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

L'Android affiche l'interface utilisateur native de l'Aide-Mémoire De Numéro De Téléphone et retourne le numéro de téléphone sélectionné par l'utilisateur.

Exemple De SMS

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

Remplacez la dernière ligne par l'hash de la clé de signature de votre application.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier le travail de plugin natif, connectez-le avec En utilisant @capgo/capacitor-android-sms-retriever pour la capacité native dans En utilisant @capgo/capacitor-android-sms-retriever, Répertoire de plugin Capgo pour le flux de travail du produit dans Répertoire de plugin Capgo, Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans l'ajout ou la mise à jour de plugins, et Alternatives de plugins d'entreprise Ionic pour le flux de travail du produit dans les alternatives de plugins d'entreprise Ionic.