Qodex.ai

On-Premises API

Number of APIs: 73

WhatsApp helps more than 2 billion people connect and share with the people they care about. Currently, WhatsApp offers the following products:

  1. Consumer App
  2. Small Business App
  3. Business API

Unlike the consumer app and small business app, the business API is not an app, but a programming language interface that allows you to connect at scale. The WhatsApp Business API is the product being covered on the documentation you are currently browsing.

If you use anything other than the official WhatsApp Business API or other official WhatsApp tools, we reserve the right to limit or remove your access to WhatsApp as this violates our policies. Please do not use any non-WhatsApp authorized third-party tools to communicate on WhatsApp. See Unauthorized use of automated or bulk messaging on WhatsApp for more information.

About the WhatsApp Business Platform API

The WhatsApp Business Platform API allows medium and large businesses to communicate with their customers at scale. Using the API, businesses can connect thousands of agents and bots to interact with customers manually and programmatically. Additionally, the API can be integrated with numerous backend systems, such as CRM and marketing platforms.

Be aware that, to use our API, businesses must complete a series of requirements, including, but not limited to:

Supporting Products

The following products support the implementation of the WhatsApp Business API:

Using the API

There are two methods to use the API:

MethodDescription
Using a BSPIn this case, one of our third-party business solution providers (BSPs) hosts the WhatsApp Business API client. Then, businesses can use the API through their chosen BSP.
Direct IntegrationIn this case, a business directly installs the API client on their servers.

Currently, this implementation is not available for new customers.

Changelog

For information relating to what has changed in the WhatsApp Business Platform, see WhatsApp Business Platform Changelog.

New On-Premises Features and Documentation Updates

WhatsApp Business Platform contains the following updates and changes for version 2.45.1:

For information relating to what has changed in the WhatsApp Business Platform, see WhatsApp Business Platform Changelog.

January 10th 2023 v2.45.1 Release

For businesses on expiring version 2.41.2

To continue using the On-Premise API without disruptions, we strongly recommend that businesses that are still using expiring version v2.41.2 upgrade to v2.43.2 as soon as possible. You will have until January 28, 2023 to upgrade to the new version.

Note that deprecated versions of the API client are no longer supported. Should a client lose connection after the expiration date, the deprecated client will not be able to connect to the server and will not able to send or receive messages.

Database improvements

We have improved the database query execution time by reducing the round trips between client and database server. There are also some new DB indexes to improve performance of some heavy queries on message send path.

Security fixes

We updated key dependencies of On-Premise client and monitoring stack fixing critical vulnerabilities and making prometheus monitoring transport using secure protocol.

Monitoring metric fixes - We have implemented a fix for the out_message_persisted prometheus metric, which stopped working from v2.39.x release.

October 11th 2022 v2.43.1 Release - Contacts Update

Changes to contacts node

As noted above in the notice for developers, responses from 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 volumes.

New API for blocking contacts

We are introducing a new API which will allow businesses to block and report customers who are sending obscene content, using inappropriate language, or harassing businesses’ employees.

The new Contact Requests are located at API Reference>>Contacts and consist of the following:

Media reliability improvements

Improved reliability for media message sends (including template media messages) in cases where the same media is sent at a high throughput, such as during campaigns.

Extended API timeout

The timeout for API requests has been increased to 120 seconds. This is a short-term mitigation to reduce the number of timeouts for operations that are still being processed by the API client.

Incoming contact message fix

Incoming contact messages will now correctly show a contact’s company and department

The associated developer documentation is located at: https://developers.facebook.com/docs/whatsapp/on-premises/reference/contacts.

  1. Guides-Send Messages-Sending Text Messages - Sending Text Messages POST {{URL}}/v1/messages

  2. Guides-Send Messages-Sending Media Messages - Sending Media Messages POST {{URL}}/v1/messages

  3. Guides-Send Messages-Sending Contact and Location Messages - Sending Contacts and Location Messages POST {{URL}}/v1/messages

  4. Guides-Send Messages-Sending Message Templates - Sending Message Templates POST {{URL}}/v1/messages

  5. Guides-Send Messages-Sending Media Message Templates - Sending Media Message Templates POST {{URL}}/v1/messages

  6. Guides-Send Messages-Sending Interactive Message Templates - Sending Interactive Message Templates POST {{URL}}/v1/messages

  7. Guides-Send Messages - Mark Messages as Read PUT {{URL}}/v1/messages/message-id

  8. API Reference-Users - Login Admin POST {{URL}}/v1/users/login

  9. API Reference-Users - Create User POST {{URL}}/v1/users

  10. API Reference-Users - Get Admin GET {{URL}}/v1/users/{{AdminUsername}}