@capgo/capacitor-android-sms-retriever

Overview

Start the retriever, listen for smsReceived, extract the numeric OTP from the SMS body, and verify the trailing 11 character app hash your server appends for the Retriever API.

Platform support

Platform	Support	Notes
iOS	No	Use autofill or passkeys
Android	Yes	SMS Retriever API
Web	No	Not applicable

Core Capabilities

• startWatch - Start a five-minute SMS Retriever watch for one verification SMS.
• stopWatch - Stop the active SMS Retriever watch.
• getHashString - Read the 11-character app hash used in verification SMS messages.
• getPhoneNumber - Open Android Phone Number Hint and return the selected phone number.
• smsReceived - Listen for the retrieved verification SMS.
• smsRetrieverTimeout - Listen for the five-minute timeout.
• smsRetrieverError - Listen for runtime errors from Android or Google Play services.

Platform Support

Platform	Support
Android	Supported
iOS	Unsupported stub
Web	Unsupported stub

Public API

Method	Description
startWatch	Start listening for one verification SMS.
stopWatch	Stop the active watch.
getHashString	Return the 11-character app hash.
getPhoneNumber	Show Phone Number Hint and return the selected number.
addListener('smsReceived', ...)	Receive the retrieved SMS payload.
addListener('smsRetrieverTimeout', ...)	Handle timeout events.
addListener('smsRetrieverError', ...)	Handle retriever errors.
getPluginVersion	Return the native plugin version.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-android-sms-retriever.

Keep going from @capgo/capacitor-android-sms-retriever

If you are using @capgo/capacitor-android-sms-retriever to plan native plugin work, connect it with Using @capgo/capacitor-android-sms-retriever for the native capability in Using @capgo/capacitor-android-sms-retriever, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, and Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives.