cordova-plugin-otp-autofill

Description

This plugin extracts the OTP of required length from the received SMS.

Installation

cordova plugin add cordova-plugin-otp-autofill

Supported Platforms

• Android

Usage

    var options = {
        otpLength: 4,
        delimiter: 'is',
        senderID: 'WAYSMS',
        timeout: 60
        }

    smsOtpAutofill.startOTPListener(successCallback,errorCallback,options);

Function Parameters

• successCallback: This callback function is executed when OTP is extracted successfully.
• errorCallback: This callback function is executed if an error occurs (eg. when options are empty or sms permissions are denied).
• options: the OTP options

Example

    var options = {
        otpLength: 4,
        delimiter: 'is',
        senderID: 'WAYSMS',
        timeout: 60
        }
        
    function successCallback(result) {

      if(result === 'Resend OTP') {

          smsOtpAutofill.startOTPListener(successCallback,errorCallback,options);

      } else {
      
      	//Set the result (OTP value) to the field
        
      }

    }


    function errorCallback(message) {

    }
    
    smsOtpAutofill.startOTPListener(successCallback,errorCallback,options);

OTP options

Parameters to customize the retrieval of the OTP.

 { otpLength: 4, delimiter: 'is', senderID: 'WAYSMS', timeout: 60}

Options

• delimiter: This is the text which appears just before the OTP in the SMS content. For example, if the SMS content is 'Your OTP is 6367' , then delimiter should be set to 'is'. The delimiter can also be set with an empty value , incase if the SMS content starts with the OTP. For example, if the SMS content is '6367 is your one time password', then the delimiter should be set to ' '. (String)

• length: This is the length of the OTP to be extracted from the SMS. For example, if the SMS content is 'Your OTP is 6367', the length should be set to 4. (Number)

• senderID: This is the 6-character sender ID of the received SMS. For example, if the sender name of the received SMS is 'QP-WAYSMS' , then the senderID should be set to 'WAYSMS'. Incase if the message is sent without a SMS service provider, senderID should be set to the 10-digit mobile number of the sender. (String)

• timeout: This is time (in seconds) until which the plugin listens for the SMS. For example, if the timeout is set to 60, then the plugin waits for 60 seconds to receive the SMS and extract the OTP. If the SMS is not received in 60 seconds, then the plugin returns a 'Resend OTP' message. (Number)