WhatsApp Business On-Premises API
Business looking to use the WhatsApp Business API can host the API client in their own servers, in what we call an "On-Premises" implementation of the API.
Visit our changelog to follow what has changed in the WhatsApp Business API client and AWS Templates.
Get Started
Learn how to set up and install the WhatsApp Business API client, register a phone number, and send a test message.
Learn More
- Client Architecture - Unlike typical REST APIs, the API requires the API Client to be installed and managed by your business. The Client consists of a set of Docker containers, as well as database and media volumes.
- Advanced Setup - Webhooks, backup and restore, two-step verification, monitoring, availabilitya and scaling.
- Installation - The WhatsApp Business API client can be installed as a developer setup for testing using either Docker Compose or Minikube. You can also use Amazon Web Services (AWS) on production systems.
- Migration - Learn how to migrate an existing setup of the WhatsApp Business API client to a new setup using the same phone number.
- Security - Passwords, authentication, SSL configuration, network segregation, encrypted communications, HTTP headers, and the web server TLS protocol as related to the WhatsApp Business API client.
Guides
Send Messages
- Use the
/messagesnode to send messages. Learn how to send: text messages, media messages, contacts and location messages, interactive messages, message templates, media message templates, and interactive message templates. - Mark Messages as Read
Sell Products & Services
Set up and Maintain Your API Client
- Set up and Debug Your Network
- Manage Data and Databases
- Monitor the WhatsApp Business API Client
- Set Up High Availability
- Scale Your API Client With Multiconnect
Troubleshoot Issues
Reference
The WhatsApp Business API uses a REST API Architecture with JSON data formats. The following are the main API root nodes:
| Node | Description |
|---|---|
Register your WhatsApp account | |
Maintain your Certification Authority (CA) certificates for SSL configuration | |
Verify customer phone numbers to generate WhatsApp IDs | |
Check the status of your WhatsApp application | |
Upload, delete, and retrieve media | |
Send text, media, message templates, and other types of messages | |
Collect Webapp metrics | |
Delete messages from the database | |
Set your WhatsApp application, profile, and backup and restore settings | |
Collect Coreapp and database stats | |
Manage first-party and third-party stickerpacks and stickers | |
Get help using the WhatsApp Business API | |
Log in to get your authentication token and manage users |
Webhooks
Webhooks are user-defined HTTP callbacks that are triggered by specific events. Whenever that trigger event occurs, the WhatsApp Business API client sees the event, collects the data, and immediately sends a notification (HTTP request) to the Webhook URL specified in the application settings updating the status of sent messages or indicating when you receive a message.
Learn More
- Webhook Components - All objects you can receive in a webhook notification.
- Inbound Messages Notifications - Get notified when you receive messages from customers.
- Status and Pricing Notifications - Get pricing and status change notifications.