Class Button

constructor

• new Button(client: any): Button

  Parameters

  • client: any

  Returns Button

StaticparamsList

addAddress

• addAddress(
      display_text: string,
      id: string,
      options?: Record<string, any>,
  ): this

  Parameters

  • display_text: string
  • id: string
  • Optionaloptions: Record<string, any>

  Returns this

addBookingConfirmation

• addBookingConfirmation(payload?: Record<string, any>): this

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addButton

• addButton(name: string, params: string | Record<string, any>): this

  Parameters

  • name: string
  • params: string | Record<string, any>

  Returns this

addCall

• addCall(
      display_text: string,
      phone_number: string,
      options?: Record<string, any>,
  ): this

  cta_call. Note: keys on phone_number, not id.

  Parameters

  • display_text: string
  • phone_number: string
  • Optionaloptions: Record<string, any>

  Returns this

addCallPermission

• addCallPermission(display_text?: string, options?: Record<string, any>): this

  call_permission_request.

  Parameters

  • Optionaldisplay_text: string
  • Optionaloptions: Record<string, any>

  Returns this

addCancelOrder

• addCancelOrder(id: string, display_text?: string): this

  Parameters

  • id: string
  • Optionaldisplay_text: string

  Returns this

addCancelReminder

• addCancelReminder(
      display_text: string,
      id: string,
      options?: Record<string, any>,
  ): this

  Parameters

  • display_text: string
  • id: string
  • Optionaloptions: Record<string, any>

  Returns this

addCardMessage

• addCardMessage(payload?: Record<string, any>): this

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addCatalog

• addCatalog(display_text?: string, options?: Record<string, any>): this

  cta_catalog — opens the sender's WhatsApp Business catalog. Business-account gated.

  Parameters

  • Optionaldisplay_text: string
  • Optionaloptions: Record<string, any>

  Returns this

addClearChat

• addClearChat(): this

  Returns this

addCopy

• addCopy(
      display_text: string,
      copy_code: string,
      options?: Record<string, any>,
  ): this

  Parameters

  • display_text: string
  • copy_code: string
  • Optionaloptions: Record<string, any>

  Returns this

addFlow

• addFlow(flow: Record<string, any>, display_text?: string): this

  Parameters

  • flow: Record<string, any>
  • Optionaldisplay_text: string

  Returns this

addLocation

• addLocation(options?: Record<string, any>): this

  Parameters

  • Optionaloptions: Record<string, any>

  Returns this

addMultiProduct

• addMultiProduct(payload?: Record<string, any>): this

  mpm — multi-product message. Business-catalog accounts only.

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addNavigateToScreen

• addNavigateToScreen(screen: string, data?: Record<string, any>): this

  Parameters

  • screen: string
  • Optionaldata: Record<string, any>

  Returns this

addOpenWebview

• addOpenWebview(title: string, url: string, options?: OpenWebviewOptions): this

  open_webview — opens a titled in-app webview and emits link.in_app_webview by default.

  Parameters

  • title: string
  • url: string
  • Optionaloptions: OpenWebviewOptions

  Returns this

addOrderDetails

• addOrderDetails(payload?: Record<string, any>): this

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addOrderStatus

• addOrderStatus(payload?: Record<string, any>): this

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addPaymentInfo

• addPaymentInfo(payload?: Record<string, any>): this

  payment_info — structured payment-settings payload (e.g. PIX). Payment-enabled accounts only.

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addPaymentKeyInfo

• addPaymentKeyInfo(payload?: Record<string, any>): this

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addPaymentMethod

• addPaymentMethod(payload?: Record<string, any>): this

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addPaymentStatus

• addPaymentStatus(payload?: Record<string, any>): this

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addReminder

• addReminder(
      display_text: string,
      id: string,
      options?: Record<string, any>,
  ): this

  Parameters

  • display_text: string
  • id: string
  • Optionaloptions: Record<string, any>

  Returns this

addReorder

• addReorder(id: string, display_text?: string): this

  Parameters

  • id: string
  • Optionaldisplay_text: string

  Returns this

addReply

• addReply(display_text: string, id: string, options?: Record<string, any>): this

  Parameters

  • display_text: string
  • id: string
  • Optionaloptions: Record<string, any>

  Returns this

addReviewAndPay

• addReviewAndPay(payload?: Record<string, any>): this

  review_and_pay — order/payment summary flow. Server-validated by WhatsApp.

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addSelection

• addSelection(title: string, options?: Record<string, any>): this

  Parameters

  • title: string
  • Optionaloptions: Record<string, any>

  Returns this

addTrackOrder

• addTrackOrder(id: string, display_text?: string): this

  Parameters

  • id: string
  • Optionaldisplay_text: string

  Returns this

addTransactionDetails

• addTransactionDetails(payload?: Record<string, any>): this

  wa_payment_transaction_details.

  Parameters

  • Optionalpayload: Record<string, any>

  Returns this

addUrl

• addUrl(
      display_text: string,
      url: string,
      webview_interaction?: boolean,
      options?: Record<string, any>,
  ): this

  cta_url. webview_interaction is kept for compatibility; use addOpenWebview() for the real in-app-webview native-flow button.

  Parameters

  • display_text: string
  • url: string
  • Optionalwebview_interaction: boolean
  • Optionaloptions: Record<string, any>

  Returns this

addVideoCall

• addVideoCall(id: string, display_text?: string): this

  Parameters

  • id: string
  • Optionaldisplay_text: string

  Returns this

addViewCatalog

• addViewCatalog(options?: Record<string, any>): this

  automated_greeting_message_view_catalog. Business-account gated.

  Parameters

  • Optionaloptions: Record<string, any>

  Returns this

addVoiceCall

• addVoiceCall(id: string, display_text?: string): this

  Parameters

  • id: string
  • Optionaldisplay_text: string

  Returns this

assertValid

• assertValid(): this

  Throw when validate() reports errors; returns this when valid.

  Returns this

build

• build(jid: string, options?: Record<string, any>): Promise<Record<string, any>>

  Parameters

  • jid: string
  • Optionaloptions: Record<string, any>

  Returns Promise<Record<string, any>>

clearButtons

• clearButtons(): this

  Returns this

countButtons

• countButtons(): number

  How many buttons have been added so far.

  Returns number

getButtonNames

• getButtonNames(): string[]

  The accumulated button names, in order.

  Returns string[]

makeRow

• makeRow(
      header?: string,
      title?: string,
      description?: string,
      id?: string,
  ): this

  Parameters

  • Optionalheader: string
  • Optionaltitle: string
  • Optionaldescription: string
  • Optionalid: string

  Returns this

makeSection

• makeSection(title?: string, highlight_label?: string): this

  Parameters

  • Optionaltitle: string
  • Optionalhighlight_label: string

  Returns this

send

• send(
      jid: string,
      options?: Record<string, any> & { validate?: boolean },
  ): Promise<any>

  Send the message. Pass { validate: true } to assertValid() before sending.

  Parameters

  • jid: string
  • Optionaloptions: Record<string, any> & { validate?: boolean }

  Returns Promise<any>

setBloksWidget

• setBloksWidget(tree: BloksNode, options?: BloksWidgetOptions): this

  Parameters

  • tree: BloksNode
  • Optionaloptions: BloksWidgetOptions

  Returns this

setBottomSheet

• setBottomSheet(params?: BottomSheetParams): this

  Parameters

  • Optionalparams: BottomSheetParams

  Returns this

setDocument

• setDocument(
      path: string | Buffer<ArrayBufferLike>,
      options?: Record<string, any>,
  ): this

  Parameters

  • path: string | Buffer<ArrayBufferLike>
  • Optionaloptions: Record<string, any>

  Returns this

setImage

• setImage(
      path: string | Buffer<ArrayBufferLike>,
      options?: Record<string, any>,
  ): this

  Parameters

  • path: string | Buffer<ArrayBufferLike>
  • Optionaloptions: Record<string, any>

  Returns this

setLimitedTimeOffer

• setLimitedTimeOffer(params?: LimitedTimeOfferParams): this

  Parameters

  • Optionalparams: LimitedTimeOfferParams

  Returns this

setMedia

• setMedia(obj: Record<string, any>): this

  Parameters

  • obj: Record<string, any>

  Returns this

setParams

• setParams(obj: Record<string, any>): this

  Parameters

  • obj: Record<string, any>

  Returns this

setTapTargetConfiguration

• setTapTargetConfiguration(params?: TapTargetConfigurationParams): this

  Parameters

  • Optionalparams: TapTargetConfigurationParams

  Returns this

setVideo

• setVideo(
      path: string | Buffer<ArrayBufferLike>,
      options?: Record<string, any>,
  ): this

  Parameters

  • path: string | Buffer<ArrayBufferLike>
  • Optionaloptions: Record<string, any>

  Returns this

toCard

• toCard(): Promise<Record<string, any>>

  Returns Promise<Record<string, any>>

validate

• validate(): { errors: string[]; ok: boolean; warnings: string[] }

  Pre-flight validation of the card (no socket): empty/malformed params, missing ids/urls, duplicate reply ids.

  Returns { errors: string[]; ok: boolean; warnings: string[] }