Démarrage

Installer

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

Importer

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

Exigences d'Android

SMS Retriever nécessite les services Google Play sur le dispositif Android. Le plugin ne demande pas READ_SMS ou RECEIVE_SMS les permissions.

Votre SMS de vérification doit inclure l'empreinte de l'application retournée par getHashString(). 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.

Écoutez Un SMS De Vérification

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

Arrêter de regarder

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 backend.

Demander Un Aide À Numéro De Téléphone

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

Sur Android, l'interface utilisateur native de l'aide au numéro de téléphone est affichée et le numéro de téléphone sélectionné par l'utilisateur est retourné.

Exemple De SMS

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

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