Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/green-api/whatsapp-api-webhook-server-python-v2
This library helps you easily create a Python server endpoint to receive WhatsApp message webhooks.
https://github.com/green-api/whatsapp-api-webhook-server-python-v2
whatsapp whatsapp-api whatsapp-api-python whatsapp-python whatsapp-webhook whatsapp-webhook-server
Last synced: 23 days ago
JSON representation
This library helps you easily create a Python server endpoint to receive WhatsApp message webhooks.
- Host: GitHub
- URL: https://github.com/green-api/whatsapp-api-webhook-server-python-v2
- Owner: green-api
- License: other
- Created: 2024-05-31T04:19:01.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-06-06T07:42:11.000Z (7 months ago)
- Last Synced: 2024-10-30T16:12:13.166Z (about 2 months ago)
- Topics: whatsapp, whatsapp-api, whatsapp-api-python, whatsapp-python, whatsapp-webhook, whatsapp-webhook-server
- Language: Python
- Homepage: https://green-api.com/en
- Size: 30.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# whatsapp-api-webhook-server-python-v2
## Support links
[](mailto:[email protected])
[](https://t.me/greenapi_support_eng_bot)
[](https://wa.me/77273122366)
## Guides & News
[](https://www.youtube.com/@greenapi-en)
[](https://t.me/green_api)
[](https://whatsapp.com/channel/0029VaLj6J4LNSa2B5Jx6s3h)
- [Документация на русском языке](https://github.com/green-api/whatsapp-api-webhook-server-python-v2/blob/master/README.ru.md).
`whatsapp-api-webhook-server-python-v2` is a library for receiving and processing webhooks from [green-api.com](https://green-api.com/en/), based on `FastAPI` server.
You should get a registration token and an account ID in your [personal cabinet](https://console.green-api.com/) to use the library. To develop, you can use a free account with the "Developer" tariff.
## API
The documentation for the REST API can be found at the [link](https://green-api.com/en/docs/). The library is a wrapper for the REST API, so the documentation at the link above also applies.
## Authorization
To send a message or perform other Green API methods, the WhatsApp account in the phone app must be authorized. To authorize the account, go to your [cabinet](https://console.green-api.com/) and scan the QR code using the WhatsApp app.
## Examples of preparing the environment
### Example of preparing the environment for Ubuntu Server
#### Updating the system
Update the system:
```shell
sudo apt update
sudo apt upgrade -y
```
#### Firewall
Set up the firewall:
Allow the SSH connection:
```shell
sudo ufw allow ssh
```
Base rules:
```shell
sudo ufw default deny incoming
sudo ufw default allow outgoing
```
Allow HTTP and HTTPS connections:
```shell
sudo ufw allow http
sudo ufw allow https
```
Enable the firewall:
```shell
sudo ufw enable
```
#### Installation
A package management system must be installed:
```shell
sudo apt install python3-pip
```
Library installation:
```shell
python3 -m pip install whatsapp-api-webhook-server-python-v2
```
As an example you can download and run [our script](https://github.com/green-api/whatsapp-api-webhook-server-python-v2/blob/master/examples/receive_all_with_counter.py):
```shell
wget https://raw.githubusercontent.com/green-api/whatsapp-api-webhook-server-python-v2/master/examples/receive_all_with_counter.py
```
```shell
python3 -m receive_all_with_counter.py
```
### Example of preparing the environment for Windows Server
#### Python installation
Python must be installed on the server. [Python installation instructions](https://www.python.org/downloads/).
#### How to configure web server
To use IIS (Internet Information Services) as a web server, you need to configure the configuration file `web.config` so
that the IIS service can properly execute Python code. This file is located in the publication folder of your web
server.
After installing the interpreter, you should define the HttpPlatform handler in the `web.config` file. This handler will
transfer connections to the standalone Python process.
Example configuration file:
```xml
```
- `` - the path to the executable file of the Python interpreter;
- `` - the path to the server executable file (e.g. receive_all_with_counter.py from the example);
- `` - the path to the log file.
You will also need to open the corresponding port to the external network by setting the firewall settings (Advanced
Options -> Rules for incoming connections -> Create Rule -> Rule Type = Port Protocols, Port -> TCP, specify the
firewall settings. options -> Rules for incoming connections -> Create Rule -> Rule Type = Port, Protocols and Port ->
TCP, specify port, Action -> Allow connection).
### How to run example via Docker
The machine should have Docker installed.
To get an image from the Docker Hub, you need to write a command:
```
sudo docker pull greenapi/whatsapp-api-webhook-server-python-v2
```
Run the image in a container with the port and the console displayed:
```
sudo docker run -it -e PORT=8000 -p 80:8000 greenapi/whatsapp-api-webhook-server-python-v2
```
In this case we run a webhook server on `8000` port inside container and proxy our machine's `80` port to internal `8000` container's port
In [personal cabinet](https://console.green-api.com/) you
will need to specify the IP (or external machine name) with this (`80`) port.
After the container is launched, the data on incoming webhooks will be available in the console.
Also you can run it via `docker compose` (from root repo directory):
```
docker compose up --build
```
## Running the server
To use in your solutions, simply import the `GreenAPIWebhookServer` class and init server object.
```python
from whatsapp_api_webhook_server_python_v2 import GreenAPIWebhookServer
def event_handler(webhook_type: str, webhook_data: dict):
# Write webhook handling logic here
...
handler = GreenAPIWebhookServer(
event_handler=event_handler, # Your event handler func (check examples in repo)
host="0.0.0.0", # Your host
port=8080, # Your port
webhook_auth_header=None, # Webhook auth header param (check API console)
)
if __name__ == "__main__":
handler.start()
```
The `event_handler` parameter is a handler function that should be created by the developer.
Method parameters:
| Parameter | Description |
|---------------------|--------------------------|
| `webhook_type: str` | type of incoming webhook |
| `webhook_data: dict`| data of incoming webhook |
Example: [receive_all_with_counter.py](https://github.com/green-api/whatsapp-api-webhook-server-python-v2/blob/master/examples/receive_all_with_counter.py).
Also, if you need to implement webhooks processing logic inside your project yourself, you can use `Pydantic v2` models, which are located in the `webhook_dto.py` file
## How to reroute incoming notifications to a web server
To reroute incoming notifications, you need to set the notification sending address (URL)
in [personal cabinet](https://console.green-api.com/).
## Service methods documentation
[Service methods documentation](https://green-api.com/en/docs/api/)
## License
Licensed under [
Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)
](https://creativecommons.org/licenses/by-nd/4.0/) terms.
Please see file [LICENSE](https://github.com/green-api/whatsapp-api-webhook-server-python/blob/master/LICENSE).