#WhatsApp On-Premises API (deprecated)
Number of APIs: 75
|
WhatsApp On-Premises API is deprecated. Please use WhatsApp Cloud API, hosted by Meta, instead.
See our On-Premises API Sunset document for a complete deprecation timeline and links to documents that can help you migrate from On-Premises API to Cloud API, if you are already using On-Premises API. |
|---|
About the API
WhatsApp helps more than 2 billion people connect and share with the people they care about. Currently, WhatsApp offers the following products:
- Consumer App
- Small Business App
- Business API
Unlike the consumer app and small business app, On-Premises API is not an app, but a programming language interface that allows you to connect at scale. This collection contains common queries, sample responses, and links to supporting documentation for the On-Premises API .
If you use anything other than the official On-Premises 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.
To use On-Premises API, businesses must complete a series of requirements, including, but not limited to:
- Following WhatsApp's legal policies , including the WhatsApp Commerce Policy and the WhatsApp Business Policy .
- Going through Business Verification .
- Following our Display Name Guidelines .
Supporting Products
The following products support the implementation of the On-Premises API:
- Business Management API : Used to programmatically manage WhatsApp Business Account assets.
- Embedded Signup : Used by Solution Partners to simplify the onboarding of new businesses to the API.
Using the API
There are two methods to use the API:
| Method | Description |
|---|---|
| Using a Solution Partner | One of our third-party Solution Partners hosts the On-Premises API client. Then, businesses can use the API through their chosen partner. |
| Direct Integration |
Businesses directly install the API client on their servers.
Currently, this implementation is not available for new customers. |
-
API Reference-Metrics And Statistics - Get App Stats Prometheus Format GET {{URL}}/v1/stats/app?format=prometheus
-
Guides-Send Messages-Sending Message Templates - Sending Message Templates POST {{URL}}/v1/messages
-
Guides-Send Messages-Sending Text Messages - Sending Text Messages POST {{URL}}/v1/messages
-
Guides-Send Messages-Sending Media Messages - Sending Media Messages POST {{URL}}/v1/messages
-
Guides-Send Messages-Sending Contact and Location Messages - Sending Contacts and Location Messages POST {{URL}}/v1/messages
-
Guides-Send Messages-Sending Media Message Templates - Sending Media Message Templates POST {{URL}}/v1/messages
-
Guides-Send Messages-Sending Interactive Message Templates - Sending Interactive Message Templates POST {{URL}}/v1/messages
-
API Reference-Users - Get User GET {{URL}}/v1/users/{{UserUsername}}
-
API Reference-Users - Create User POST {{URL}}/v1/users
-
API Reference-Users - Update User PUT {{URL}}/v1/users/{{UserUsername}}