An unoffical Python API for connecting with the WhatsApp chat protocol.

Clone this repository, and install it via python setup.py install.

The API is callback driven and easy to use. It interfaces with version 1.5 of the WhatsApp protocol. You should provide your own number and secret, which you can intercept from a real phone.

Example code is provided below. It registers three callbacks.

import whatsappy

# Create instance
client = whatsappy.Client(number=<number>, secret=<secret>, nickname=<nickname>)

# Callbacks handlers
def on_message(node):
    message = node.child("body").data
    sender = node["from"]

    # Print response to terminal
    print "%s: %s" % (sender, message)

    # Reply
    if "-" not in sender:
        client.message(sender, message)

def on_presence(node):
    print "%s is %s" % (node.get("from"), node.get("type", "online"))

def on_chat_state(node):
    if node.children[0].name == "composing":
        print "%s is typing" % node.get("from")
    else:
        print "%s stopped typing" % node.get("from")

# Register callbacks
client.register_callback(
    whatsappy.TextMessageCallback(on_message, single=True, group=True),
    whatsappy.PresenceCallback(on_presence, online=True, offline=True),
    whatsappy.ChatStateCallback(on_chat_state, composing=True, paused=True)
)

# Start it all
client.connect()

One can examining of raw messages by turning on debug. Other messages are logged via Python's default logger.

client.debug = True

This module does not provide any method to generate a login secret. You should provide it yourself, e.g. intercept it from your phone.

The unit tests can be invoked via python -m unittest discover tests '*.py'

Released under the MIT License

Copyright (C) 2012 Paul Hooijenga (Original author, https://github.com/hackedd)

Copyright (C) 2014-2015 Bas Stottelaar

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

WhatsApp is a registered trademark of WhatsApp Inc. registered in the U.S. and other countries. This project is an independent work and has not been authorized, sponsored, or otherwise approved by Whatsapp Inc.