Class WhatsAppPhoneNumbersService

Index

Constructors

Methods

getPhoneNumber listPhoneNumbers requestVerificationCode setTwoStepPin verifyCode

Constructors

constructor

new WhatsAppPhoneNumbersService(
    httpService: HttpService,
    sandboxConfig?: WhatsAppSandboxOptions,
    liveConfig?: WhatsAppLiveOptions,
    runtimeOptions?: WhatsAppRuntimeOptions,
): WhatsAppPhoneNumbersService
Parameters
- httpService: HttpService
- OptionalsandboxConfig: WhatsAppSandboxOptions
- OptionalliveConfig: WhatsAppLiveOptions
- OptionalruntimeOptions: WhatsAppRuntimeOptions
Returns WhatsAppPhoneNumbersService

Methods

getPhoneNumber

getPhoneNumber(
phoneNumberId: string,
clientName?: WhatsAppMode,
): Promise<WhatsAppPhoneNumber>
Get details of a specific phone number by its ID.
Parameters
- phoneNumberId: string
- clientName: WhatsAppMode = WhatsAppMode.LIVE
Returns Promise<WhatsAppPhoneNumber>

listPhoneNumbers

listPhoneNumbers(
wabaId: string,
clientName?: WhatsAppMode,
): Promise<WhatsAppPhoneNumber[]>
List all phone numbers registered under a WABA.
Parameters
- wabaId: string
- clientName: WhatsAppMode = WhatsAppMode.LIVE
Returns Promise<WhatsAppPhoneNumber[]>

requestVerificationCode

requestVerificationCode(
    phoneNumberId: string,
    codeMethod: "SMS" | "VOICE",
    locale?: string,
    clientName?: WhatsAppMode,
): Promise<boolean>
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>

setTwoStepPin

setTwoStepPin(
    phoneNumberId: string,
    pin: string,
    clientName?: WhatsAppMode,
): 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>

verifyCode

verifyCode(
    phoneNumberId: string,
    code: string,
    clientName?: WhatsAppMode,
): 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>