Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

npm install @capgo/capacitor-android-sms-retriever
npx cap sync android

Démarrage rapide

Écoutez le SMS à usage unique, extrayez l'OTP, puis lancez le retriever avant que l'utilisateur ne demande un code.

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

const smsListener = await AndroidSmsRetriever.addListener('smsReceived', ({ message }) => {
  const code = message.match(/\b\d{4,8}\b/)?.[0];
  if (code) submitCode(code);
  // The SMS also ends with your 11-character app hash; validate it separately from the OTP.
});

await AndroidSmsRetriever.startWatch();

// When the flow completes:
await smsListener.remove();
await AndroidSmsRetriever.stopWatch();

Erreurs courantes

• Hash: Les templates SMS doivent inclure le hash du retriever de l'application.
• Timeout: restart watch when users request a new code.
• Play services: requis sur l'appareil.

Importer

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

Prérequis Android

SMS Retriever nécessite les services Google Play sur l'appareil Android. Le plugin ne demande pas de READ_SMS ou RECEIVE_SMS permissions.

Votre SMS de vérification doit inclure le hash de l'application renvoyé par getHashString(). Générez le hash pour la clé de signature utilisée pour distribuer l'application. Les builds de debug, de release et de Play App Signing peuvent avoir des hash différents.

É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êter l'écoute

await AndroidSmsRetriever.stopWatch();

Récupérer le hash de l'application

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

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

Demander une suggestion de numéro de téléphone

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

Android affiche l'interface native Phone Number Hint et renvoie 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 le hash de la clé de signature de votre application.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier le travail sur les plugins natifs, connectez-l’à Utilisation de @capgo/capacitor-android-sms-retriever pour la capacité native dans l'utilisation de @capgo/capacitor-android-sms-retriever, Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajout ou mise à jour de plugins, et Alternatives aux plugins Ionic Enterprise pour le workflow produit dans Alternatives aux plugins Ionic Enterprise.