yowsup_gateway package

Submodules

yowsup_gateway.exceptions module

exception yowsup_gateway.exceptions.AuthenticationError

Bases: yowsup_gateway.exceptions.YowsupGatewayError

Raised when gateway cannot authenticate with the whatsapp. This means the password for number is incorrect. Check if registration was correct

exception yowsup_gateway.exceptions.ConfigurationError

Bases: yowsup_gateway.exceptions.YowsupGatewayError

Raised when gateway detects and error in configurations

exception yowsup_gateway.exceptions.ConnectionError

Bases: yowsup_gateway.exceptions.YowsupGatewayError

Raised when gateway tries to perform an action which requires to be connected to WhatsApp

exception yowsup_gateway.exceptions.UnexpectedError

Bases: yowsup_gateway.exceptions.YowsupGatewayError

Raised for unknown or unexpected errors.

exception yowsup_gateway.exceptions.YowsupGatewayError

Bases: exceptions.Exception

yowsup_gateway.layer module

exception yowsup_gateway.layer.ExitGateway

Bases: exceptions.Exception

Raised by GatewayLayer to exit stack loop

class yowsup_gateway.layer.GatewayLayer

Bases: yowsup.layers.interface.interface.YowInterfaceLayer

Layer to be on the top of the Yowsup Stack. :ivar bool connected: connected or not connected to whatsapp :ivar list ack_pending: list with incoming ack messages to receive :ivar list inbox: list of received messages from whatsapp :ivar list outbox: list of sent messages to whatsapp

CALLBACK_EVENT = 'org.openwhatsapp.yowsup.prop.callback'

EVENT_SEND_MESSAGES = 'org.openwhatsapp.yowsup.prop.queue.sendmessage'

PROP_MESSAGES = 'org.openwhatsapp.yowsup.prop.sendclient.queue'

check_pending_flow()

on_ack(*args, **kwargs)

Callback function when receiving an ack for a sent message from whatsapp

on_disconnected(*args, **kwargs)

Callback function when receiving a disconnection event

on_failure(entity)

Callback function when there is a failure in a connection to whatsapp server

on_message(*args, **kwargs)

Callback function when receiving message from whatsapp server

on_receipt(*args, **kwargs)

Callback function when receiving receipt message from whatsapp

on_send_messages(*args, **kwargs)

Callback function when receiving event to send messages

on_success(success_protocol_entity)

Callback when there is a successful connection to whatsapp server

yowsup_gateway.layer.connection_required(f)

yowsup_gateway.results module

class yowsup_gateway.results.SuccessfulResult(inbox=None, outbox=None)

Bases: object

An instance of this class is returned from most operations when the request is successful. Get messages exchanged:: if result.is_success:

print [in_message for in_message in result.inbox] print [out_message for out_message in result.outbox]

Variables:

• inbox (list) – received messages from whatsapp
• outbox (list) – sent message to whatsapp

is_success

Returns whether the result from the gateway is a successful response

yowsup_gateway.stack module

class yowsup_gateway.stack.YowsupGateway(credentials, encryption=False, top_layers=None)

Bases: yowsup.stacks.yowstack.YowStack

Gateway for Yowsup in a client API way

Variables:

• result (SuccessfulResult) – List of inbox and outbox messages
• detached_queue (Queue) – Queue with callbacks to execute after

disconnection

execDetached(fn)

execute()

loop(*args, **kwargs)

receive_messages()

Returns messages received from Whatsapp

Returns:list of inbox and outbox messages Return type:SuccessfulResult

It contains exchanged messages with whatsapp.:

received_messages = result.inbox
sent_messages = result.outbox

send_messages(messages)

Send text messages

Parameters:messages – list of (jid, message) tuples Returns:list of inbox and outbox messages Return type:SuccessfulResult

Module contents