Metadata-Version: 2.1
Name: odoo-addon-mail_gateway_whatsapp
Version: 18.0.2.1.4.4
Requires-Python: >=3.10
Requires-Dist: odoo-addon-mail_gateway==18.0.*
Requires-Dist: odoo==18.0.*
Requires-Dist: requests_toolbelt
Summary: Set a gateway for WhatsApp
Home-page: https://github.com/OCA/social
License: AGPL-3
Author: Creu Blanca, Dixmit, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

=====================
Mail Whatsapp Gateway
=====================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:ae7c29010e159660dbbd5e768dc5c08ca1a3b0556a97775803cda2cc18c2b51c
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github
    :target: https://github.com/OCA/social/tree/18.0/mail_gateway_whatsapp
    :alt: OCA/social
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/social-18-0/social-18-0-mail_gateway_whatsapp
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/social&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module allows to respond whatsapp chats.

This way, a group of users can respond customers or any other set of
partners in an integrated way.

**Table of contents**

.. contents::
   :local:

Configuration
=============

First steps
-----------

You need to create a WhatsApp Business Account (WABA), a Meta App and
define a phone number. You can follow this
`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>`__.

If you create a test Business Account, passwords will change every 24
hours.

In order to make the webhook accessible, the system must be public.

Configure the gateway
---------------------

Once you have created the Meta App, you need to add the gateway and
webhook. In order to make it you must follow this steps:

- Access Settings > Emails > Mail Gateway
- Create a Gateway of type WhatsApp

..

   - Use the Meta App authentication key as Token field
   - Use the Meta App Phone Number ID as Whatsapp from Phone field
   - Use the Meta Account Business ID as Whatsapp account field (only if
     you need sync templates)
   - Write your own Webhook key
   - Use the Application Secret Key on Whatsapp Security Key. It will be
     used in order to validate the data
   - Press the Integrate Webhook Key. In this case, it will not
     integrate it, we need to make it manually
   - Copy the webhook URL

- Access `Facebook Apps
  website <https://developers.facebook.com/apps/>`__
- Access your App then Whatsapp > Configuration
- Create your webhook using your URL and put the Whatsapp Security Key
  as validation Key
- Administer the Webhook and activate the messages webhook

Usage
=====

1. Access Gateway
2. Wait until someone starts a conversation.
3. Now you will be able to respond and receive messages to this person.

Known issues / Roadmap
======================

**WhatsApp templates**

- Add support for Variables
- Add support for Buttons

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_gateway_whatsapp%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Creu Blanca
* Dixmit

Contributors
------------

- Olga Marco <olga.marco@creublanca.es>

- Enric Tobella <etobella@creublanca.es>

- `Tecnativa <https://www.tecnativa.com>`__:

     - Carlos Lopez

Other credits
-------------

This work has been funded by AEOdoo (Asociación Española de Odoo -
https://www.aeodoo.org)

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/social <https://github.com/OCA/social/tree/18.0/mail_gateway_whatsapp>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
