The REST API allows you to receive and send messages through your WhatsApp account.
Parameters in GET queries pass query string. Parameters in POST requests — through the JSON-encoded request body. The authorization token is always passed to query string (?token=xxxxxx).
The WhatsApp API is based on the WhatsApp WEB protocol and excludes the ban both when using libraries from mgp25 and the like. Despite this, your account can be banned by anti-spam system WhatsApp after several clicking the "block" button.Get an API key
At the very beginning, we need to connect whatsapp with our script, so as we write the code, we check its operation. To do this, go to your personal account and get a QR code there. Next, open WhatsApp on your smartphone, go to Settings -> WhatsApp Web -> Scan a QR code.
Now we need to indicate a WebHook URL so the server can run the scrip when new messages arrive. Indicate a direct link to your script, e.g. https://domain.com/PHP/whatsappbot.php. You can’t indicate server IP only, but you can indicate the port.
The generated code has dependencies over external libraries like UniRest. These dependencies are defined in the
composer.json file that comes with the SDK.
To resolve these dependencies, we use the Composer package manager which requires PHP greater than 5.3.2 installed in your system.
Visit https://getcomposer.org/download/ to download the installer file for Composer and run it in your system.
Open command prompt and type
composer --version. This should display the current version of the Composer installed if the installation was successful.
composer.json) for the SDK.
composer install. This should install all the required dependencies and create the
vendordirectory in your project directory.
CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:
[curl]; A default value for the CURLOPT_CAINFO option. This is required to be an ; absolute path. curl.cainfo = PATH_TO/cacert.pem
The following section explains how to use the WhatsappAPI library in a new project.
Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Open in PhpStorm to browse to your generated SDK directory and then click
Create a new directory by right clicking on the solution name as shown below:
Name the directory as "test"
Add a PHP file to this project
Name it "testSDK"
Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.
It is important that the path inside require_once correctly points to the file
autoload.php inside the vendor directory created during dependency installations.
After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.
To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.
PHP from within
Languages & Frameworks
Browse for Interpreters near the
Interpreter option and choose your interpreter.
Once the interpreter is selected, click
To run your project, right click on your PHP file inside your Test project and click on
Unit tests in this SDK can be run using PHPUnit.
vendor\bin\phpunit --verbosefrom commandline to execute tests. If you have installed PHPUnit globally, run tests using
You can change the PHPUnit test configuration in the