heyoo 0.0.5

Opensource python wrapper to WhatsApp Cloud API

heyoo

UnOfficial python wrapper for WhatsApp Cloud API

UnOfficial Python Wrapper for WhatsApp Cloud API

Features supported

1. Sending messages
2. Sending Media (images, audio, video and documents)
3. Sending location
4. Sending interactive buttons
5. Sending template messages

Getting started

To get started with heyoo, you have to firstly install the libary either directly or using pip.

Installation directly

Use git to clone or you can also manually download the project repository just as shown below;

$ git clone https://github.com/Neurotech-HQ/heyoo
$ cd heyoo
heyoo $ python setup.py install 

Installing from pip

# For Windows 

pip install  --upgrade heyoo

#For Linux | MAC 

pip3 install --upgrade heyoo

Setting up

To get started using this package, you will need a TOKEN and TEST WHATSAPP NUMBER which you can get from Facebook Developer Portal

Here are the steps to follow for you to get started:-

1. Go to your apps
2. create an app
3. Select Business >> Business
4. It will prompt you to enter basic app informations
5. It will ask you to add products to your app a. Add WhatsApp Messenger
6. Right there you will see a your TOKEN, TEST WHATSAPP NUMBER and its phone_number_id
7. Lastly verify the number you will be using for testing on the To field, Verification code will be sent to this phone number via WhatsApp.

Once you have followed the above procedures, now you're ready to start hacking with the Wrapper.

Authentication

Here is how to authenticate your application, you need to specify two things the TOKEN and phone_number_id of your test number

>>> from heyoo import WhatsApp
>>> messenger = WhatsApp('TOKEN',  phone_number_id='104xxxxxx')

Once you have authenticated your app, now you can start using the above mentioned features as shown below:-

Sending Messages

Here is how to send messages;

>>> messenger.send_message('Your message ', 'Mobile eg: 255757xxxxx')

Example

Here is an example

>>> messenger.send_message('Hi there just testiing', '255757902132')

Sending Images

When sending media(image, video, audio, gif or document ), you can either specify a link containing the media or specify object id, you can do this using the same method.

By default all media methods assume you're sending link containing media but you can change this by specifying the link=False.

Here is an example;

>>> messenger.send_image(
        image="https://i.imgur.com/Fh7XVYY.jpeg",
        recipient_id="255757xxxxxx",
    )

Sending Video

Here is an example;

>>> messenger.send_video(
        video="https://www.youtube.com/watch?v=K4TOrB7at0Y",
        recipient_id="255757xxxxxx",
    )

Sending Audio

Here is an example;

>>> messenger.send_audio(
        audio="https://www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3",
        recipient_id="255757xxxxxx",
    )

Sending Document

Here is an example;

>>> messenger.send_document(
        document="http://www.africau.edu/images/default/sample.pdf",
        recipient_id="255757xxxxxx",
    )

Sending Location

Here is an example;

>>> messenger.send_location(
        lat=1.29,
        long=103.85,
        name="Singapore",
        address="Singapore",
        recipient_id="255757xxxxxx",
    )

Sending Interactive buttons

Here is an example;

>>> messenger.send_button(
        recipient_id="255757xxxxxx",
        button={
            "header": "Header Testing",
            "body": "Body Testing",
            "footer": "Footer Testing",
            "action": {
                "button": "Button Testing",
                "sections": [
                    {
                        "title": "iBank",
                        "rows": [
                            {"id": "row 1", "title": "Send Money", "description": ""},
                            {
                                "id": "row 2",
                                "title": "Withdraw money",
                                "description": "",
                            },
                        ],
                    }
                ],
            },
        },
    )

Sending Interactive reply buttons

Here an example;

>>> messenger.send_reply_button(
        recipient_id="255757xxxxxx",
        button={
            "type": "button",
            "body": {
                "text": "This is a test button"
            },
            "action": {
                "buttons": [
                    {
                        "type": "reply",
                        "reply": {
                            "id": "b1",
                            "title": "This is button 1"
                        }
                    },
                    {
                        "type": "reply",
                        "reply": {
                            "id": "b2",
                            "title": "this is button 2"
                        }
                    }
                ]
            }
      },
    )

Sending a Template Messages

Here is how to send a pre-approved template message;

>>> messenger.send_template("hello_world", "255757xxxxxx")

Webhook

Webhook are useful incase you're wondering how to respond to an incoming message sent by user, but I have created a starter webhook which you can then customize it according to your own needs.

To learn more about webhook and how to configure in your Facebook developer dashboard please have a look here.

Issues

If face any issues with the usage of this package please raise one so as we can quickly fix it as soon as possible.

Contributing

This is an opensource project under MIT License so any one is welcome to contribute from typo, to source code, to documentation, JUST FORK IT.

All the credit

1. kalebu
2. All other contributors