Getting Started

Instalación

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Entonces utilice la siguiente solicitud:

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

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas del plataforma a continuación:

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

Importar

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

Requisitos de Android

El recuperador de SMS requiere servicios de Google Play en el dispositivo Android. El plugin no solicita READ_SMS o RECEIVE_SMS permisos.

Su mensaje de verificación SMS debe incluir el hash de la aplicación devuelto por getHashString(). Genere el hash para la clave de firma utilizada para distribuir la aplicación. Los builds de depuración, liberación y Play App Signing pueden tener diferentes hashes.

Escuchar un mensaje de verificación de SMS

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

Detener la observación

await AndroidSmsRetriever.stopWatch();

Obtener La Código De La Aplicación

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

Utiliza este código en el final del SMS de verificación enviado por tu backend.

Solicitar Un Sugerencia De Número De Teléfono

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

Muestra el UI de Sugerencia de Número de Teléfono nativo de Android y devuelve el número de teléfono seleccionado por el usuario.

Ejemplo de SMS

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

Reemplaza la última línea con la clave de firma de tu aplicación.

Sigue adelante desde Inicio

Si estás utilizando Getting Started para planificar el trabajo de plugin nativo, conecta con Usando @capgo/capacitor-android-sms-retriever para la capacidad nativa en Usando @capgo/capacitor-android-sms-retriever, Capgo Carpeta de Plugins para el flujo de trabajo del producto en Capgo Carpeta de Plugins Capacitor Plugins por Capgo para el detalle de implementación en Capacitor Plugins por Capgo Agregar o Actualizar Plugins para el detalle de implementación en Agregar o Actualizar Plugins, y Alternativas de Plugins de Ionic Enterprise para el flujo de trabajo del producto en Ionic Enterprise Plugin Alternativas.