To install the library you can either use pip (latest release version):
pip install whatsapp-python
You can also install the development GitHub version (always up to date):
git clone https://github.com/filipporomani/whatsapp.git
cd whatsapp
python3 setup.py installDocumentation is available in the wiki section on GitHub.
The main reason why I decided to fork the original library is that it uses an old version of the API and doesn't support many features.
In this library I added app events (to listen to incoming messages) and implemented an easier way to send/receive messages and media by creating the Message object.
I fixed some bugs and added some features, but the library still needs a lot of work to be done even if it's working and usable.
- Listening to events (messages, media, etc.)
- Sending messages
- Marking messages as read
- Sending Media (images, audio, video and documents)
- Sending location
- Sending interactive buttons
- Sending template messages
- Parsing messages and media received
To use the WhatsApp API you need to create a Facebook Business account and a WhatsApp Business account.
Tip
To create an account, I recommend to follow this video.
Whereas using third-party providers of the WhatsApp API can result in monthly fees, using the WhatsApp API1 offered directly by Facebook is much cheaper, even if the billing documentation is quite difficult to understand.
Caution
It is now mandatory to add a credit card to the WhatsApp account (at least for me) in order to use the service. I was even charged a fee for using a non-test phone number (~€1.20), so be careful when using the API! I'm not responsible for any costs you may face by using the API.
All the prices are available in the WhatsApp API docs.
Tip
One recommendation I can give you is to use a test number (you can get a free phone number and use it for testing purposes only).
You can ignore this if it's your first time using the library.
- Any version >1.1.2 is incompatible with the original
heyoolibrary! Be careful updating! Read the docs first! - Any version <=1.1.2 is fully compatible with the original
heyoolibrary and doesn't include breaking changes.
Switching from heyoo to whatsapp-python doesn't require any change for versions up to 1.1.2: just uninstall heyoo, install whatsapp-python==1.1.2 and change the import name from heyoo to whatsapp.
For versions GREATER THAN 1.1.2, messages have became objects, so you need to change your code to use the new methods.
Note
Documentation for version 1.1.2 can be found here.
If you are facing any issues or have any questions, please open a new issue!
This is an open source project published under the MIT License.
