Getting Started

Instalar

Puedes utilizar nuestra configuración asistida por inteligencia artificial para instalar el complemento. Agrega las Capgo habilidades a tu herramienta de inteligencia artificial utilizando el siguiente comando:

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

Luego utiliza el siguiente prompt:

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

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue 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 de SMS debe incluir el hash de la aplicación devuelto por getHashString(). Genera el hash para la clave de firma utilizada para distribuir la aplicación. Los builds de depuración, de liberación y de 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úal Hash de la Aplicación

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

Utiliza este hash al final del mensaje de verificación SMS enviado por tu backend.

Solicitar un Sugerencia de Número de Teléfono

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

Android muestra la interfaz de usuario nativa de Sugerencia de Número de Teléfono y devuelve el número de teléfono seleccionado por el usuario.

Ejemplo de SMS

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

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

Sigue adelante desde Inicio

Si estás utilizando Inicio 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, Directorio del plugin Capgo para el flujo de trabajo del producto en Directorio del plugin Capgo, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by 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 Alternativas de Plugins de Ionic Enterprise.