Deprecated versions are not supported anymore and will soon not be allowed to send messages. Please keep your WhatsApp Business API Client installation updated.
Version | Date Introduced | Changes |
---|---|---|
|
Feb 06, 2024 |
|
|
Jan 09, 2024 |
|
|
Dec 21, 2023 |
|
|
Nov 8, 2023 |
|
|
Nov 8, 2023 |
|
|
Oct 10, 2023 |
|
|
Sep 26, 2023 |
|
|
Sep 15, 2023 |
|
|
Aug 11, 2023 |
|
|
July 31, 2023 |
|
|
July 28, 2023 |
|
|
July 11, 2023 |
|
|
July 4, 2023 |
|
|
June 21, 2023 |
|
|
May 22, 2023 |
|
|
May 22, 2023 |
|
|
May 15, 2023 |
|
|
May 15, 2023 |
|
|
April 11, 2023 |
|
|
March 24, 2023 |
|
|
March 17, 2023 |
|
|
March 9, 2023 |
|
|
January 10, 2023 |
|
|
November 24, 2022 |
|
|
October 11, 2022 |
|
|
Sep 19, 2023 |
|
|
June 27, 2022 |
|
|
May 10, 2022 |
|
|
Mar 25, 2022 |
|
|
Mar 4, 2022 |
|
|
Feb 1, 2022 |
|
|
Mar 26, 2022 |
|
|
Sep 30, 2021 |
|
|
Jun 28, 2021 |
|
|
May 26, 2021 |
|
|
Mar 10, 2021 |
|
|
Feb 23, 2021 |
|
|
Nov 13, 2020 |
|
|
Oct 20, 2020 |
|
|
Aug 11, 2020 |
|
|
Jul 27, 2020 |
|
|
Jul 17, 2020 |
|
|
Jul 27, 2020 |
|
|
Apr 17, 2020 |
|
|
Apr 8, 2020 |
|
|
Mar 4, 2020 |
|
|
Feb 4, 2020 |
|
|
Jan 6, 2020 |
|
|
Nov 13, 2019 |
|
|
Oct 7, 2019 |
|
|
Sep 9, 2019 |
|
|
Aug 26, 2019 |
|
|
Sep 9, 2019 |
|
|
Jun 18, 2019 |
|
|
Apr 29, 2019 |
|
|
Jan 24, 2019 |
|
|
Nov 13, 2018 |
|
|
Oct 24, 2018 |
|
|
Sep 24, 2018 |
|
|
Jul 24, 2018 |
|
|
Jul 18, 2018 |
|
|
Jun 15, 2018 |
|
|
May 10, 2018 |
|
|
Apr 18, 2018 |
|
|
Apr 16, 2018 |
|
|
Apr 3, 2018 |
|
|
Mar 29, 2018 |
|
|
Mar 22, 2018 |
|
|
Mar 14, 2018 |
|
|
Mar 5, 2018 |
|
|
Feb 26, 2018 |
|
|
Feb 10, 2018 |
|
|
Jan 31, 2018 |
|
|
Jan 22, 2018 |
|
|
Jan 10, 2018 |
Version 2.53.2
is now available and includes:
Version 2.53.1
is now available and includes:
Please make sure to read the backwards incompatible changes for the v2.51 series before upgrading to this version.
Version 2.51.3
is now available and includes:
v2.51.1
and v2.51.2
.Please make sure to read the backwards incompatible changes for the v2.51 series before upgrading to this version.
Version 2.51.2
is now available and includes:
Version 2.49.6
is now available and includes:
Backwards incompatible changes for v2.51.*
:
Starting with 2.51.1
, the future API versions require AVX2 support. This excludes older AWS instance types that use PV AMIs (C1, C3, M1, M3, M2, and T1), VMWare ESXi 5.x and older, and CPUs older than Intel Haswell/AMD Zen1. The supported CPU flags can be checked at /proc/cpuinfo
file.
Docker 20.10.10 and later is required due to a docker bug that prevents coreapp from starting.
Standalone DB upgrades are not currently supported in 2.51.1. Please skip the db upgrade step and deploy the updated version directly. There are no schema updates in this version from 2.49.
Version 2.51.1
is now available and includes:
Version 2.49.5
is now available and includes:
Version 2.49.4
is now available and includes:
v2.49.1
, v2.49.2
and v2.49.3
(the v2.47.x
series is not affected by this issue).Version 2.49.3
is now available and includes:
Version 2.49.2
is now available and includes:
Backwards incompatible changes for v2.49.1
For beta users of Location Messages , name and address are now required as part of GA.
Version 2.49.1
is now available and includes:
Version 2.47.8
is now available and includes:
Version 2.47.7
is now available and includes:
Version 2.47.6
is now available and includes:
New (Jun 22, 2023): This version is affected by a bug overcharging businesses on free entry point conversations . Please upgrade to v2.47.6 version to fix this issue.
Version 2.47.3
is now available and includes:
Version 2.45.5
is now available and includes:
New (Jun 22, 2023): This version is affected by a bug overcharging businesses on free entry point conversations . Please upgrade to v2.47.6 to fix this issue.
Version 2.47.2
is now available and includes:
Version 2.45.4
is now available and includes:
New (Jun 22, 2023): This version is affected by a bug overcharging businesses on free entry point conversations . Please upgrade to v2.47.6 to fix this issue.
Version 2.47.1
is now available and includes:
Version 2.45.3
is now available and includes:
ENABLE_IPV6=false
on the webapp container to disable).Version 2.43.3
is now available and includes:
Version 2.45.2
is now available and includes:
Backwards incompatible changes for v2.45.1
:
The cert
field will now be mandatory
, so please update your integration to always include a valid cert when calling the shards
node.
sent_status
is deprecated, so please update your integration to use the webhooks
object
in the application node for all webhook controls.
recipient_id
is removed in the statuses
object, so please update your integration to use recipient_id
under the message
object
.
The 2.45.1
version of our Business API client is available today and includes:
WA_SKIP_SSL_VERIFICATION
is going to be used to enable, and disable ssl verification. Valid values are TRUE
or FALSE
.WA_SSL_CA_PATH
gives the path to the certificate which can be used to verify the webapp certificate used by the businesses. This is useful if businesses are using a self-signed certificate or certificate that was signed using their own Certificate Authority. The path here should be accessible from the container so it needs to added as a volume. If WA_SKIP_SSL_VERIFICATION
is set to TRUE
, this value is ignored.out_message_persisted
prometheus metric has been fixed and is working againsent
status webhook notification media_id
in the message sent
status webhook notification
for all media messages.The 2.43.2
version of our Business API client is available today and includes:
v2.43.1
release which caused deleted message status webhook notifications to not be delivered. No other internal clean-up procedures were impacted except for sending this webhook notification in v2.43.1
Even though v2.43.2
is recommended, if you are already on v2.43.1
and do not use the deleted message status webhook notification, there is no need to upgrade to v2.43.2
.
Please upgrade to v2.43.2
if you are on v2.41.x.
Backwards incompatible changes for v2.43.1
:
v2.43
, there will be changes to the behavior of the contacts
endpoint
status
will change
. Regardless of whether a user has WhatsApp, it will always return valid
for status
in the response and a wa_id
. There is no guarantee that the returned wa_id
will be valid. These changes are applicable for both direct responses, as well as webhook responses for non-blocking callsstatus
and wa_id
returned in the contacts
node. In addition, sending a message
on v2.39.1
or higher can be completed without calling the contacts
node1013
User is not validerror when trying to send a template message, which will be returned if you attempt to send the template message to a phone number without a WhatsApp account470
error through a webhook responseThe 2.43.1
version of our Business API client is available today and includes:
contacts
node contacts
requests will no longer provide status information about a phone number
. contacts
can still be used to preload contact information before sending a message to the number. This can improve send message performance when sending messages in large volumesmessage_receipt_log
The 2.41.3
version of our Business API client includes:
message_receipt_log
that could benefit partners with high throughput needs (sending more than 200 messages / second)In v2.41.2, we are introducing DB schema changes to improve the performance of the system. As a result, upgrades from v2.37.2 and v2.39.x for set ups with large databases which have millions of message and contact entries will take longer than usual.
Generally, perform upgrades during off-peak hours and upgrade lower-throughput setups first.
For large databases, follow these steps:
Run garbage collection via the /services/message/gc endpoint before your upgrade, and ensure it completes successfully
Please use the dbupgrade tool to upgrade the DB schemas prior to the version upgrade. Once done, you will be able to upgrade API versions with minimal down time. It is strongly recommended to bring the API client down before using the dbupgrade tool. Ensure the dbupgrade tool completes successfully (exit code 0), and avoid or limit API requests while the uprgade is taking place
We recommend increasing the query timeout on your database servers to one hour, until the upgrade completes successfully.
The 2.41.2
version of our Business API client includes:
delivered
and read
webhook notifications which gives them greater control over webhook notifications for messages. This can be achieved through the settings/applications
endpointnamespace
field is optional for the template object
caption
property is limited to 1024 characters
This change only applies to captions on media messages being sent on v2.41.2
. There is no impact on previously sent messages with other versions. No character limitations have been introduced on other message typesThis client version contains all features and fixes shipped with v2.39.1
. Additionally, this release:
v2.39.2
.
v2.39.3
.
v2.39.4
is installed, businesses will get notified they received a disappearing message by a webhooks notification with type set to "ephemeral"
. Businesses will not be able to see the message's content.When we launched v2.39.3
, the disappearing messages issue was handled by WhatsApp automatically disabling these messages in the chat thread with the client. For v2.39.4
, we will not do that. With this version, businesses that receive disappearing messages must ask the customer to disable disappearing messages and resend their latest message.
The v2.39.3
version of our Business API client is available for developers today. The new client includes two fixes and additional logs to support debugging. The two fixes are:
Fixed bug that prevented video messages from being sent under certain circumstances.
The 2.39.1
version of our Business API client is available for developers starting today. The new client includes:
1031
.hsm
type and the webhook_payload_conversation_pricingmodel_disabled
application setting
.Starting with the new API client version, you may provide your phone’s certificate when you are setting up multiconnect. That means that, when calling the /v1/account/shards endpoint, you can add the Base64-encoded certificate in the cert field. See Scale Your API Client With Multiconnect for information.
We have added graph.whatsapp.com
to the list of WhatsApp server hostnames that the Business API client requires connectivity to. See Set Up and Debug Your Network, Hostnames
for information.
With v2.39
, we have added error code 1031
. You will get this error if your account has been locked and can’t send any messages due to an integrity policy violation. See Error and Status Messages
and Policy Enforcement
for information.
hsm
type has been deprecated with v2.39
. You should use the template
type instead.webhook_payload_conversation_pricingmodel_disabled
has been deprecated.Some video messages fail to send under certain circumstances.
This version contains the same features as v2.37.1
, but there's a different expiration date. v2.37.2
expires on Sep 22, 2022.
Some Kubernetes developers may see CrashLoopBackOff
for their webapp container and their container may fail to start. To fix that, add following line in the Kubernetes deployment YML
file under webapp configuration:
command: ["/opt/whatsapp/bin/wait_on_mysql.sh", "/opt/whatsapp/bin/launch_within_docker.sh"]
This new version of the API introduces:
/settings/business/compliance_info
).statuses
object
.This version of the API introduces two new types of interactive messages: Single Product Messages and Multi-Product Messages. Users that receive these messages can view products, add them to a shopping cart, and send the cart back to businesses.
Both Multi and Single Product Messages lend themselves best to user experiences that are simple and personalised, where it’s a better experience to guide the customer to a subset of items most relevant to them, rather than browsing a full catalog. They work best when combined with navigation tools like natural language processing, text search or List Messages and Reply Buttons to get to what the customer is looking for fast. See Commerce Guides for more information.
API businesses in India ( +91
phone number) can start integration from today, but will only be able to send Multi-Product or Single Product messages after 15 November 2021. The Laws enacted by the Department of Consumer Affairs in India require you to provide additional information to customers in your Business Profile and Product Detail Pages.
With the WhatsApp Business API v2.37, businesses in India also gain access to the /settings/business/compliance_info
endpoint. See more information here
.
We have previously announced that the WhatsApp Business API will switch from a notification-based pricing model to a conversation-based pricing (CBP) model on February 1, 2022 . To support your efforts in getting ready for the new pricing system, this version of the API introduces new webhook fields. The webhooks field listed below will only start showing up on your webhooks on February 1, 2022.
Component | Updates with v2.37
|
---|---|
New fields: |
|
New field: |
|
|
The new origin object describes where a conversation has originated from. This object includes the |
See examples of the new webhooks here .
The webhooks statuses
object
now includes a type
field. Currently, the only supported type is "message"
.
hsm
type will be deprecated when we launch the WhatsApp Business API v2.39
. You should use the template
type instead.webhook_payload_conversation_pricingmodel_disabled
will be disabled on February 1, 2022."NBP"
webhook field under pricing_model
will also be deprecated.billable
flag that was added for the Mexico conversation-based pricing test is scheduled to be deprecated as early as March 2022. We recommend that you stop using this field before upgrading to the next version.Fixes:
This version of the API allows you to send interactive messages, which includes list messages and reply button messages. These new features give users a simpler way to find and select what they want from your business during an interaction on WhatsApp. During testing, chatbots using interactive messaging features achieved significantly higher response rates and conversions compared to those that are text-based.
The following messages are considered interactive:
At the API level, interactive messages are set by specifying a message’s type
to interactive
and adding the interactive
object. Generally, these messages include 4 main parts: header
, body
, footer
, and action
.
For more information, see our Sending Interactive Messages guide.
The ttl
parameter has been deprecated. Moving forward, any POST
requests to /messages
that include this field will return an error message. Previously, this field was only accepted for messages of type hsm
and template
Starting with v2.35, you can no longer re-enable the pass_through
setting
for WhatsApp Business API Clients.
php 7.4
, openSSL 1.1.1
, and Lighttpd 1.4.55
.Starting April 21, 2021, as part of API v2.33, businesses will have access to the In-Thread Context feature for ads that click to Whatsapp. With In-Thread Context, a consumer can easily reference the ad they tapped on, and a business can understand which messages come from which ads, making the first interaction more convenient, personal and efficient.
Initial tests have shown In-Thread Context to increase the number of conversations and reduce the cost per conversation.
In order to enable In-Thread Context, the business or Business Service provider that is hosting API v2.33 needs to update their inbound webhooks integration to read a new 'referral' property added to inbound messages by April 21.
After April 21, consumers will be able to send the In-Thread Context via message attachment, containing the header, body image and video related to the ad.
If the advertiser does not complete the above updates by April 21, they will not be able to receive the attachment, and will miss important context on what the customer is messaging about. The consumer will see the ad context, and will expect the business to as well.
Since February 1, 2021, we have been testing a new pricing model for the WhatsApp Business API that impacts businesses messaging users with a Mexico phone number.
To support this effort, some message webhooks notifications now include the new conversation
and pricing
objects —only messages with status sent
, delivered
, and read
are impacted. For more information, see Message Status Notifications
.
/v1/settings/application
response to display the config
setting for automatic garbage collectionroot
v2.29.3
involves ensuring all pre-existing media volumes have modified ownership to the root
user to ensure seamless operation in v2.29.3
. This specifically impacts businesses that are running v2.29.1
, v2.29.2
, or attempted to upgrade to those versions recently.Please follow our recommendation guides to upgrade to v2.29.3
:
In v2.29.x
, in order to support running containers more securely, we have modified the permissions of data volumes.
Depending on the pre-existing size of these volumes (media), the upgrade process could cause additional downtime of the Webapp container.
We recommend upgrading to v2.29.3
instead.
Please note that both v2.29.2
and v2.27.13
will be available until Dec 9, 2020.
In v2.29.x
, in order to support running containers more securely, we have modified the permissions of data volumes.
Depending on the pre-existing size of these volumes (media), the upgrade process could cause additional downtime of the Webapp container.
We recommend upgrading to v2.29.3
instead.
forwarded
and frequently_forwarded
are added for inbound notifications from consumers.
These can be used to detect whether incoming message is forwarded, frequently forwarded, or not./stats
and /metrics
nodes.on_call_pager
parameter is deprecatedhsm
object
pass_through
is disabled by default
pass_through
enabled — Automatic database garbage collection is enabledpass_through
disabled — It is recommeneded to enable automatic garbage collection to manage the database/services/message/gc
endpoint to perform database garbage collection if users want to disable automatic garbage collection
pass_through
enabled. Known Issue:Using dbupgrade-compose.yml
to upgrade MySQL to v2.27.8
may fail. Refrain from using dbupgrade-compose.yml
for now. The product upgrading procedure outlined in the production setup documentation
still works, but not the upgrading MySQL procedure. An upcoming patch release will address this issue.
force_check
parameter
/v1/contacts
API call in async mode, the results can be posted to the callback server without having to poll the check contacts status
fallback
language policy is deprecated for sending message templates
health
API calls
to help monitor multiple deployments of WhatsApp Business API clients health
endpoint is set to 10 per secondThe following security vulnerabilities impact the v2.25.1 Coreapp image. The next patch release will include fixes.
If you are using High Availability/Multiconnect setup, you will see "Bad response received from health check" error in WhatsApp Web Business Tool when you use v2.23.4
.
This is a known issue, and we are working hard to fix it. This doesn't affect other functionalities such as sending messages or checking contact via the WhatsApp Business API, yet we advise you NOT to use/upgrade to v2.23.4
if you are using High Availability/Multiconnect setup and WhatsApp Web Business Tool. Single instance setups will NOT be affected.
471
, 472
, etc.)filename
in addition to the caption
field that the user will see when they attempt to download the document
filename
provided by the sender will now also be shared in the callback in addition to the caption
field
callback_requests
replaced with callback_requests_duration_ms_count
and callback_requests_duration_ms_sum
metric out_message_received_by_server
, out_message_received_by_target
, out_message_received_by_target_read
, out_message_sent
replaced with out_message_status
The following security vulnerabilities impact v2.23.4 images. The next patch release will include fixes.
GET /v1/settings/business/profile
to return as empty/v1/contacts
did not return info500
returned when sending JPEG images500: Internal Server Error
was returned./etc/hosts
. Please note that if WA_DB_HOSTNAME is IPV4 address, it works fine.This version has issues in both AWS and On-Premises. Please do NOT not upgrade to 2.19.3. If you want to upgrade, please use 2.19.4. If you have already upgraded to 2.19.3 with On-Premises setup it might prevent you from restarting in some cases so consider upgrading to 2.19.4 at the earliest.
format=prometheus
{ "webhooks": { "ignore_ssl_errors": true, "url": "https://webhook_endpoint" } }
WhatsApp Enterprise Application v2.18.22 is the last release that will support the legacy PHP API!
wa_id
only for valid contacts.data
and media
).type
which is the indicates the type of message.media_url_prefix
logic so that replacing "media.hostname.com"
with IP address of web container will point to incoming media file.conversation
and now using text
for message field.Version | Date Introduced | Changes |
---|---|---|
|
June 20, 2018 |
|
|
June 12, 2018 |
|
|
May 10, 2018 |
|
|
Mar 27, 2018 |
|
|
Feb 16, 2018 |
|
|
Feb 10, 2018 |
|
|
Jan 23, 2018 |
|
|
Jan 11, 2018 |
|
|
Dec 21, 2017 |
|
|
Dec 11, 2017 |
|
|
Dec 6, 2017 |
|
|
Oct 31, 2017 |
|
|
Oct 1, 2017 |
|
|
Sept 19, 2017 |
|
|
Sept 18, 2017 |
|
|
July 31, 2017 |
|
|
July 25, 2017 |
|
|
July 10, 2017 |
|
|
June 21, 2017 |
|
|
June 10, 2017 |
|
|
May 11, 2017 |
|
|
May 1, 2017 |
- |
wadockersetup
script now has an upgrade command.pass_through
to set settings script.What's included in the AWS (Amazon Web Services) - Cloud Formation (CFN) templates:
Release Version | Date Introduced | Changes |
---|---|---|
|
Apr 27, 2021 |
|
|
Mar 26, 2020 |
|
|
Jan 29, 2020 |
|
|
Aug 19, 2019 |
|
|
Sep 3, 2018 |
|
|
Aug 22, 2018 May 18, 2018 ( Beta) |
|
|
April 26, 2018 |
|
|
April 26, 2018 |
|
|
January 31, 2018 |
|
|
December 22nd, 2017 |
|
|
Sept 13th, 2017 |
|
|
June 23rd, 2017 |
DB Idle Connection Timeout
to 180000
millisecondsIt's recommended to use WhatsApp Business API client version v2.18.20 or later. This template mightwork with prior releases, though we don't recommend it.
This template requires WhatsApp Business API client version v2.18.14 or later. This template will notwork with prior releases.
The Lambda template is created and used for security enhancement. This stores the sensitive information securely (i.e., encrypted) in a parameter store and retrieves it inside the container. We might add more functions in future or remove it, if this is supported in CFN templates.
This template requires WhatsApp Enterprise client version v2.18.14 or later. This template will notwork with prior releases.
Note:Please use experimental/beta features with caution. It's highly recommended to work with WhatsApp team closely when using these features so that we can support you quickly, if there are any issues.
WhatsApp Enterprise client doesn't work when HA is disabled. This will be addressed in next WhatsApp Enterprise Client release.
Details | First present in | Fixed in |
---|---|---|
Using |
|
|
Potential memory leaks |
|
|
Video preview thumbnails are not correctly generated on the receivers phone client |
> |
|
More database connections than necessary are opened |
> |
|