Skip to content

Commit 18b25c5

Browse files
committed
Merge PR OCA#1619 into 17.0
Signed-off-by pedrobaeza
2 parents 01c6d74 + c69bced commit 18b25c5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+6308
-0
lines changed

mail_gateway_whatsapp/README.rst

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
=====================
2+
Mail Whatsapp Gateway
3+
=====================
4+
5+
..
6+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!! This file is generated by oca-gen-addon-readme !!
8+
!! changes will be overwritten. !!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!! source digest: sha256:70475641a2c7498a1ee67811eadb397e33c33435cdd2efb8edce729026ad09c4
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
14+
:target: https://odoo-community.org/page/development-status
15+
:alt: Beta
16+
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
17+
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
18+
:alt: License: AGPL-3
19+
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github
20+
:target: https://github.com/OCA/social/tree/17.0/mail_gateway_whatsapp
21+
:alt: OCA/social
22+
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
23+
:target: https://translation.odoo-community.org/projects/social-17-0/social-17-0-mail_gateway_whatsapp
24+
:alt: Translate me on Weblate
25+
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
26+
:target: https://runboat.odoo-community.org/builds?repo=OCA/social&target_branch=17.0
27+
:alt: Try me on Runboat
28+
29+
|badge1| |badge2| |badge3| |badge4| |badge5|
30+
31+
This module allows to respond whatsapp chats.
32+
33+
This way, a group of users can respond customers or any other set of
34+
partners in an integrated way.
35+
36+
**Table of contents**
37+
38+
.. contents::
39+
:local:
40+
41+
Configuration
42+
=============
43+
44+
First steps
45+
-----------
46+
47+
You need to create a WhatsApp Business Account (WABA), a Meta App and
48+
define a phone number. You can follow this
49+
`steps <https://developers.facebook.com/micro_site/url/?click_from_context_menu=true&country=ES&destination=https%3A%2F%2Fwww.facebook.com%2Fbusiness%2Fhelp%2F2087193751603668&event_type=click&last_nav_impression_id=0m3TRxrxOlly1eRmB&max_percent_page_viewed=22&max_viewport_height_px=1326&max_viewport_width_px=2560&orig_http_referrer=https%3A%2F%2Fdevelopers.facebook.com%2Fdocs%2Fwhatsapp%2Fcloud-api%2Fget-started-for-bsps%3Flocale%3Den_US&orig_request_uri=https%3A%2F%2Fdevelopers.facebook.com%2Fajax%2Fpagelet%2Fgeneric.php%2FDeveloperNotificationsPayloadPagelet%3Ffb_dtsg_ag%3D--sanitized--%26data%3D%257B%2522businessUserID%2522%253Anull%252C%2522cursor%2522%253Anull%252C%2522length%2522%253A15%252C%2522clientRequestID%2522%253A%2522js_k6%2522%257D%26__usid%3D6-Trd7hi4itpm%253APrd7ifiub2tvy%253A0-Ard7g9twdm0p1-RV%253D6%253AF%253D%26locale%3Den_US%26jazoest%3D24920&region=emea&scrolled=false&session_id=1jLoVJNU6iVMaw3ml&site=developers>`__.
50+
51+
If you create a test Business Account, passwords will change every 24
52+
hours.
53+
54+
In order to make the webhook accessible, the system must be public.
55+
56+
Configure the gateway
57+
---------------------
58+
59+
Once you have created the Meta App, you need to add the gateway and
60+
webhook. In order to make it you must follow this steps:
61+
62+
- Access Settings > Emails > Mail Gateway
63+
- Create a Gateway of type WhatsApp
64+
65+
..
66+
67+
- Use the Meta App authentication key as Token field
68+
- Use the Meta App Phone Number ID as Whatsapp from Phone field
69+
- Use the Meta Account Business ID as Whatsapp account field (only if
70+
you need sync templates)
71+
- Write your own Webhook key
72+
- Use the Application Secret Key on Whatsapp Security Key. It will be
73+
used in order to validate the data
74+
- Press the Integrate Webhook Key. In this case, it will not
75+
integrate it, we need to make it manually
76+
- Copy the webhook URL
77+
78+
- Access `Facebook Apps
79+
website <https://developers.facebook.com/apps/>`__
80+
- Access your App then Whatsapp > Configuration
81+
- Create your webhook using your URL and put the Whatsapp Security Key
82+
as validation Key
83+
- Administer the Webhook and activate the messages webhook
84+
85+
Usage
86+
=====
87+
88+
1. Access Gateway
89+
2. Wait until someone starts a conversation.
90+
3. Now you will be able to respond and receive messages to this person.
91+
92+
Known issues / Roadmap
93+
======================
94+
95+
**WhatsApp templates**
96+
97+
- Add support for Variables
98+
- Add support for Buttons
99+
100+
Bug Tracker
101+
===========
102+
103+
Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
104+
In case of trouble, please check there if your issue has already been reported.
105+
If you spotted it first, help us to smash it by providing a detailed and welcomed
106+
`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_gateway_whatsapp%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
107+
108+
Do not contact contributors directly about support or help with technical issues.
109+
110+
Credits
111+
=======
112+
113+
Authors
114+
-------
115+
116+
* Creu Blanca
117+
* Dixmit
118+
119+
Contributors
120+
------------
121+
122+
- Olga Marco <olga.marco@creublanca.es>
123+
124+
- Enric Tobella <etobella@creublanca.es>
125+
126+
- `Tecnativa <https://www.tecnativa.com>`__:
127+
128+
- Carlos Lopez
129+
130+
Other credits
131+
-------------
132+
133+
This work has been funded by AEOdoo (Asociación Española de Odoo -
134+
https://www.aeodoo.org)
135+
136+
Maintainers
137+
-----------
138+
139+
This module is maintained by the OCA.
140+
141+
.. image:: https://odoo-community.org/logo.png
142+
:alt: Odoo Community Association
143+
:target: https://odoo-community.org
144+
145+
OCA, or the Odoo Community Association, is a nonprofit organization whose
146+
mission is to support the collaborative development of Odoo features and
147+
promote its widespread use.
148+
149+
This module is part of the `OCA/social <https://github.com/OCA/social/tree/17.0/mail_gateway_whatsapp>`_ project on GitHub.
150+
151+
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

mail_gateway_whatsapp/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
from . import models
2+
from . import tools
3+
4+
# from . import services
5+
from . import wizards
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Copyright 2022 Creu Blanca
2+
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
3+
4+
{
5+
"name": "Mail Whatsapp Gateway",
6+
"summary": """
7+
Set a gateway for whatsapp""",
8+
"version": "17.0.1.0.0",
9+
"license": "AGPL-3",
10+
"author": "Creu Blanca, Dixmit, Odoo Community Association (OCA)",
11+
"website": "https://github.com/OCA/social",
12+
"depends": ["mail_gateway", "phone_validation"],
13+
"external_dependencies": {"python": ["requests_toolbelt"]},
14+
"data": [
15+
"security/security.xml",
16+
"security/ir.model.access.csv",
17+
"wizards/whatsapp_composer.xml",
18+
"wizards/mail_compose_gateway_message.xml",
19+
"views/mail_whatsapp_template_views.xml",
20+
"views/mail_gateway.xml",
21+
],
22+
"assets": {
23+
"web.assets_backend": [
24+
"mail_gateway_whatsapp/static/src/components/**/*",
25+
],
26+
},
27+
}

0 commit comments

Comments
 (0)