WhatsApp Business Platform Node.js SDK

To send an image hosted on your own servers, use a self-hosted image object. The image must be in PNG or JPG format and must be accessible via a public URL. You provide the direct link to the image file.

{
    "link" : new URL( "https://www.example.com" ).href,
    "caption" : "CAPTION"
}

The PhoneObject is a data structure used to describe a contact's phone number within the WhatsApp Business Platform. It contains the raw phone number, the classification of the number type, and the specific WhatsApp identifier.

{
    "phone": "PHONE_NUMBER",
    "type": "WORK",
    "wa_id": "PHONE_OR_WA_ID"
}

An InteractiveObject is a container for interactive messages. While the specific requirements for the action field change based on the type, most interactive objects share common properties:

• type: Determines the interactive mode (list, product_list, product, or button).
• body: A SimpleTextObject containing the message text (supports emojis and markdown, max 1024 chars).
• footer (optional): A SimpleTextObject (supports emojis, markdown, and links, max 60 chars).
• header (optional): A HeaderObject displayed at the top.
• action: An ActionObject defining the user interaction (e.g., selecting a list row, choosing a product, or clicking a button).

The Messages class is not instantiated directly by the user. Instead, it is automatically instantiated by the WhatsApp class and attached as a member. You access its functionality through the <<SDK_NAMESPACE>>.messages property (e.g., wa.messages if your instance is named wa).

When the SDK internally instantiates the Messages class, it passes the following arguments:

1. config: An object of type WAConfigType containing the SDK configuration.
2. HttpsClient: A RequesterClass object containing the HTTP client instance used to perform the requests.

The ComponentObject is used to populate available message template parameters with specific content types such as text, currency, date-time, media (document, image, video), or buttons.

Each component object requires a type (either header or body) and a parameters array. Note that text-based templates only support type: "body" and text components. The parameters array can contain a mix of different component parameter types.

When using wa.webhooks.start(callback), the provided callback function is invoked for incoming POST requests. GET requests are handled internally by the SDK for Cloud API subscription verification.

The callback receives the following parameters:

• statusCode: The HTTP status code of the incoming request.
• headers: The request headers.
• body: The parsed request body.
• resp: The response object used to send a reply back to the Cloud API. Crucial: You must call resp.writeHead(200, ...) and resp.end() to acknowledge the message and prevent the Cloud API from retrying the delivery.
• err: An error object if the request failed.

The EmailObject is a data structure used to describe an email address associated with a contact. It consists of the email string itself and a classification of the address type.

{
  "email": "email@example.com",
  "type": "HOME"
}

The DateTimeObject is a component parameter used specifically when creating or sending message templates. It allows you to define a date/time component with a fallback value to ensure the message remains readable if the specific date/time data is unavailable.

{
    "fallback_value": "1 January, 1990"
}

The StickerMediaObject is used to specify the media for a sticker message. It supports both static and animated third-party outbound stickers.

Requirements for stickers:

• Static stickers: Must be 512x512 pixels and $\le$ 100 KB.
• Animated stickers: Must be 512x512 pixels and $\le$ 500 KB.

You can provide the sticker using either a Meta-hosted ID or a publicly accessible URL (self-hosted).

To send an image that has already been uploaded to Meta, use a Meta-hosted image object. This requires the image to be in PNG or JPG format. You must provide the unique image ID returned during the initial upload process.

{
    "id" : "IMAGE_ID",
    "caption" : "CAPTION"
}