capacitor-sms-retriever

With the SMS Retriever API, you can perform SMS-based user verification in your Android app automatically, without requiring the user to manually type verification codes, and without requiring any extra app permissions.

Install

npm install capacitor-sms-retriever
npx cap sync

API

• getAppSignature()
• requestPhoneNumber()
• startSmsReceiver()
• removeSmsReceiver()
• addListener('onSmsReceive', ...)
• Interfaces

getAppSignature()

getAppSignature() => Promise<AppSignature>

This is a helper method to generate your message hash to be included in your SMS message. Without the correct hash, your app won't receive the message callback. This only needs to be generated once per app and stored.

Note: Do not use hash strings dynamically computed on the client in your verification messages.

Returns: Promise<AppSignature>

Since: 0.1.0

requestPhoneNumber()

requestPhoneNumber() => Promise<HintPhoneNumber>

Initiate hint picker to prompt the user to choose from the phone numbers stored on the device.

Returns: Promise<HintPhoneNumber>

Since: 0.1.0

startSmsReceiver()

startSmsReceiver() => Promise<RegisterReceiver>

Start to listen for SMS messages.

Returns: Promise<RegisterReceiver>

Since: 0.1.0

removeSmsReceiver()

removeSmsReceiver() => Promise<void>

Stop to listen for SMS messages.

Since: 0.1.0

addListener('onSmsReceive', ...)

addListener(eventName: 'onSmsReceive', listenerFunc: (receivedMessage: ReceivedMessage) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for when SMS is coming

| Param | Type | | ------------------ | ----------------------------------------------------------------------------------------- | | eventName | 'onSmsReceive' | | listenerFunc | (receivedMessage: ReceivedMessage) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.1.0

Interfaces

AppSignature

| Prop | Type | Description | Since | | --------------- | ------------------- | -------------- | ----- | | signature | string | App signature. | 0.1.0 |

HintPhoneNumber

| Prop | Type | Description | Since | | ----------------- | ------------------- | -------------------------- | ----- | | phoneNumber | string | Phone number user selected | 0.1.0 |

RegisterReceiver

| Prop | Type | Description | Since | | ------------------ | -------------------- | -------------------------------------------- | ----- | | isRegistered | boolean | Returns if register receiver started or not. | 0.1.0 |

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

ReceivedMessage

| Prop | Type | Description | Since | | ------------- | ------------------- | -------------------------- | ----- | | message | string | Received message with hash | 0.1.0 | | error | string | In case of any error | 0.1.0 |