Inizia a utilizzare

Installa

Puoi utilizzare la nostra configurazione assistita da AI per installare il plugin. Aggiungi le Capgo abilità al tuo strumento di AI utilizzando il seguente comando:

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

Usa poi 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 per Android

Il recuperatore di SMS richiede i servizi Google Play sul dispositivo Android. Il plugin non richiede l'autorizzazione READ_SMS o RECEIVE_SMS i permessi.

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

Ascolta Un 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 osservazione

await AndroidSmsRetriever.stopWatch();

Ottieni L'Hash Dell'Applicazione

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

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

Richiedi un suggerimento del numero di telefono

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

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

Esempio di messaggio SMS

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

Sostituisci la riga finale con l'hash per la chiave di firma del tuo app.

Continua da Iniziare

If sei stai utilizzando Avvio per pianificare il lavoro di plugin nativo, connettilo con Utilizzare @capgo/capacitor-android-sms-retriever per la capacità nativa in Utilizzare @capgo/capacitor-android-sms-retriever, Capgo Directory dei Plugin per il flusso di lavoro 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 Sostituti dei Plugin Enterprise di Ionic per il flusso di lavoro del prodotto in Alternative Plugin Enterprise Ionic.