waappa-sdk 0.1.2

Official Python SDK for the Waappa API.

Waappa Python SDK

Official Python SDK for the Waappa API.

Installation

pip install waappa-sdk

Requires Python 3.9 or newer.

Quick Start

from waappa import WaappaClient

waappa = WaappaClient(
    api_key="waappa_session_api_key",
    session="default",
)

waappa.send_text(
    chatId="[e-mail]",
    text="Hello from Waappa",
)

The SDK sends the API key as the Authorization header. By default it uses:

https://api.waappa.com

Use base_url for local or private deployments:

waappa = WaappaClient(
    api_key="waappa_session_api_key",
    session="default",
    base_url="http://localhost:3001",
)

Messages

waappa.send_image(
    chatId="[e-mail]",
    caption="Invoice",
    file={
        "mimetype": "image/jpeg",
        "filename": "invoice.jpg",
        "url": "https://example.com/invoice.jpg",
    },
)

waappa.send_poll(
    chatId="[e-mail]",
    poll={
        "name": "Choose one",
        "options": ["A", "B"],
        "multipleAnswers": False,
    },
)

Supported message helpers:

• send_text
• send_image
• send_voice
• send_video
• send_file
• send_poll
• send_list
• send_contact_vcard
• send_location
• send_event
• edit_message
• delete_message
• get_messages
• download_message_media

Media Upload

uploaded = waappa.upload("invoice.jpg")

Use the returned URL in send_image, send_video, send_voice, or send_file.

Media Download

media = waappa.download_message_media("[e-mail]_3EB0...")

The response contains url, size_bytes, and content_type. The URL is stored in Waappa temporary media storage and can be used like an uploaded media URL.

Groups, Contacts, Labels, LIDs, Channels

waappa.create_group("Support", ["[e-mail]"])

contacts = waappa.list_contacts()
labels = waappa.list_labels()
channels = waappa.list_channels()

The client includes helpers for the selected Waappa API surface: groups, group participants, contacts, labels, LID/phone resolution, and channels.

Admin / Session Management

Session management methods require a master key:

admin = WaappaClient(api_key="mk_live_...")
sessions = admin.list_sessions()

Errors

Failed API responses raise WaappaError:

from waappa import WaappaError

try:
    waappa.send_text(chatId="bad", text="Hello")
except WaappaError as error:
    print(error.status)
    print(error.data)

Development

python -m compileall waappa
python -m pip wheel . --no-deps -w dist

Publishing

python -m build
python -m twine upload dist/*

Before publishing, run a smoke test against a real Waappa API key and session.