Getting Started
Copie un prompt de configuración con los pasos de instalación y la guía de markdown completa para este plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-android-sms-retriever`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/android-sms-retriever/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Instalar
Sección titulada “Instalar”bun add @capgo/capacitor-android-sms-retrieverbunx cap sync androidImportar
Sección titulada “Importar”import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';Requisitos de Android
Sección titulada “Requisitos de Android”SMS Retriever 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, liberación y Play App Signing pueden tener diferentes hashes.
Escuchar Un Mensaje de Verificación de SMS
Sección titulada “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
Sección titulada “Detener la observación”await AndroidSmsRetriever.stopWatch();Obtén La Cifra De La Aplicación
Sección titulada “Obtén La Cifra De La Aplicación”const { hash } = await AndroidSmsRetriever.getHashString();console.log(hash);Utiliza esta cifra al final del mensaje de verificación SMS enviado por tu backend.
Solicita Un Sugerimiento De Número De Teléfono
Sección titulada “Solicita Un Sugerimiento De Número De Teléfono”const { phoneNumber } = await AndroidSmsRetriever.getPhoneNumber();console.log(phoneNumber);Android muestra la interfaz de usuario nativa de Sugerimiento De Número De Teléfono y devuelve el número de teléfono seleccionado por el usuario.
Mensaje De Ejemplo
Sección titulada “Mensaje De Ejemplo”<#> 123456 is your verification code.FA+9qCX9VSuReemplaza la última línea con la cifra de la clave de firma de tu aplicación.
Sigue adelante desde Inicio rápido
Sección titulada “Sigue adelante desde Inicio rápido”Si estás utilizando Inicio rápido 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 de Plugins de Capgo para el flujo de trabajo del producto en Directorio de Plugins de Capgo, Plugins de Capacitor por Capgo para el detalle de implementación en Plugins de Capacitor por Capgo, Agregar o Actualizar Plugins para los detalles 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.