API Reference

Requirements

Before you can begin using our WhatsApp API, you need to create an account on this
website. You can sign up here. Once you have an account, you need
to subscribe to one of our billing plans. Feel free to use
our trial plan to get familiar with our WhatsApp API. Later you can change
your plan or subscribe to multiple plans.

To use our WhatsApp API you should have some experience with sending HTTP REST
requests in your preferred programming language.

It is also required that you have a smartphone with a mobile phone number to
install and use WhatsApp. You only need to install WhatsApp.

Nodes

We call our servers node. These nodes will be created automatically on demand
to ensure an automatically scaling system. This will ensure the best performance
for your API requests and keeps the whole system as stable as possible.

We run a management software on every single node. This software communicates with
all the other nodes. The task of the software is the management of the instances and the process of your API requests.

Instances

An instance is a small client that fully controls a WhatsApp Web page. This means
that a single instance can only handle a single WhatsApp phone number. To connect
your phone number with your instance, you should use the
QR-Code endpoint. This endpoint responds with a
QR-Code that you need to scan with your phone in your WhatsApp Business app.

As soon as your app is connected with your instance, our client is able to control
your WhatsApp. Now you are able to send messages and control your WhatsApp
by sending HTTP REST requests to our API. The corresponding node will receive
your request. The node causes the corresponding instance to perform your requested
action and responds with its result.

You are only interacting with our API. The internal processing of your request is not relevant for you as a requester.