Android SMS Retriever API for React Native.
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github First commit Jan 6, 2019
android First commit Jan 6, 2019
example [Changed] Version of library Jan 6, 2019
.gitattributes First commit Jan 6, 2019
.gitignore First commit Jan 6, 2019
.npmignore First commit Jan 6, 2019
LICENSE First commit Jan 6, 2019 [Changed] Methods table layout Jan 9, 2019
index.js First commit Jan 6, 2019
package.json [Changed] Package version Jan 8, 2019

Platform License NPM Downloads Gitter


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.

Read Phone Number Read SMS


npm install --save react-native-sms-retriever
react-native link react-native-sms-retriever

If you don't like to use react-native link, check Manual Installation Wiki Page.

Basic Usage

import SmsRetriever from 'react-native-sms-retriever';

// Get the phone number (first gif)
 _onPhoneNumberPressed = async () => {
  try {
    const phoneNumber = await SmsRetriever.requestPhoneNumber();
  } catch (error) {

// Get the SMS message (second gif)
_onSmsListenerPressed = async () => {
  try {
    const registered = await SmsRetriever.startSmsRetriever();
    if (registered) {
      SmsRetriever.addSmsListener(event => {
  } catch (error) {

If you have problems to get the SMS content, check the SMS Rules Wiki Page.


Method Return Description
requestPhoneNumber() Promise<String> Obtain the user's phone number (using the hint picket).
startSmsRetriever() Promise<Boolean> Start to listen for SMS messages.
addSmsListener(event: Function) Promise<Boolean> Get the SMS content with: event.message.
removeSmsListener() Void Stop to listen for SMS messages.

Check the erros of each method on Erros Wiki Page.


A brief summary of each React Native SMS Retriever release can be found on the releases.


This code is distributed under the terms and conditions of the MIT License.

Made with ❤ in Curitiba 🇧🇷