gsotp
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.5 • Public • Published

    بسم الله الرّحمن الرّحیم

    gsOTP.com Node.js SDK

    Documents

    Full documentation is here.

    Install

    npm install gsotp

    Send OTP Code

    const { GsOTP } = require('gsotp')
    const otp = new GsOTP(API_KEY)
    
    otp.sendSMS({
      mobile: '09333333333',
      templateID: 12,
      param1: 'Foo',
      length: 4,
    })
    .then(referenceID => {
      console.log(referenceID)
    })
    .catch(error => {
      console.error(error)
    })

    Verify OTP Code

    const { GsOTP, isGsOTPError } = require('gsotp')
    const otp = new GsOTP(API_KEY)
    
    otp.verify({
      mobile: '09333333333',
      otp: '3305',
    })
    .then(() => {
      console.log('Code is correct!')
    })
    .catch(error => {
      // handle Error
      if (isGsOTPError(error)) {
        console.log(`Error ${error.code}: ${error.message}`)
      } else {
        // unknown error
        console.error(error)
      }
    })

    Use async functions

    async function send() {
      try {
        const result = await otp.getStatus({ OTPReferenceID: 1628960593121007556n })
        console.log('Method: ' + result.OTPMethod)
        console.log('Status: ' + result.OTPStatus)
        console.log('Verified: ' + result.OTPVerified)
      } catch (error) {
        if (isGsOTPError(error)) {
          console.log(`Error ${error.code}: ${error.message}`)
        } else {
          console.error(error)
        }
      }
    }
    
    send()

    Keywords

    Install

    npm i gsotp

    DownloadsWeekly Downloads

    0

    Version

    1.2.5

    License

    MIT

    Unpacked Size

    10.2 kB

    Total Files

    6

    Last publish

    Collaborators

    • mojtaba74