Accueil

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Utilisez ensuite la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques au plateforme ci-dessous :

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

Importer

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

Exigences d'Android

Le récupérateur de SMS nécessite les services Google Play sur le dispositif Android. Le plugin n'obtient 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 de la clé de signature utilisée pour distribuer l'application. Les builds de débogage, de publication et de Play App Signing peuvent avoir des empreintes différentes.

Écouter 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êtez de regarder

await AndroidSmsRetriever.stopWatch();

Obtenez l'empreinte de l'application

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

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

Demander un indice de numéro de téléphone

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

Android affiche l'interface utilisateur native de l'indice 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 la clé de signature de votre application.

Continuez de la section « Démarrage »

Si vous utilisez Démarrage pour planifier le travail de plugin natif, connectez-le à Utilisation de @capgo/capacitor-android-sms-retriever pour la capacité native dans Utilisation de @capgo/capacitor-android-sms-retriever, Capgo Répertoire de plugin pour le flux de travail du produit dans Capgo Répertoire de plugin, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Ajouter ou Mettre à Jour des Plugins pour le détail d'implémentation dans Ajouter ou Mettre à Jour des Plugins, et Alternatives de Plugins Entreprise Ionic pour le flux de travail du produit dans Alternatives de Plugins Entreprise Ionic.