Getting Started with WhatsApp Cloud API

Introduction

Welcome to the WhatsApp API from Meta.

Individual developers and existing Business Service Providers (BSPs) can now send and receive messages via the WhatsApp API using a cloud-hosted version of the WhatsApp Business API. Compared to the previous solutions, the cloud-based WhatsApp API is simpler to use and is a more cost-effective way for businesses to use WhatsApp. Please keep in mind the following configurations:

| Name | Description | | --- | --- | | Version | Latest Graph API version. For example: v13.0 | | User-Access-Token | Your user access token after signing up at developers.facebook.com. | | WABA-ID | Your WhatsApp Business Account (WABA) ID. | | Phone-Number-ID | ID for the phone number connected to the WhatsApp Business API. You can get this with a Get Phone Number ID request. | | Business-ID | Your Business' ID. Once you have your Phone-Number-ID, make a Get Business Profile request to get your Business' ID. | | Recipient-Phone-Number | Phone number that you want to send a WhatsApp message to. | | Media-ID | ID for the media to send a media message or media template message to your customers. | | Media-URL | URL for the media to download media content. |

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | version | string | Default: 'v13.0' | | environment | Environment | The API environment. Default: Environment.Production | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | accessToken | string | The OAuth 2.0 Access Token to use for API requests. |

HttpClientOptions

| Parameter | Type | Description | | --- | --- | --- | | timeout | number | Timeout in milliseconds. | | httpAgent | any | Custom http agent to be used when performing http requests. | | httpsAgent | any | Custom https agent to be used when performing http requests. | | retryConfig | Partial<RetryConfiguration> | Configurations to retry requests. |

RetryConfiguration

| Parameter | Type | Description | | --- | --- | --- | | maxNumberOfRetries | number | Maximum number of retries. Default: 0 | | retryOnTimeout | boolean | Whether to retry on request timeout. Default: true | | retryInterval | number | Interval before next retry. Used in calculation of wait time for next request in case of failure. Default: 1 | | maximumRetryWaitTime | number | Overall wait time for the requests getting retried. Default: 0 | | backoffFactor | number | Used in calculation of wait time for next request in case of failure. Default: 2 | | httpStatusCodesToRetry | number[] | Http status codes to retry against. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] | | httpMethodsToRetry | HttpMethod[] | Http methods to retry against. Default: ['GET', 'PUT'] |

The API client can be initialized as follows:

const client = new Client({
  timeout: 0,
  environment: Environment.Production,
  accessToken: 'AccessToken',
});

Authorization

This API uses OAuth 2 Bearer token.

List of APIs

• Business Profiles
• Phone Numbers
• Two-Step Verification
• Messages
• Registration
• Media

Classes Documentation

• ApiResponse
• ApiError