├── LICENSE ├── README.md ├── custom_components └── greenapi │ ├── __init__.py │ ├── manifest.json │ ├── notify.py │ └── services.yaml ├── hacs.json └── screenshots ├── active_instance.png ├── contacts_list.png ├── create_acoount.png ├── create_instance.png ├── developer_instance.png ├── get_contacts.png ├── instance_details.png ├── qr.png ├── register.png ├── scan_qr.png ├── send_media.png ├── send_qr.png └── text_message.png /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # green-api-custom-notifier 2 | 3 | [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. 4 | 5 | 6 | [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). 7 | 8 | 9 | ## Limitations 10 | * The free account is limited to 3 chats (Group or Private). 11 | 12 | 13 | ## Getting started 14 | 15 | ### Setup Green API account 16 | Nevigate to [https://green-api.com/en](https://green-api.com/en) and register for a new account: 17 | ![Register](screenshots/register.png) 18 | 19 | Fill up your details and click on **Register**: 20 | ![Create Account](screenshots/create_acoount.png) 21 | 22 | 23 | Next, click on the "Create an instance": 24 | ![Create Instance](screenshots/create_instance.png) 25 | 26 | 27 | Select the "Developer" instance (Free): 28 | ![Developer Instance](screenshots/developer_instance.png) 29 | 30 | 31 | Copy the InstanceId and Token, we need it for the integration settings: 32 | ![Instance Details](screenshots/instance_details.png) 33 | 34 | 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" 35 | 36 | ![Send QR](screenshots/send_qr.png) 37 | 38 | ![Scan QR](screenshots/scan_qr.png) 39 | 40 | Next, Scan the QR code to link you whatsapp with Green API: 41 | 42 | ![QR Code](screenshots/qr.png) 43 | 44 | After the account link, you will notice that the instance is active by the green light in the instance header: 45 | ![Active Instance](screenshots/active_instance.png) 46 | 47 | 48 | 49 | ### Getting the Contacts and Groups 50 | Before we can start messaging, we need to get the Contact/Group details. we can do it using Green API endpoint. 51 | On the lef side, Under API --> Service methods, click on "getContacts" and then click "Send": 52 | ![Get Contacts](screenshots/get_contacts.png) 53 | 54 | As a result, you will get the list of Contacts and Groups. 55 | * The contact number ends with **@c.us** 56 | * The group number ends with **@g.us** 57 | 58 | ![Contacts Lists](screenshots/contacts_list.png) 59 | 60 | Write down the Id, you will need it to configure the notification. 61 | 62 | 63 | ### Setting up the notification in Home Assistant 64 | 65 | Download the [green-api-custom-notifier](https://github.com/t0mer/green-api-custom-notifier), place it under the **custom_components** folder. 66 | Restart Home Assistant and add the following section to your *configuration.yaml* file: 67 | 68 | 69 | ```yaml 70 | notify: 71 | - platform: greenapi 72 | name: greenapi 73 | instance_id: #REQUIRED: Set the instanceid 74 | token: #REQUIRED: Set the greenapi token. 75 | 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. 76 | ``` 77 | 78 | * instance_id is the Green API instance id. 79 | * token is the Green API instance token. 80 | * target is the chat/contact/group id to send the message to: 81 | * For groups, the id should end with *@g.us* 82 | * For chats, the id should end with *@c.us* 83 | 84 | 85 | ## Sending a message 86 | To Send a message you call the service and provide the following parameters: 87 | * message (**Required**): Test to send. 88 | * title (**OPTIONAL**): Add a title for the message in **bold**. 89 | * 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. 90 | 91 | ![Send text message](screenshots/text_message.png) 92 | 93 | Or from Yaml mode: 94 | ```yaml 95 | service: notify.greenapi 96 | data: 97 | message: New Whatsapp component 98 | target: 972*********@c.us 99 | ``` 100 | 101 | ### Optional - Attach media to message 102 | To send message with media, add the following to the data parameter: 103 | * file : [Path to the file] 104 | 105 | ![Send media](screenshots/send_media.png) 106 | 107 | Or from Yaml mode: 108 | ```yaml 109 | service: notify.greenapi 110 | data: 111 | message: New Whatsapp component 112 | target: 972*********@c.us 113 | data: 114 | file: /config/images/Capture.png 115 | 116 | ``` 117 | 118 | #### Important 119 | If the path to the file does not exist, the message will still be sent; but will log a warning. -------------------------------------------------------------------------------- /custom_components/greenapi/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /custom_components/greenapi/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "domain": "greenapi", 3 | "name": "Whatsapp notifier basde on Green API", 4 | "codeowners": [ 5 | "@t0mer" 6 | ], 7 | "documentation": "https://github.com/t0mer/green-api-custom-notifier", 8 | "iot_class": "local_polling", 9 | "issue_tracker": "https://github.com/t0mer/green-api-custom-notifier", 10 | "requirements": ["whatsapp-api-client-python"], 11 | "version": "0.4.0" 12 | } 13 | -------------------------------------------------------------------------------- /custom_components/greenapi/notify.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import json 3 | import os 4 | from os.path import basename 5 | from urllib.parse import urlparse 6 | import voluptuous as vol 7 | from whatsapp_api_client_python import API 8 | import homeassistant.helpers.config_validation as cv 9 | from homeassistant.components.notify import ( 10 | ATTR_TARGET, ATTR_TITLE, ATTR_DATA, PLATFORM_SCHEMA, BaseNotificationService) 11 | 12 | ATTR_INSTANCE = "instance_id" 13 | ATTR_TOKEN = "token" 14 | 15 | 16 | _LOGGER = logging.getLogger(__name__) 17 | 18 | PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ 19 | vol.Optional(ATTR_TARGET): cv.string, 20 | vol.Required(ATTR_INSTANCE): cv.string, 21 | vol.Required(ATTR_TOKEN): cv.string, 22 | vol.Optional(ATTR_TITLE): cv.string, 23 | }) 24 | 25 | def get_service(hass, config, discovery_info=None): 26 | """Get the custom notifier service.""" 27 | title = config.get(ATTR_TITLE) 28 | token = config.get(ATTR_TOKEN) 29 | instance_id = config.get(ATTR_INSTANCE) 30 | target = config.get(ATTR_TARGET) 31 | return GreenAPINotificationService(title, token, instance_id, target) 32 | 33 | class GreenAPINotificationService(BaseNotificationService): 34 | 35 | def __init__(self, title, token, instance_id, target): 36 | """Initialize the service.""" 37 | self._title = title 38 | self._token = token 39 | self._instance_id = instance_id 40 | self._target = target 41 | self._greenAPI = API.GreenAPI(self._instance_id, self._token) 42 | 43 | def send_message(self, message="", **kwargs): 44 | 45 | """Send a message to the target.""" 46 | 47 | try: 48 | title = kwargs.get(ATTR_TITLE) 49 | if title is not None: 50 | title = f"*{title}*" 51 | message = f"{title}\n{message}" 52 | data = kwargs.get(ATTR_DATA) 53 | target = kwargs.get(ATTR_TARGET)[0] if kwargs.get(ATTR_TARGET) is not None else self._target #Allow setting the target from either the service-call or the service config. Service call target can override the default config. 54 | _LOGGER.info(f"Sending message to {target}") 55 | if data is not None: 56 | file_path = data.get("file") 57 | if file_path is not None: 58 | if os.path.exists(file_path): 59 | upload_file_response = self._greenAPI.sending.uploadFile(file_path) 60 | if upload_file_response.code != 200: 61 | raise Exception(upload_file_response.code, "Failed to upload file: " + file_path) 62 | url_file = upload_file_response.data["urlFile"] 63 | url = urlparse(url_file) 64 | file_name = basename(url.path) 65 | send_file_by_url_response = self._greenAPI.sending.sendFileByUrl(target, url_file, file_name, caption=message) 66 | return 67 | else: 68 | _LOGGER.warn("Sending message to %s: excluding the file '%s' that was not found", kwargs.get(ATTR_TARGET)[0], file_path) 69 | self._greenAPI.sending.sendMessage(target, message, linkPreview=False) 70 | except Exception as e: 71 | _LOGGER.error("Sending message to %s: has failed with the following error %s", kwargs.get(ATTR_TARGET)[0], str(e)) 72 | 73 | -------------------------------------------------------------------------------- /custom_components/greenapi/services.yaml: -------------------------------------------------------------------------------- 1 | notify: 2 | description: "Send a whatsapp notification using Green API" 3 | fields: 4 | message: 5 | description: The message to send 6 | example: "Hello World" 7 | -------------------------------------------------------------------------------- /hacs.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Green API whatsapp custom notification / notify", 3 | "render_readme": true, 4 | "country": "IL" 5 | } 6 | -------------------------------------------------------------------------------- /screenshots/active_instance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/active_instance.png -------------------------------------------------------------------------------- /screenshots/contacts_list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/contacts_list.png -------------------------------------------------------------------------------- /screenshots/create_acoount.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/create_acoount.png -------------------------------------------------------------------------------- /screenshots/create_instance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/create_instance.png -------------------------------------------------------------------------------- /screenshots/developer_instance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/developer_instance.png -------------------------------------------------------------------------------- /screenshots/get_contacts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/get_contacts.png -------------------------------------------------------------------------------- /screenshots/instance_details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/instance_details.png -------------------------------------------------------------------------------- /screenshots/qr.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/qr.png -------------------------------------------------------------------------------- /screenshots/register.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/register.png -------------------------------------------------------------------------------- /screenshots/scan_qr.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/scan_qr.png -------------------------------------------------------------------------------- /screenshots/send_media.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/send_media.png -------------------------------------------------------------------------------- /screenshots/send_qr.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/send_qr.png -------------------------------------------------------------------------------- /screenshots/text_message.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t0mer/green-api-custom-notifier/9439e761e13948c21d1b6f1c3fb9a7491950a247/screenshots/text_message.png --------------------------------------------------------------------------------