nest-whatsapp - v0.0.1
    Preparing search index...

    Class WhatsAppPhoneNumbersService

    Index

    Constructors

    Methods

    • Request a verification code to be sent to the phone number via SMS or voice call.

      Parameters

      • phoneNumberId: string
      • codeMethod: "SMS" | "VOICE"

        Delivery method: 'SMS' or 'VOICE'

      • locale: string = 'en_US'

        BCP 47 language code (e.g. 'en_US'). Defaults to 'en_US'.

      • clientName: WhatsAppMode = WhatsAppMode.LIVE

      Returns Promise<boolean>

    • Set or update the two-step verification PIN for a phone number.

      Parameters

      • phoneNumberId: string
      • pin: string
      • clientName: WhatsAppMode = WhatsAppMode.LIVE

      Returns Promise<boolean>

    • Verify the code received via SMS or voice to confirm phone number ownership.

      Parameters

      • phoneNumberId: string
      • code: string
      • clientName: WhatsAppMode = WhatsAppMode.LIVE

      Returns Promise<boolean>