Send OTP JavaScript SDK

The SendOtp SDK makes verifying OTP easy. It supports OTP verification via SMS, Calls, Email & WhatsApp.

🚀 Works with any JavaScript environment – Ionic, NativeScript,Cordova etc.

Getting Started

Create an account at MSG91 to use SendOTP services.

Get your widgetId and authToken

1. Log in to MSG91 and go to the OTP section.
2. Create & configure your OTP widget.
3. Generate an authToken and enable it.
4. Copy your widgetId and authToken for SDK initialization.

Note: To ensure that this SDK functions correctly within your mobile application, please enable Mobile Integration while configuring the widget.

Installation

npm install @msg91comm/sendotp-sdk

Usage

import { OTPWidget } from "@msg91comm/sendotp-sdk";

const widgetId = "3461******************38";
const authToken = "125*******************TP1";

OTPWidget.initializeWidget(widgetId, authToken);

//It's recommended to initialize the widget inside useEffect when the screen mounts. 
  This ensures the widget is ready before any OTP operations.

SDK Methods

We provide methods, which helps you integrate the OTP verification within your own user interface.

getWidgetProcess is an optional method, this will receive the widget configuration data.

There are three methods sendOTP, retryOTP and verifyOTP for the otp verification process.

You can call these methods as follow:

sendOTP

The sendOTP method is used to send an OTP to an identifier. The identifier can be an email or mobile number (it must contain the country code without +). You can call this method on a button press.

NOTE: If you have enabled the invisible option in a widget configuration and you are trying to verify the mobile number with the mobile network then your number will be verified without OTP and if in any case the invisible verification gets fail in between the process then you will receive the normal OTP on your entered number.

const handleSendOtp = async () => {
  const data = {
    identifier: '91758XXXXXXX'
  }
  const response = await OTPWidget.sendOTP(data);
  console.log(response);
}

or

const handleSendOtp = async () => {
  const data = {
    identifier: '[email protected]'
  }
  const response = await OTPWidget.sendOTP(data);
  console.log(response);
}

retryOTP

The retryOTP method allows retrying the OTP on desired communication channel. retryOTP method takes optional channel code for 'SMS-11', 'VOICE-4', 'EMAIL-3', 'WHATSAPP-12' for retrying otp.

Note: If the widget uses the default configuration, don't pass the channel as argument.

const handleRetryOtp = async () => {
   const body = {
        reqId: '3463***************43931',
        retryChannel: 11 // Retry channel code (here, SMS:11)
  }
  const response = await OTPWidget.retryOTP(body);
  console.log(response);
}

verifyOTP

The verifyOTP method is used to verify an OTP entered by the user.

const handleVerifyOtp = async () => {
  const body = {
        reqId: '3463***************43931',
        otp: '****'
  }
  const response = await OTPWidget.verifyOTP(body);
  console.log(response);
}

License

Copyright 2022 MSG91
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.