Skip to main content

WhatsApp Cloud API Wrapper

Project description

wacpy

Unofficial WhatsApp Cloud API Wrapper
(WIP)

Downloads Supported Versions License Version

📚 About

wacpy aims to be a complete python wrapper for the WhatsApp Cloud API.

⚙ Usage

Currently, wacpy is only providing WhatsApp Cloud API objects.

The 2 main objects are:

📃 Message: (wacpy.types.message.Message)

The Message object is used to craft messages.

🔔 Notification: (wacpy.types.notification.Notification)

The Notification object is the object that gets sent to your webhook.

Images taken from Official WhatsApp Cloud API Refrence

All other sub-objects exist under this 2 types.

🖥 Examples

  • A simple message:
from wacpy.types.message import Message, message # You can also import `message` from `wacpy.types`

Message(
    to='{{WHATSAPP_PHONE_NUMBER}}',
    text=message.Text(
        body="This is a simple message!"
    )
)

image

  • An Image:
from wacpy.types import Message, message # You can also import `message` from `wacpy.types`

Message(
    to='{{WHATSAPP_PHONE_NUMBER}}',
    type='image',
    image=message.Media(
        link='https://i.imgur.com/Zf5eagv.png',
        caption='Some cute cats'
    )
)

image

  • Interactive Button List
from wacpy.types import Message, message # You can also import `message` from `wacpy.types`

Message(
    to='{{WHATSAPP_PHONE_NUMBER}}',
    type='interactive',
    interactive=message.Interactive(
        type='list',
        action=message.interactive.Action(
            button='List',
            sections=[
                message.interactive.Section(
                    title='First Section',
                    rows=[
                        message.interactive.section.Row(
                            id='first_row',
                            title='First Row',
                            description='This is the first row description',
                        ),
                        message.interactive.section.Row(
                            id='second_row',
                            title='Second Row',
                            description='This is the second row description',
                        )
                    ]
                ),
                message.interactive.Section(
                    title='Second Section',
                    rows=[
                        message.interactive.section.Row(
                            id='first_row',
                            title='First Row',
                            description='This is the first row description',
                        ),
                        message.interactive.section.Row(
                            id='second_row',
                            title='Second Row',
                            description='This is the second row description',
                        )
                    ]
                )
            ]
        ),
        body=message.interactive.Body('This is the body text')
    )
)

image

Click here to see more examples (Soon!)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wacpy-0.2.6.tar.gz (32.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wacpy-0.2.6-py3-none-any.whl (59.4 kB view details)

Uploaded Python 3

File details

Details for the file wacpy-0.2.6.tar.gz.

File metadata

  • Download URL: wacpy-0.2.6.tar.gz
  • Upload date:
  • Size: 32.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for wacpy-0.2.6.tar.gz
Algorithm Hash digest
SHA256 c86ee6c040151ada80cc1a2490894654a9994f80d3d15f69b366530e43eab4da
MD5 0c669b6d1f833fc7ce9fd192563f6264
BLAKE2b-256 32d2211013f71266ff8218068a39a6e4dd26d397c7bfd7a9eab55bd270c46773

See more details on using hashes here.

File details

Details for the file wacpy-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: wacpy-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 59.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for wacpy-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 9d9b51559332a47b4fd9f78c4abe22d3f40c3ff617c49654fd6f2ab38b8befc2
MD5 abb2b1fdd61d88fa4a1f3fa7aa41a417
BLAKE2b-256 d77c39f5ffce456628404bc853f388051d1cfc75b90db7053086b016532cb84c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page