WhatsApp Business Platform Node.js SDK

https://github.com/whatsapp/whatsapp-nodejs-sdk
Admin
SDK for interfacing with WhatsApp Business Platform in Typescript or Node.js using the Cloud API,...
Tokens:19,048
Snippets:197
Trust Score:7.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install dependencies

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/README.md

Run this command to install all required project dependencies.

```bash
$ yarn
```

--------------------------------

### Run Application

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/receivingMessages.md

Command to start the HTTP server for the webhook listener.

```shell
npm listen.js
```

--------------------------------

### WhatsApp.webhooks.start()

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/webhooks/start.md

Starts the web server to listen for webhook events. It handles verification via GET requests and event processing via POST requests.

```APIDOC
## WhatsApp.webhooks.start(webhookCallbackFunction)

### Description
Starts the web server listening on the defined port for webhook events. It automatically handles GET requests for webhook verification and POST requests for incoming event payloads.

### Arguments
- **webhookCallbackFunction** (Function) - Required - The callback function invoked during POST requests to process the webhook payload.

### Returns
- **boolean** - Returns the current running state of the HTTP server.

### Example
```javascript
import WhatsApp from 'whatsapp';

const wa = new WhatsApp(senderNumber);

async function webhookCallbackFunction(statusCode, reqHeaders, body, resp, err) {
    // Handle incoming webhook logic
    if (resp) {
        resp.writeHead(statusCode);
        resp.end();
    }
}

wa.webhooks.start(webhookCallbackFunction);
```
```

--------------------------------

### Install WhatsApp Business Platform SDK

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/projectSetup.md

Use this command to install the SDK package in your Node.js project.

```shell
npm install whatsapp
```

--------------------------------

### Start Webhook Server with Custom Callback

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/webhooks/this.md

Initializes the WhatsApp SDK and starts a webhook server using a custom callback function to handle incoming requests and responses.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

async function custom_callback( statusCode, reqHeaders, body, resp, err )
{
    console.log(
        `Incoming webhook response status code: ${ statusCode }\n\nHeaders:
        ${ JSON.stringify( reqHeaders ) }`
    );

    // Send a 200 so the webhooks service knows you received the message
    if( resp )
    {
        if( body )
            console.log( `Body: ${ JSON.stringify( body ) }` );

        resp.writeHead( statusCode, { "Content-Type": "text/plain" } );
        resp.end();
    }

    if( err )
    {
        console.log( `ERROR: ${ err }` );
        resp.end();
    }
}

wa.webhooks.start( custom_callback );
```

--------------------------------

### Start local development server

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/README.md

Launches a local server with live reloading for development purposes.

```bash
$ yarn start
```

--------------------------------

### Button Component Example

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ComponentsObject.md

Defines a quick reply button component.

```json
{
    "type": "button",
    "sub_type": "quick_reply",
    "index": "0",
    "parameters": [
        {
        "type": "payload",
        "payload": "PAYLOAD"
        }
    ]
}
```

--------------------------------

### Video Component Example

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ComponentsObject.md

Defines a video parameter using a URL link.

```js
{
    "type": "body",
    "parameters":
    [ {
        "type": "video",
        "image":
        {
            "link": new URL( "https://www.example.com/VIDEO.MP4" ).href
        }
    } ]
}
```

--------------------------------

### Install the SDK

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/README.md

Use yarn or npm to add the WhatsApp Business Platform SDK to your project.

```shell
yarn add whatsapp
```

```shell
npm install whatsapp
```

--------------------------------

### Image Component Example

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ComponentsObject.md

Defines an image parameter using a URL link.

```js
{
    "type": "body",
    "parameters":
    [ {
        "type": "image",
        "image":
        {
            "link": new URL( "https://www.example.com/IMAGE.PNG" ).href
        }
    } ]
}
```

--------------------------------

### wa.webhooks.start(callback)

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/webhooks/this.md

Starts the web server to listen for incoming webhooks and executes the provided callback function upon receiving a request.

```APIDOC
## wa.webhooks.start(callback)

### Description
Starts the web server to listen for incoming webhooks. The provided callback function is executed when a request is received, allowing the user to handle the status code, headers, and body.

### Parameters
- **callback** (function) - Required - A function that receives (statusCode, reqHeaders, body, resp, err) as arguments to process the incoming webhook request.
```

--------------------------------

### Document Component Example

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ComponentsObject.md

Defines a document parameter using a URL link.

```js
{
    "type": "body",
    "parameters":
    [ {
        "type": "document",
        "image":
        {
            "link": new URL( "https://www.example.com/DOCUMENT.PDF" ).href
        }
    } ]
}
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/receivingMessages.md

Example configuration for the .env file required to authenticate and route incoming webhooks.

```shell
# Your WhatsApp phone number Id.
WA_PHONE_NUMBER_ID=

# System user access token. Recommended: Do not use a temporary access token.
CLOUD_API_ACCESS_TOKEN=

# Cloud API version number.
CLOUD_API_VERSION=v16.0

# Customize your incoming webhook listener endpoint. Path should be https://{host}/{WEBHOOK_ENDPOINT}.
# A trailing slash is not added by default, so the variable should include that if it's required by your API gateway.
WEBHOOK_ENDPOINT=webhook/

# A custom verification token string to validate incoming webhook payloads.
# Needs to match webhook configuration.
WEBHOOK_VERIFICATION_TOKEN=1234567890abcd

# Override the default app listener port (optional & default 3000).
LISTENER_PORT=3000
```

--------------------------------

### Start Webhook Listener in Node.js

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/webhooks/start.md

Initializes the webhook server and defines a callback function to handle incoming webhook events and verification.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

async function webhookCallbackFunction( statusCode, reqHeaders, body, resp, err )
{
    console.log(
        `Incoming webhook response status code: ${ statusCode }\n\nHeaders:
        ${ JSON.stringify( reqHeaders ) }`
    );

    if( resp )
    {
        if( body?.entry[ 0 ].changes[ 0 ].field == "messages" && body.entry[ 0 ].changes[ 0 ].value.messages )
            console.log( `Messages Object: ${ JSON.stringify( body.entry[ 0 ].changes[ 0 ].value.messages ) }` );

        // Send a 200 so the webhooks service knows you received the message
        resp.writeHead( statusCode );
        resp.end();
    }

    if( err )
    {
        console.log( `ERROR: ${ err }` );
        resp.end();
    }
}

wa.webhooks.start( webhookCallbackFunction );
```

--------------------------------

### Check Webhook Server Status

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/webhooks/isStarted.md

Demonstrates starting the webhook server and verifying its status after a 5-second delay.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

async function webhookCallbackFunction( statusCode, reqHeaders, body, resp, err )
{
    console.log(
        `Incoming webhook response status code: ${ statusCode }\n\nHeaders:
        ${ JSON.stringify( reqHeaders ) }`
    );
}

async function check_status()
{
    setTimeout( () =>
    {
        console.log( `Webhook listener is running - ${ wa.webhooks.isStarted() }` );
    }, 5000 );
}

wa.webhooks.start( webhookCallbackFunction )
check_status();
```

--------------------------------

### Get the SDK version

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/whatsapp/version.md

Retrieves the current SDK version string after initializing the WhatsApp client.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901;
const wa = new WhatsApp( senderNumber );
const sdk_version = wa.version();
```

--------------------------------

### Currency Component Example

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ComponentsObject.md

Defines a currency parameter within a body component.

```json
{
    "type": "body",
    "parameters":
    [ {
        "type": "currency",
        "currency":
        {
            "fallback_value": "VALUE",
            "code": "USD",
            "amount_1000": 1000
        }
    } ]
}
```

--------------------------------

### Stop the WhatsApp webhook server

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/webhooks/stop.md

Demonstrates starting the webhook server and immediately stopping it using the stop method.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

async function webhookCallbackFunction( statusCode, reqHeaders, body, resp, err )
{
    console.log(
        `Incoming webhook response status code: ${ statusCode }\n\nHeaders:
        ${ JSON.stringify( reqHeaders ) }`
    );
}

function webhook_stop_check_callback( err )
{
    if( err )
        console.log(`Error stopping webhook web server: ${ JSON.stringify( err ) }` );
}

async function start(){
    if( await wa.webhooks.start( webhookCallbackFunction ) )
        wa.webhooks.stop( webhook_stop_check_callback );
}
```

--------------------------------

### Text Component Example

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ComponentsObject.md

Defines a simple text parameter within a body component.

```json
{
    "type": "body",
    "parameters":
    [ {
        "type": "text",
        "text": "TEXT_STRING"
    } ]
}
```

--------------------------------

### Date-time Component Example

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ComponentsObject.md

Defines a date-time parameter within a body component.

```json
{
    "type": "body",
    "parameters":
    [ {
        "type": "date_time",
        "date_time":
        {
            "fallback_value": "MONTH DAY, YEAR"
        }
    } ]
}
```

--------------------------------

### Define a ContactObject

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ContactObject.md

Example structure of a ContactObject array containing detailed contact information.

```javascript
[ {
    "addresses": [ {
        "street": "STREET",
        "city": "CITY",
        "state": "STATE",
        "zip": "ZIP",
        "country": "COUNTRY",
        "country_code": "COUNTRY_CODE",
        "type": "HOME"
    } ],
    "birthday": "1911-01-11",
    "emails": [ {
        "email": "EMAIL@EXAMPLE.COM",
        "type": "WORK"
    } ],
    "name": {
        "formatted_name": "NAME",
        "first_name": "FIRST_NAME",
        "last_name": "LAST_NAME",
        "middle_name": "MIDDLE_NAME",
        "suffix": "SUFFIX",
        "prefix": "PREFIX"
    },
    "org": {
        "company": "COMPANY",
        "department": "DEPARTMENT",
        "title": "TITLE"
    },
    "phones": [ {
        "phone": "PHONE_NUMBER",
        "type": "HOME"
    },
    {
        "phone": "PHONE_NUMBER",
        "type": "WORK",
        "wa_id": "PHONE_OR_WA_ID"
    } ],
    "urls": [ {
        "url": new URL( "https://wwww.example.com" ).href,
        "type": "WORK"
    } ]
} ]
```

--------------------------------

### PhoneNumbersResponseObject JSON Example

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/PhoneNumbersResponseObject.md

Represents the successful response body structure for phone number verification requests.

```json
{
  "success": true
}
```

--------------------------------

### Initialize Project Directory

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/gettingStarted.md

Create a new directory for the project and initialize the package.json file.

```shell
mkdir wa_quickstart
cd ./wa_quickstart
```

```shell
npm init --yes
```

--------------------------------

### Execute Application

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/gettingStarted.md

Run the application using the node command.

```shell
npm start.js
```

--------------------------------

### Build static site

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/README.md

Compiles the website into static files located in the build directory.

```bash
$ yarn build
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/README.md

Define configuration options in a .env file to authenticate and customize SDK behavior.

```shell
# The base URL to send all SDK requests to (default graph.facebook.com).
# This variable should not be used unless necessary for development or special routing needs.
WA_BASE_URL=

# Your Meta for Developers app Id.
M4D_APP_ID=

# Your Meta for Developers Business app secret.
M4D_APP_SECRET=

# Your WhatsApp phone number Id (sender).
WA_PHONE_NUMBER_ID=

# Your WhatsApp business account Id.
WA_BUSINESS_ACCOUNT_ID=

# System user access token. Recommended: Do not use a temporary access token.
CLOUD_API_ACCESS_TOKEN=

# Cloud API version number.
CLOUD_API_VERSION=v16.0

# Customize your incoming webhook listener endpoint. Path should be
# https://{host}/{WEBHOOK_ENDPOINT}. A trailing slash is not added by default,
# so the variable should include that if it's required by your API gateway.
WEBHOOK_ENDPOINT=

# A custom verification token string to validate incoming webhook payloads.
# Needs to match webhook configuration.
WEBHOOK_VERIFICATION_TOKEN=

# Override the default app listener port (port 3000).
LISTENER_PORT=

# Turn on global debug logging
DEBUG=

# The number of request retries after waiting (default 30 retries)
MAX_RETRIES_AFTER_WAIT=

# The timeout period in milliseconds for a request to wait for a response (default 20000ms)
REQUEST_TIMEOUT=
```

--------------------------------

### Send Meta-hosted and externally hosted videos

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/video.md

Demonstrates sending both a Meta-hosted video by ID and an externally hosted video via a URL to a specific recipient.

```javascript
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const meta_hosted_video =
{
    "id" : "123456abcde",
    "caption" : "My video file",
    "filename" : "example.mp4"
};

const self_hosted_video =
{
    "link" : new URL( "https://example.com/example_1234.mp4" ).href,
    "caption" : "My video file",
    "filename" : "example.mp4"
};

await wa.messages.video( meta_hosted_video, 12345678901 );
wa.messages.video( self_hosted_video, 12345678901 );
```

--------------------------------

### Implement Message Sending Script

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/gettingStarted.md

Create a script to initialize the WhatsApp client and send a text message to a recipient.

```javascript
import WhatsApp from 'whatsapp';

// Your test sender phone number
const wa = new WhatsApp( <<SENDER_NUMBER>> );

// Enter the recipient phone number
const recipient_number = <<RECIPIENT_NUMBER>>;

async function send_message()
{
    try{
        const sent_text_message = wa.messages.text( { "body" : "Hello world" }, recipient_number );

        await sent_text_message.then( ( res ) =>
        {
            console.log( res.rawResponse() );
        } );
    }
    catch( e )
    {
        console.log( JSON.stringify( e ) );
    }
}

send_message();
```

--------------------------------

### WhatsApp.version()

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/whatsapp/version.md

Retrieves the semantically formatted SDK version as a string.

```APIDOC
## WhatsApp.version()

### Description
Retrieves the semantically formatted SDK version.

### Method
Method call on WhatsApp instance

### Arguments
- None (Void)

### Returns
- **String** - The version string formatted as MAJOR.MINOR.PATCH-LABELS.

### Example
```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901;
const wa = new WhatsApp( senderNumber );
const sdk_version = wa.version();
```
```

--------------------------------

### Initialize WhatsApp SDK Client

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/whatsapp/this.md

Instantiate the WhatsApp client using a specific sender phone number ID.

```javascript
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );
```

--------------------------------

### Implement Webhook Listener

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/receivingMessages.md

Create a listener in listen.js using the WhatsApp SDK to handle incoming webhook callbacks.

```js
import WhatsApp from "whatsapp";

const senderNumber = 12345678901234567890;
const wa = new WhatsApp();

function custom_callback ( statusCode, headers, body, resp, err )
{
    console.log(
        `Incoming webhook status code: ${ statusCode }\n\nHeaders:
        ${ JSON.stringify( headers ) }\n\nBody: ${ JSON.stringify( body ) }`
    );

    if( resp )
    {
        resp.writeHead(200, { "Content-Type": "text/plain" });
        resp.end();
    }

    if( err )
    {
        console.log( `ERROR: ${ err }` );
    }
}

wa.webhooks.start( custom_callback );
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/gettingStarted.md

Define the required environment variables in a .env file.

```shell
# Your WhatsApp phone number Id (sender).
WA_PHONE_NUMBER_ID=

# System user access token. Recommended: Do not use a temporary access token.
CLOUD_API_ACCESS_TOKEN=

# Cloud API version number.
CLOUD_API_VERSION=v16.0
```

--------------------------------

### Deploy to GitHub Pages

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/README.md

Commands to deploy the site to the gh-pages branch, supporting both SSH and HTTPS authentication methods.

```bash
$ USE_SSH=true yarn deploy
```

```bash
$ GIT_USER=<Your GitHub username> yarn deploy
```

--------------------------------

### Send Meta-hosted and externally hosted stickers

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/sticker.md

Demonstrates sending both a Meta-hosted sticker using an ID and an externally hosted sticker using a URL link.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const meta_hosted_sticker =
{
    "id" : "123456abcde",
};

const self_hosted_sticker =
{
    "link" : new URL( "https://example.com/example_1234.webp" ).href,
};

await wa.messages.sticker( meta_hosted_sticker, 12345678901 );
wa.messages.sticker( self_hosted_sticker, 12345678901 );
```

--------------------------------

### WAConfigType JSON Configuration

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/WAConfigType.md

Represents the structure of the configuration object used to initialize SDK sub-classes.

```json
{
    "wa_base_url" : "https://graph.facebook.com/",
    "m4d_app_id" : 12345,
    "m4d_app_secret" : "example_app_secret_123",
    "wa_phone_number_id" : 0987654321,
    "wa_business_account_id" : 1234567890,
    "cloud_api_version" : "v16",
    "cloud_api_access_token" : "example_access_token_123",
    "webhook_endpoint" : "webhook",
    "webhook_verification_token" : "1234567890abcd",
    "listener_port" : 3000,
    "max_retries_after_wait" : 30,
    "request_timeout" : 20000,
    "debug" : true
}
```

--------------------------------

### Meta-hosted Audio Object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/AudioMediaObject.md

Use this structure when referencing an audio file already uploaded to Meta servers.

```json
{
    "id" : "AUDIO_ID",
}
```

--------------------------------

### Send audio messages with WhatsApp SDK

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/audio.md

Demonstrates sending both a Meta-hosted audio file and an externally hosted audio file to a specific recipient.

```javascript
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const meta_hosted_audio =
{
    "id" : "123456abcde",
    "caption" : "My audio file",
    "filename" : "example.mp4"
};

const selfHostedAudio =
{
    "link" : new URL( "https://example.com/example_1234.mp4" ).href,
    "caption" : "My audio file",
    "filename" : "example.mp4"
};

await wa.messages.audio( meta_hosted_audio, 12345678901 );
wa.messages.audio( selfHostedAudio, 12345678901 );
```

--------------------------------

### Self-hosted Audio Object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/AudioMediaObject.md

Use this structure when providing a public URL for an audio file hosted on your own server.

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

--------------------------------

### new WhatsApp(senderNumberId)

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/whatsapp/this.md

Instantiates a new WhatsApp SDK client instance. Configuration can be provided via the constructor or environmental variables.

```APIDOC
## Constructor: new WhatsApp(senderNumberId)

### Description
Creates a new instance of the WhatsApp SDK client. This instance is used to interact with the WhatsApp Cloud API.

### Arguments
- **senderNumberId** (number) - Optional - The phone number Id of the sender registered in the Cloud API. Required if the `WA_PHONE_NUMBER_ID` environmental variable is not set.

### Returns
- **Object** - An instance of the WhatsApp class.

### Example
```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp(senderNumber);
```
```

--------------------------------

### Send documents using WhatsApp Node.js SDK

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/document.md

Demonstrates sending both Meta-hosted and externally hosted documents to a specified recipient number.

```javascript
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const meta_hosted_document =
{
    "id" : "123456abcde",
    "caption" : "My important document",
    "filename" : "example.pdf"
};

const self_hosted_document =
{
    "link" : new URL( "https://example.com/example_1234.pdf" ).href,
    "caption" : "My important document",
    "filename" : "example.pdf"
};

await wa.messages.document( meta_hosted_document, 12345678901 );
wa.messages.document( self_hosted_document, 12345678901 );
```

--------------------------------

### Meta-hosted video object structure

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/VideoMediaObject.md

Use this structure when referencing a video already uploaded to Meta servers.

```json
{
    "id" : "VIDEO_ID",
    "caption" : "CAPTION"
}
```

--------------------------------

### Send Meta-hosted and external images

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/image.md

Demonstrates sending both a Meta-hosted image by ID and an externally hosted image via URL to a recipient.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const meta_hosted_image =
{
    "id" : "123456abcde",
    "caption" : "My image"
};

const self_hosted_image =
{
    "link" : new URL( "https://example.com/example.png" ).href,
    "caption" : "My image"
};

await wa.messages.image( meta_hosted_image, 12345678901 );
wa.messages.image( self_hosted_image, 12345678901 );
```

--------------------------------

### WhatsApp.webhooks.isStarted()

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/webhooks/isStarted.md

Checks the status of the webhook web server and returns a boolean indicating if it is currently running.

```APIDOC
## WhatsApp.webhooks.isStarted()

### Description
Returns the current status of the webhook web server.

### Returns
- **boolean** - Returns true if the HTTP server is running, false otherwise.
```

--------------------------------

### Define a multi-product interactive object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/InteractiveObject.md

Structure for a product_list interactive object containing multiple sections and product items.

```json
{
     "type": "product_list",
     "header":{
       "type": "text",
       "text": "header-content"
     },
     "body": {
       "text": "body-content"
     },
     "footer": {
       "text": "footer-content"
     },
     "action": {
       "catalog_id": "CATALOG_ID",
       "sections": [
         {
           "title": "section-title",
           "product_items": [
             { "product_retailer_id": "product-SKU-in-catalog" },
             { "product_retailer_id": "product-SKU-in-catalog" }
           ]
         },
         {
           "title": "section-title",
           "product_items": [
             { "product_retailer_id": "product-SKU-in-catalog" },
             { "product_retailer_id": "product-SKU-in-catalog" }
           ]
         }
       ]
     }
   }
```

--------------------------------

### ProductObject JSON structure

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ProductObject.md

Represents the required format for a product within a multi-product message.

```json
{
    "product_retailer_id": "product-SKU-in-catalog"
}
```

--------------------------------

### Meta-hosted document object structure

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/DocumentMediaObject.md

Use this structure when sending a document that has already been uploaded to Meta servers.

```json
{
    "id" : "DOCUMENT_ID",
    "caption" : "CAPTION",
    "filename" : "FILENAME.PDF"
}
```

--------------------------------

### WhatsApp.twoStepVerification.setPin()

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/twoStepVerification/setPin.md

Sets the 6-digit verification PIN required for two-step verification.

```APIDOC
## WhatsApp.twoStepVerification.setPin()

### Description
Sets the verification pin to the provided 6-digit number. Having a pin for use with two factor verification is required and cannot be disabled or removed.

### Signature
`wa.twoStepVerification.setPin(pin)`

### Arguments
- **pin** (number) - Required - The 6-digit pin code that will be used for future two-step verification.

### Returns
- **Promise** - Returns a server response object on success, which is of type SetPinResponseObject.

### Example
```js
import WhatsApp from 'whatsapp';

const senderNumberId = 12345678901234567890;
const wa = new WhatsApp( senderNumberId );

wa.twoStepVerification.setPin( 123456 );
```
```

--------------------------------

### Multi-product message ActionObject

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ActionObject.md

Defines the catalog ID and sections containing multiple product items.

```json
{
    "catalog_id": "CATALOG_ID",
    "sections":
    [
        {
        "title": "section-title",
        "product_items":
        [
            { "product_retailer_id": "product-SKU-in-catalog" },
            { "product_retailer_id": "product-SKU-in-catalog" },

        ]
        },
        {
        "title": "section-title",
        "product_items":
        [
            { "product_retailer_id": "product-SKU-in-catalog" },
            { "product_retailer_id": "product-SKU-in-catalog" },
        ]
        }
    ]
}
```

--------------------------------

### Define a Webhook Callback Function

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/webhookCallbackFunc.md

A template for handling incoming webhook events, including logging headers and sending a 200 OK response.

```js
async function custom_callback( statusCode, RequestHeaders, body, response, error )
{
    console.log(
        `Incoming webhook response status code: ${ statusCode }\n\nHeaders:
        ${ JSON.stringify( RequestHeaders ) }`
    );

    // Send a 200 so the webhooks service knows you received the message
    if( response )
    {
        if( body )
            console.log( `Body: ${ JSON.stringify( body ) }` );

        response.writeHead( statusCode, { "Content-Type": "text/plain" } );
        response.end();
    }

    if( error )
    {
        console.log( `ERROR: ${ error }` );
    }
}
```

--------------------------------

### URL button parameter object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ButtonParameterObject.md

Defines a text parameter to be appended to a predefined URL prefix.

```json
{
    "type": "text",
    "text": "TEXT_STRING",
}
```

--------------------------------

### Define a Meta-hosted image object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ImageMediaObject.md

Use this structure when referencing an image already uploaded to Meta servers.

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

--------------------------------

### setPin(pin)

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/twoStepVerification/this.md

Sets the two-step verification PIN for the WhatsApp account.

```APIDOC
## setPin(pin)

### Description
Sets the two-step verification PIN for the WhatsApp account.

### Method
wa.twoStepVerification.setPin(pin)

### Parameters
- **pin** (number|string) - Required - The 6-digit PIN to be set for two-step verification.

### Example
```js
import WhatsApp from 'whatsapp';

const senderNumberId = 12345678901234567890;
const wa = new WhatsApp( senderNumberId );

wa.twoStepVerification.setPin( 123456 );
```
```

--------------------------------

### Reply Button Object Structure

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ButtonObject.md

Represents the JSON structure required for a reply button.

```json
{
    "id": "UNIQUE_BUTTON_ID_1",
    "title": "BUTTON_TITLE_1"
}
```

--------------------------------

### Single product message ActionObject

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ActionObject.md

Defines the required catalog and product identifiers for a single product message.

```json
{
    "catalog_id": "CATALOG_ID",
    "product_retailer_id": "ID_TEST_ITEM_1"
}
```

--------------------------------

### Define a single-product interactive object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/InteractiveObject.md

Structure for a product interactive object representing a single item from a catalog.

```json
{
  "type": "product",
  "body": {
    "text": "optional body text"
  },
  "footer": {
    "text": "optional footer text"
  },
  "action": {
    "catalog_id": "CATALOG_ID",
    "product_retailer_id": "ID_TEST_ITEM_1"
  }
}
```

--------------------------------

### Send a location message with WhatsApp SDK

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/location.md

Initializes the WhatsApp client and sends a location object to a recipient phone number.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const meta_hq_location =
{
    "longitude": "37.4850729",
    "latitude": "-122.1527671",
    "name": "Meta Headquarters",
    "address": "1 Hacker Way, Menlo Park, CA 94025, USA"
};

wa.messages.location( meta_hq_location, 12345678901 );
```

--------------------------------

### Quick reply button parameter object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ButtonParameterObject.md

Defines a payload parameter for a quick reply button.

```json
{
    "type": "payload",
    "payload": "PAYLOAD_STRING",
}
```

--------------------------------

### webhookCallbackFunction

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/webhookCallbackFunc.md

The signature and usage of the webhook callback function provided to the SDK.

```APIDOC
## webhookCallbackFunction

### Description
A user-defined callback function invoked by the SDK when a webhook event is received. It is responsible for processing incoming events and sending appropriate HTTP responses.

### Signature
`async function(statusCode, RequestHeaders, body, response, error)`

### Arguments
- **statusCode** (number) - The response status code sent or recommended to be sent.
- **RequestHeaders** (Object) - The HTTP request headers object from the Node.js HTTP library.
- **body** (Webhook_Request_Body, optional) - The Cloud API's webhook request body, present if a body exists in the request.
- **response** (Object, optional) - The standard HTTP response object from the Node.js HTTP library, present if a response has not yet been sent.
- **error** (Error, optional) - An error object present if there were issues with the incoming request.

### Example
```js
async function custom_callback( statusCode, RequestHeaders, body, response, error ) {
    if( response ) {
        response.writeHead( statusCode, { "Content-Type": "text/plain" } );
        response.end();
    }
    if( error ) {
        console.log( `ERROR: ${ error }` );
    }
}
```
```

--------------------------------

### WhatsApp.messages.template()

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/template.md

Sends an existing approved and enabled message template to a specified recipient.

```APIDOC
## WhatsApp.messages.template(body, recipient, [replyMessageId])

### Description
Sends an existing approved and enabled message template. This request dynamically fills out a message template with provided component parameters.

### Arguments
- **body** (Template_Object) - Required - The object describing the template to use and any components to dynamically fill the parameters with.
- **recipient** (number) - Required - The recipient's phone number with country code.
- **replyMessageId** (string) - Optional - The received WhatsApp message Id to reply back to.

### Returns
- **Promise** - Server response object on success.

### Example
```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const newsletter_subscription_body = {
    "name": "Subscribe",
    "language": {
        "policy": "deterministic",
        "code": "en_US"
    },
    "components": [
        {
            "type": "body",
            "parameters": [
                {
                    "type": "text",
                    "text": "newsletter"
                }
            ]
        }
    ]
};

await wa.messages.template( newsletter_subscription_body, 12345678901 );
```
```

--------------------------------

### Send a template message using WhatsApp SDK

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/template.md

Sends a 'Subscribe' template in en_US with a body parameter to a specified recipient.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const newsletter_subscription_body =
{
    "name": "Subscribe",
    "language":
    {
        "policy": "deterministic",
        "code": "en_US"
    },
    "components":
    [
        {
        "type": "body",
        "parameters": [
            {
            "type": "text",
            "text": "newsletter"
            }
        ]
        }
    ]
};

await wa.messages.template( newsletter_subscription_body, 12345678901 );
```

--------------------------------

### Self-hosted document object structure

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/DocumentMediaObject.md

Use this structure when providing a publicly accessible URL for a document.

```json
{
    "link" : "https://www.example.com/DOCUMENT.PDF",
    "caption" : "CAPTION",
    "filename" : "FILENAME.PDF"
}
```

--------------------------------

### WhatsApp.messages.video()

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/video.md

Sends a video message to a recipient. Supports both Meta-hosted IDs and external URLs.

```APIDOC
## WhatsApp.messages.video(body, recipient, replyMessageId)

### Description
Sends an existing self-hosted or Meta-hosted video file to a specified recipient. Supported formats include MP4 and 3GP.

### Arguments
- **body** (VideoMediaObject) - Required - The object describing the video file to send.
- **recipient** (number) - Required - The recipient's phone number with country code.
- **replyMessageId** (string) - Optional - The received WhatsApp message ID to reply back to.

### Returns
- **Promise** - Server response object on success.

### Example
```javascript
import WhatsApp from 'whatsapp';

const wa = new WhatsApp(senderNumber);

// Sending a Meta-hosted video
await wa.messages.video({ "id": "123456abcde", "caption": "My video", "filename": "example.mp4" }, 12345678901);

// Sending a self-hosted video
await wa.messages.video({ "link": "https://example.com/video.mp4", "caption": "My video", "filename": "example.mp4" }, 12345678901);
```
```

--------------------------------

### Meta Hosted Image Object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ImageMediaObject.md

Structure for sending an image that is already hosted on Meta's servers.

```APIDOC
### Meta Hosted Image Object

#### Properties
- **id** (string) - Required - The image Id returned when the image was first uploaded.
- **caption** (string) - Optional - Text to be displayed with the image.

#### Example
```json
{
    "id" : "IMAGE_ID",
    "caption" : "CAPTION"
}
```
```

--------------------------------

### Set two-step verification pin

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/twoStepVerification/setPin.md

Configures the 6-digit pin required for two-step verification using the WhatsApp SDK.

```javascript
import WhatsApp from 'whatsapp';

const senderNumberId = 12345678901234567890;
const wa = new WhatsApp( senderNumberId );

wa.twoStepVerification.setPin( 123456 );
```

--------------------------------

### Meta Hosted Sticker Object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/StickerMediaObject.md

Represents a sticker already uploaded to Meta servers using its unique media object ID.

```json
{
    "id" : "IMAGE_ID",
}
```

--------------------------------

### Define a URLObject

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/URLObject.md

Construct a URLObject using a standard URL string and a type identifier.

```js
{
    "url" : new URL( "https://www.example.com/" ).href,
    "type" : "WORK"
}
```

--------------------------------

### WhatsApp.messages.audio()

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/audio.md

Sends an audio file to a recipient. Supports Meta-hosted files via ID or self-hosted files via URL.

```APIDOC
## WhatsApp.messages.audio()

### Description
Sends an audio file to a specified recipient. Supported formats include AAC, MP4, MPEG, AMR, and OGG (excluding base audio/ogg).

### Signature
`wa.messages.audio(body, recipient, replyMessageId?)`

### Parameters
- **body** (AudioMediaObject) - Required - The object describing the audio file (contains either 'id' for Meta-hosted or 'link' for self-hosted, plus optional 'caption' and 'filename').
- **recipient** (number) - Required - The recipient's phone number with country code.
- **replyMessageId** (string) - Optional - The received WhatsApp message ID to reply to.

### Returns
- **Promise** - Resolves with the server response object on success.

### Example
```js
import WhatsApp from 'whatsapp';

const wa = new WhatsApp(senderNumber);

// Sending Meta-hosted audio
await wa.messages.audio({ "id": "123456abcde", "caption": "My audio" }, 12345678901);

// Sending self-hosted audio
await wa.messages.audio({ "link": "https://example.com/audio.mp4" }, 12345678901);
```
```

--------------------------------

### Send List Message

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/interactive.md

Sends a list of selectable items organized into sections.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const list_message =
{
    "type": "list",
    "header": {
        "type": "text",
        "text": "HEADER_TEXT"
    },
    "body": {
        "text": "BODY_TEXT"
    },
    "footer": {
        "text": "FOOTER_TEXT"
    },
    "action": {
        "button": "BUTTON_TEXT",
        "sections": [
        {
            "title": "SECTION_1_TITLE",
            "rows": [
            {
                "id": "SECTION_1_ROW_1_ID",
                "title": "SECTION_1_ROW_1_TITLE",
                "description": "SECTION_1_ROW_1_DESCRIPTION"
            },
            {
                "id": "SECTION_1_ROW_2_ID",
                "title": "SECTION_1_ROW_2_TITLE",
                "description": "SECTION_1_ROW_2_DESCRIPTION"
            }
            ]
        },
        {
            "title": "SECTION_2_TITLE",
            "rows": [
            {
                "id": "SECTION_2_ROW_1_ID",
                "title": "SECTION_2_ROW_1_TITLE",
                "description": "SECTION_2_ROW_1_DESCRIPTION"
            },
            {
                "id": "SECTION_2_ROW_2_ID",
                "title": "SECTION_2_ROW_2_TITLE",
                "description": "SECTION_2_ROW_2_DESCRIPTION"
            }
            ]
        }
        ]
    }
}

wa.messages.interactive( list_message, 12345678901 );
```

--------------------------------

### Define a self-hosted image object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ImageMediaObject.md

Use this structure when providing a publicly accessible URL for an image.

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

--------------------------------

### Reply button ActionObject

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ActionObject.md

Defines an array of reply buttons for an interactive message.

```json
{
    "buttons": [
    {
        "type": "reply",
        "reply": {
        "id": "UNIQUE_BUTTON_ID_1",
        "title": "BUTTON_TITLE_1"
        }
    },
    {
        "type": "reply",
        "reply": {
        "id": "UNIQUE_BUTTON_ID_2",
        "title": "BUTTON_TITLE_2"
        }
    }
    ]
}
```

--------------------------------

### Define a Multi-product Message Section

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/SectionObject.md

Structure for a section within a multi-product message, containing a title and an array of product items.

```json
{
    "title": "section-title",
    "product_items": [
        { "product_retailer_id": "product-SKU-in-catalog" },
        { "product_retailer_id": "product-SKU-in-catalog" }
    ]
}
```

--------------------------------

### SetPinResponseObject

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/setPinResponseObject.md

The structure of the response object returned upon successfully setting the two-step verification pin.

```APIDOC
## SetPinResponseObject

### Description
The successful response body JSON from the Cloud API for setting the two-step verification pin.

### Properties
- **success** (boolean) - The state of updating the two-step verification pin.

### Response Example
{
  "success": true
}
```

--------------------------------

### WhatsApp.messages.sticker()

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/sticker.md

Sends a sticker to a recipient. Supports Meta-hosted stickers (via ID) or self-hosted stickers (via URL).

```APIDOC
## WhatsApp.messages.sticker()

### Description
Sends an existing self-hosted or Meta-hosted sticker to a recipient. Supports static and animated stickers in WEBP format.

### Signature
`wa.messages.sticker(body, recipient, replyMessageId)`

### Arguments
- **body** (StickerMediaObject) - Required - The object describing the sticker to send.
- **recipient** (number) - Required - The recipient's phone number with country code.
- **replyMessageId** (string) - Optional - The received WhatsApp message ID to reply to.

### Returns
- **Promise** - Resolves with the server response object on success.

### Example
```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const meta_hosted_sticker = {
    "id" : "123456abcde",
};

const self_hosted_sticker = {
    "link" : new URL( "https://example.com/example_1234.webp" ).href,
};

await wa.messages.sticker( meta_hosted_sticker, 12345678901 );
wa.messages.sticker( self_hosted_sticker, 12345678901 );
```
```

--------------------------------

### Self Hosted Image Object

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/ImageMediaObject.md

Structure for sending an image hosted at a public URL.

```APIDOC
### Self Hosted Image Object

#### Properties
- **link** (string) - Required - The public URL of the image.
- **caption** (string) - Optional - Text to be displayed with the image.

#### Example
```json
{
    "link" : "https://www.example.com/image.jpg",
    "caption" : "CAPTION"
}
```
```

--------------------------------

### Send Single Product Message

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/interactive.md

Displays a single product from a Facebook store catalog.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const prod_message =
{
    "type": "product",
    "body": {
    "text": "optional body text"
    },
    "footer": {
    "text": "optional footer text"
    },
    "action": {
    "catalog_id": "CATALOG_ID",
    "product_retailer_id": "ID_TEST_ITEM_1"
    }
}

wa.messages.interactive( prod_message, 12345678901 );
```

--------------------------------

### Verify a phone number

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/phoneNumbers/verifyCode.md

Use the verifyCode method to submit the verification code received by the user.

```typescript
import WhatsApp from 'whatsapp';

const senderNumberId = 12345678901234567890;
const wa = new WhatsApp( senderNumberId );

const body : VerifyCodeObject = {
    "code" : "00000"
}

wa.phoneNumbers.verifyCode( body );
```

```javascript
import WhatsApp from 'whatsapp';

const senderNumberId = 12345678901234567890;
const wa = new WhatsApp( senderNumberId );

const body = {
    "code" : "00000"
}

wa.phoneNumbers.verifyCode( body );
```

--------------------------------

### Mark message as read via webhook

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/status.md

Use this pattern to listen for incoming message events and trigger a read status update upon receipt.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

async function custom_callback( statusCode, reqHeaders, body, resp, err )
{
    // Send a 200 so the webhooks service knows you received the message
    if( resp )
    {
        resp.writeHead( statusCode );
        resp.end();
    }

    // Mark message as read
    if( body?.entry[ 0 ].changes[ 0 ].field == "messages" && body.entry[ 0 ].changes[ 0 ].value.messages )
    {
        message_status_read( body.entry[ 0 ].changes[ 0 ].value.messages[ 0 ].id );
    }
}

wa.webhooks.start( custom_callback );
```

--------------------------------

### LocationObject JSON structure

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/types/LocationObject.md

Represents the required and optional fields for defining a location.

```json
{
    "longitude": "37.4850729",
    "latitude": "-122.1527671",
    "name": "Meta Headquarters",
    "address": "1 Hacker Way, Menlo Park, CA 94025, USA"
}
```

--------------------------------

### WhatsApp.messages.image()

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/messages/image.md

Sends an image to a specified recipient. Supports both Meta-hosted images (by ID) and externally hosted images (by URL).

```APIDOC
## WhatsApp.messages.image()

### Description
Sends an existing self-hosted or Meta-hosted image to a recipient. Supported formats are PNG and JPG.

### Method
`wa.messages.image(body, recipient, [replyMessageId])`

### Arguments
- **body** (ImageMediaObject) - Required - The object describing the image to send (contains either 'id' for Meta-hosted or 'link' for self-hosted).
- **recipient** (number) - Required - The recipient's phone number with country code.
- **replyMessageId** (string) - Optional - The received WhatsApp message ID to reply back to.

### Returns
- **Promise** - Resolves with the server response object on success.

### Example
```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );

const meta_hosted_image = {
    "id" : "123456abcde",
    "caption" : "My image"
};

const self_hosted_image = {
    "link" : new URL( "https://example.com/example.png" ).href,
    "caption" : "My image"
};

await wa.messages.image( meta_hosted_image, 12345678901 );
wa.messages.image( self_hosted_image, 12345678901 );
```
```

--------------------------------

### WhatsApp.webhooks.stop()

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/webhooks/stop.md

Stops the web server listening for webhook events. Accepts an optional callback function to handle errors during shutdown.

```APIDOC
## WhatsApp.webhooks.stop()

### Description
Stops the web server listening on the defined port for webhook events.

### Arguments
- **webhook_stop_cb_function** (function) - Optional - A callback function that receives an Error object if the shutdown process fails.

### Returns
- **boolean** - Returns the current running state of the HTTP server.
```

--------------------------------

### Update request timeout in Node.js

Source: https://github.com/whatsapp/whatsapp-nodejs-sdk/blob/main/website/docs/api-reference/whatsapp/update_timeout.md

Sets the request timeout to 15000ms. Requires an initialized WhatsApp instance.

```js
import WhatsApp from 'whatsapp';

const senderNumber = 12345678901234567890;
const wa = new WhatsApp( senderNumber );
const was_timeout_changed = wa.updateTimeout( 15000 );
```
Tokens:
Raw