Getting Started

Installazione

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

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

Poi utilizza la seguente richiesta:

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

Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

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

Importa

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

Requisiti Android

SMS Retriever richiede i servizi Google Play sul dispositivo Android. Il plugin non richiede READ_SMS o RECEIVE_SMS permessi.

La tua SMS di verifica deve includere l'hash dell'app restituito da getHashString(). Genera l'hash per la chiave di firma utilizzata per distribuire l'app. I build debug, release e Play App Signing possono avere hash diversi.

Ascolta una SMS di verifica

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

Stop di guardia

await AndroidSmsRetriever.stopWatch();

Otteni L'Hash Dell'App

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

Utilizza questo hash alla fine del SMS di verifica inviato dal tuo backend.

Richiedi Un Suggerimento Di Numero Di Telefono

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

Android mostra l'interfaccia di utilizzo nativa del numero di telefono e restituisce il numero di telefono selezionato dall'utente.

Esempio SMS

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

Sostituisci l'ultima riga con il codice hash della tua chiave di firma dell'app.

Sostituisci la riga finale con l'hash per la chiave di firma dell'applicazione.

Sottosezione intitolata “Continua da qui: Iniziare” Se stai utilizzando per pianificare il lavoro del plugin nativo, connettilo Utilizzare @capgo/capacitor-retriever dei messaggi SMS per Android Per la capacità nativa in Utilizzo di @capgo/capacitor-android-sms-retriever, Capgo Directory dei Plugin per il workflow del prodotto in Capgo Directory dei Plugin Capacitor Plugin da Capgo per la dettaglio di implementazione in Capacitor Plugin da Capgo Aggiungere o Aggiornare i Plugin per la dettaglio di implementazione in Aggiungere o Aggiornare i Plugin, e Alternative Plugin Enterprise Ionic per il workflow del prodotto in Alternative Plugin Enterprise Ionic.