Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/t0mer/green-api-custom-notifier

Send whatsapp notification using green API
https://github.com/t0mer/green-api-custom-notifier

greenapi home-assistant home-automation python3 whatsapp whatsapp-bot

Last synced: 3 days ago
JSON representation

Send whatsapp notification using green API

Host: GitHub
URL: https://github.com/t0mer/green-api-custom-notifier
Owner: t0mer
License: apache-2.0
Created: 2024-04-01T10:59:55.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-08-13T12:50:58.000Z (4 months ago)
Last Synced: 2024-11-27T13:21:26.914Z (25 days ago)
Topics: greenapi, home-assistant, home-automation, python3, whatsapp, whatsapp-bot
Language: Python
Homepage:
Size: 960 KB
Stars: 40
Watchers: 2
Forks: 4
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# green-api-custom-notifier

[green-api](https://green-api.com/en) is a service that allows us to send and receive text, photo and video using stable WhatsApp API gateway. The service includes free account that can be used to send notifications to 3 chats (Group or Private) and many more.

[green-api-custom-notifier](https://github.com/t0mer/green-api-custom-notifier) is a [Homeassistant ](https://www.home-assistant.io/) custom notification component that enables us to send notification to Whatsapp groups using [green-api](https://green-api.com/en).

## Limitations
* The free account is limited to 3 chats (Group or Private).

## Getting started

### Setup Green API account
Nevigate to [https://green-api.com/en](https://green-api.com/en) and register for a new account:
![Register](screenshots/register.png)

Fill up your details and click on **Register**:
![Create Account](screenshots/create_acoount.png)

Next, click on the "Create an instance":
![Create Instance](screenshots/create_instance.png)

Select the "Developer" instance (Free):
![Developer Instance](screenshots/developer_instance.png)

Copy the InstanceId and Token, we need it for the integration settings:
![Instance Details](screenshots/instance_details.png)

Next, Lets connect our whatsapp with green-api. On the left side, Under API --> Account, click on QR and copy the QR URL to the browser and click on "Scan QR code"

![Send QR](screenshots/send_qr.png)

![Scan QR](screenshots/scan_qr.png)

Next, Scan the QR code to link you whatsapp with Green API:

![QR Code](screenshots/qr.png)

After the account link, you will notice that the instance is active by the green light in the instance header:
![Active Instance](screenshots/active_instance.png)

### Getting the Contacts and Groups
Before we can start messaging, we need to get the Contact/Group details. we can do it using Green API endpoint.
On the lef side, Under API --> Service methods, click on "getContacts" and then click "Send":
![Get Contacts](screenshots/get_contacts.png)

As a result, you will get the list of Contacts and Groups.
* The contact number ends with **@c.us**
* The group number ends with **@g.us**

![Contacts Lists](screenshots/contacts_list.png)

Write down the Id, you will need it to configure the notification.

### Setting up the notification in Home Assistant

Download the [green-api-custom-notifier](https://github.com/t0mer/green-api-custom-notifier), place it under the **custom_components** folder.
Restart Home Assistant and add the following section to your *configuration.yaml* file:

```yaml
notify:
- platform: greenapi
name: greenapi
instance_id: #REQUIRED: Set the instanceid
token: #REQUIRED: Set the greenapi token.
target: #OPTIONAL! Set the detault target. If you set the default target here, you won't have to specify it again in your service calls.
```

* instance_id is the Green API instance id.
* token is the Green API instance token.
* target is the chat/contact/group id to send the message to:
* For groups, the id should end with *@g.us*
* For chats, the id should end with *@c.us*

## Sending a message
To Send a message you call the service and provide the following parameters:
* message (**Required**): Test to send.
* title (**OPTIONAL**): Add a title for the message in **bold**.
* target (**OPTIONAL** if you've already defined the default target in your notify service, otherwise required): The chat/group id to send the message to.

![Send text message](screenshots/text_message.png)

Or from Yaml mode:
```yaml
service: notify.greenapi
data:
message: New Whatsapp component
target: 972*********@c.us
```

### Optional - Attach media to message
To send message with media, add the following to the data parameter:
* file : [Path to the file]

![Send media](screenshots/send_media.png)

Or from Yaml mode:
```yaml
service: notify.greenapi
data:
message: New Whatsapp component
target: 972*********@c.us
data:
file: /config/images/Capture.png

```

#### Important
If the path to the file does not exist, the message will still be sent; but will log a warning.