MessageWay nodeJS SDK Documents - v1.0.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • IsManual: boolean = false

Hierarchy

  • MessageWay

Index

Constructors

Methods

Constructors

constructor

  • new MessageWay<IsManual>(apiKey: string, manual?: IsManual, language?: string): MessageWay<IsManual>

  • Type parameters

    • IsManual: boolean = false

    Parameters

    • apiKey: string

      Your API key in MsgWay.com.

    • manual: IsManual = ...

      Generate OTP code automatically or you gonna to enter it manually.
      Default is false.

    • language: string = 'fa-IR'

      Target language for showing error messages.

    Returns MessageWay<IsManual>

Methods

sendSMS

  • sendSMS(options: SendInput<IsManual>): Promise<string>

  • Send OTP Code via SMS

    Parameters

    Returns Promise<string>

    Reference ID

sendIVR

  • sendIVR(options: SendInput<IsManual>): Promise<string>

  • Send OTP Code via IVR (Interactive voice response)

    Parameters

    Returns Promise<string>

    Reference ID

sendGapMessage

  • sendGapMessage(options: SendInput<IsManual>): Promise<string>

  • Send OTP Code via Gap Messenger (gap.im)

    Parameters

    Returns Promise<string>

    Reference ID

sendWhatsAppMessage

  • sendWhatsAppMessage(options: SendInput<IsManual>): Promise<string>

verify

  • Verify the user entered code.

    Parameters

    Returns Promise<void>

    If the code is correct the promise resolves.

getStatus

Legend

  • Property
  • Method

Generated using TypeDoc