PyWa β’ Python wrapper for the WhatsApp Cloud API
PyWa is a Fast, Simple, Modern and easy-to-use asynchronous Python framework for building WhatsApp bots using the WhatsApp Cloud API.
Get Started β’ WhatsApp Client β’ Handlers β’ Filters β’ Updates β’ Flows β’ Examples
- π Fast and simple to use. No need to worry about the low-level details.
- π¬ Send text messages with interactive keyboards, images, videos, documents, audio, locations, contacts, etc.
- π© Receive messages, callbacks, message status updates, etc.
- β»οΈ Create, send and listen to Flows (NEW!)
- π Built-in support for webhooks (Flask, FastAPI, etc.)
- π¬ Filters for handling incoming updates
- π Send and create templates
- β Fully typed, documented and tested
- Create a WhatsApp client and send a message
See Getting Started for more information.
from pywa import WhatsApp
wa = WhatsApp(
phone_id="100458559237541",
token="EAAEZC6hUxkTIB"
)
wa.send_message(
to="9876543210",
text="Hello from PyWa!"
)
- To listen to updates, create a
WhatsApp
client, pass a web server app (FastAPI in this example) and register callbacks:
See Handlers for more information.
# wa.py
from pywa import WhatsApp, filters
from pywa.types import Message, CallbackButton, Button
from fastapi import FastAPI
fastapi_app = FastAPI()
wa = WhatsApp(
phone_id="1234567890",
token="xxxxxxx",
server=fastapi_app,
callback_url="https://yourdomain.com/",
verify_token="xyz123",
app_id=123456,
app_secret="yyyyyy"
)
@wa.on_message(filters.matches("Hello", "Hi"))
def hello(client: WhatsApp, msg: Message):
msg.react("π")
msg.reply_text(
text=f"Hello {msg.from_user.name}!",
buttons=[
Button(
title="Click me!",
callback_data="id:123"
)
]
)
@wa.on_callback_button(filters.startswith("id"))
def click_me(client: WhatsApp, clb: CallbackButton):
clb.reply_text("You clicked me!")
- To run the server, use uvicorn (
pip install "uvicorn[standard]"
):
uvicorn wa:fastapi_app # see uvicorn docs for more options (port, host, reload, etc.)
π« Async Usage
- PyWa has async support! To use the async version, replace all the imports from
pywa
topywa_async
and useasync
/await
:
# wa.py
import fastapi
from pywa_async import WhatsApp, types
fastapi_app = fastapi.FastAPI()
wa = WhatsApp(..., server=fastapi_app)
async def main():
await wa.send_message(...)
@wa.on_message()
async def hello(_: WhatsApp, msg: types.Message):
await msg.react("π")
await msg.reply(...)
uvicorn wa:fastapi_app
- Install using pip3:
pip3 install -U pywa
- Install from source (the bleeding edge):
pip3 install -U git+https://github.com/david-lev/pywa.git
- If you going to use the webhook features, here is shortcut to install the required dependencies:
pip3 install -U "pywa[fastapi]"
pip3 install -U "pywa[flask]"
- If you going to use the Flow features and want to use the default FlowRequestDecryptor and the default FlowResponseEncryptor, here is shortcut to install the required dependencies:
pip3 install -U "pywa[cryptography]"
- Python 3.10 or higher - https://www.python.org
See the Documentation for detailed instructions
Add support for asyncAdd support for more web frameworks (Django, aiohttp, etc.)Add support for flows- Add support for more types of updates (
account_alerts
,phone_number_quality_updates
,template_category_updates
, etc.) - Add more examples and guides
Feel free to open an issue if you have any suggestions. or even better - submit a PR!
This project is licensed under the MIT License - see the LICENSE file for details
Contributions are welcome! Please feel free to submit a Pull Request.