Author: |
Creu Blanca,Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
12.0-mig-mail-telegram |
Repository: |
tegin/social |
Dependencies: |
mail,
mail_telegram,
and
web |
Languages: |
HTML (366, 23.7%),
JavaScript (560, 36.2%),
Python (264, 17.1%),
SVG (160, 10.4%),
Sass (3, 0.2%),
XML (123, 8.0%),
and
reStructuredText (69, 4.5%) |
<h1 class="title">Mail Telegram Broker</h1>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/social/tree/12.0/mail_telegram_broker"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/social-12-0/social-12-0-mail_telegram_broker"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/205/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module allows to respond telegram chats as a telegram bot.</p>
<p>This way, a group of users can respond customers or any other set
of partners in an integrated way.</p>
<p>It is not intended to be integrated on default chatter as users don't need
to review again when one has responded.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a><ul>
<li><a class="reference internal" href="#create-the-bot" id="id2">Create the bot</a></li>
<li><a class="reference internal" href="#configure-odoo" id="id3">Configure Odoo</a></li>
</ul>
</li>
<li><a class="reference internal" href="#usage" id="id4">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id6">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id7">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id9">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
<a name="create-the-bot"></a>
<h3><a class="toc-backref" href="#id2">Create the bot</a></h3>
<ol class="arabic simple">
<li>Create a Bot on telegram <a class="reference external" href="https://core.telegram.org/bots">https://core.telegram.org/bots</a></li>
<li>Create a broker following the examples on
<a class="reference external" href="https://github.com/tegin/telegram-broker">https://github.com/tegin/telegram-broker</a> with the TOKEN provided</li>
</ol>
<a name="configure-odoo"></a>
<h3><a class="toc-backref" href="#id3">Configure Odoo</a></h3>
<ol class="arabic simple">
<li>Access on debug mode</li>
<li>Access <cite>Settings > Technical Settings > Email > Telegram Bot</cite>.</li>
<li>Create a bot and assign the token. Mark it as <cite>Show on App</cite></li>
</ol>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id4">Usage</a></h2>
<ol class="arabic simple">
<li>Access <cite>Telegram</cite></li>
<li>Wait until someone starts a conversation with your bot.</li>
<li>Now you will be able to respond and receive messages to this person.</li>
</ol>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id5">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/social/issues/new?body=module:%20mail_telegram_broker%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id6">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id7">Authors</a></h3>
<ul class="simple">
<li>Creu Blanca</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id8">Contributors</a></h3>
<ul class="simple">
<li>Enric Tobella <<a class="reference external" href="mailto:etobella@creublanca.es">etobella@creublanca.es</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id9">Maintainers</a></h3>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/12.0/mail_telegram_broker">OCA/social</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>