Skip to Content

Messengers

by
Odoo
In-App Purchases
v 17.0 Third Party 401
Download for v 17.0 Deploy on Odoo.sh
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies • CRM (crm)
• Discuss (mail)
• Calendar (calendar)
• Contacts (contacts)
Community Apps Dependencies
Lines of code 7401
Technical Name us_messenger
LicenseOPL-1
Websitehttps://unitsoft.com.ua/
Versions 16.0 17.0 18.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies • CRM (crm)
• Discuss (mail)
• Calendar (calendar)
• Contacts (contacts)
Community Apps Dependencies
Lines of code 7401
Technical Name us_messenger
LicenseOPL-1
Websitehttps://unitsoft.com.ua/
Versions 16.0 17.0 18.0

Messengers Integration powered by UnitSoft

Communicate with Viber, Telegram and Whatsapp users in Odoo

This module is an auxiliary module for messengers. To integrate instant messengers into Odoo, you must also have the "us_multichat" module, as well as at least one of the messenger modules: Viber, WhatsApp or Telegram.

Features

1Bots kanban cards

If all messengers module has been installed, you will see in Messengers >> Messengers kanban cards

2How clients will be saved in odoo?

If the client enters some data such as email or phone number, then if he also joins from another messenger, the odoo will connect them together

3View from the discuss

4View all messages

View all messages that anyone wrote to the client and messages that the client wrote in messenger

5Follow operators and their channels

View lists of operators for each bot
Each operator sees only their own bots and channels
The system chooses among online operators with less traffic
Each operator can join unprocessed leads

Our Odoo Apps

Telegram Integration

Viber Integration

WhatsApp Integration

Customer Chat

UnitSoft - Additional localization fields

UnitSoft - Import the list of Ukrainian banks from NBU by UnitSoft

UnitSoft Odoo Apps

Messenger

Installation

  • Make configuration required for queue_job module. In particular:

    • add queue_job to server wide modules, e.g.:

      --load base,web,queue_job

  • Install this module in a usual way

  • If your Messengers use webhooks (most likely), be sure that url opens correct database without asking to select one

User Access Levels

  • User: read-only All Messeges
  • Developer: same as User, but read-only Messengers, Jobs
  • Administrator: same as Developer, but with access to Secrets

Project

  • Open menu [[ Messengers ]] >> Messengers

  • Create a project

    • Name, e.g. OdooTelegramBot

    • In the Parameters tab

      • Params * Key * Value

    • In the Advanced tab

      • Common_code: code that is executed before running any project's task. Can be used for initialization or for helpers. Any variables and functions that don't start with underscore symbol will be available in task's code.

      • Available Tasks. In the Available Tasks tab

        Name, e.g. Setup. Code: code with at least one of the following functions

        • handle_cron()

        • handle_db(records)

          • records: all records on which this task is triggered

        • handle_webhook(httprequest)

          • httprequest: contains information about request, e.g.

            • httprequest.data: request data
            • httprequest.files: uploaded files
            • httprequest.remote_addr: ip address of the caller.
            • see Werkzeug doc for more information.

          • optionally can return data as a response to the webhook request; any data transferred in this way are logged via log_transmission function:

            • for json webhook: * return json_data

            • for x-www-form-urlencoded webhook: * return data_str * return data_str, status * return data_str, status, headers

              • status is a response code, e.g. 200, 403, etc.
              • headers is a list of key-value tuples, e.g. [('Content-Type', 'text/html')]

        • handle_button()

      • Cron Triggers, DB Triggers, Webhook Triggers, Manual Triggers: when to execute the Code. See below for further information

Job Triggers

Cron

  • Trigger Name, e.g. NIGHTLY_TRIGGER
  • Execute Every: every 2 hours, every 1 week, etc.
  • Next Execution Date
  • Scheduler User

DB

  • Trigger Name, e.g. PRODUCT_PRICE_CHANGE
  • Model
  • Trigger Condition
    • On Creation
    • On Update
    • On Creation & Update
    • On Deletion
    • Based on Timed Condition
      • Allows to trigger task before, after on in time of Date/Time fields, e.g. 1 day after Sale Order is closed
  • Apply on: records filter
  • Before Update Domain: additional records filter for On Update event
  • Watched fields: fields list for On Update event

Webhook

  • Trigger Name, e.g. ON_EXTERNAL_UPDATE
  • Webhook Type: application/x-www-form-urlencoded or application/json
  • Webhook URL: readonly.

Button

  • Trigger Name, e.g. SETUP

Code

Available variables and functions:

Base

  • env: Odoo Environment

  • log(message, level=LOG_INFO): logging function to record debug information

    log levels:

    • LOG_DEBUG
    • LOG_INFO
    • LOG_WARNING
    • LOG_ERROR

  • log_transmission(recipient_str, data_str): report on data transfer to external recipients

Project Values

  • params.<PARAM_NAME>: project params
  • webhooks.<WEBHOOK_NAME>: contains webhook url; only in tasks' code

Event

  • trigger_name: available in tasks' code only
  • user: user related to the event, e.g. who clicked a button

Asynchronous work

  • add_job(func_name, **options)(*func_args, **func_kwargs): call a function asynchronously; options are similar to with_delay method of queue_job module:
    • priority: Priority of the job, 0 being the higher priority. Default is 10.
    • eta: Estimated Time of Arrival of the job. It will not be executed before this date/time.
    • max_retries: maximum number of retries before giving up and set the job state to 'failed'. A value of 0 means infinite retries. Default is 5.
    • description human description of the job. If None, description is computed from the function doc or name
    • identity_key key uniquely identifying the job, if specified and a job with the same key has not yet been run, the new job will not be added.

Attachments

  • attachment._public_url(): generates access url. Can be used to pass attachments to an external system as url, instead of direct uploading the content.

Libs

  • json
  • time
  • datetime
  • dateutil
  • timezone
  • b64encode
  • b64decode

Tools

  • url2base64
  • url2bin
  • get_lang(env, lang_code=False): returns res.lang record
  • html2plaintext
  • type2str: get type of the given object
  • DEFAULT_SERVER_DATETIME_FORMAT

Exceptions

  • UserError
  • ValidationError
  • RetryableJobError: raise to restart job from beginning; e.g. in case of temporary errors like broken connection
  • OSError

Running Job

Depending on Trigger, a job may:

  • be added to a queue or runs immediatly
  • be retried in case of failure
    • if RetryableJobError is raised, then job is retried automatically in following scheme:
      • After first failure wait 5 minute
      • If it's not succeeded again, then wait another 15 minutes
      • If it's not succeeded again, then wait another 60 minutes
      • If it's not succeeded again, then wait another 3 hours
      • Try again for the fifth time and stop retrying if it's still failing

Cron

  • job is added to the queue before run
  • failed job can be retried if failed

DB

  • job is added to the queue before run
  • failed job can be retried if failed

Webhook

  • runs immediately
  • failed job cannot be retried via backend UI; the webhook should be called again.

Button

  • runs immediately
  • to retry click the button again

Execution Logs

In Project, Task and Job Trigger forms you can find Logs button in top-right hand corner. You can filter and group logs by following fields:

  • Messenger
  • Task
  • Job Trigger
  • Job Start Time
  • Log Level
  • Status (Success / Fail)
Odoo Proprietary License v1.0

This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author, please use the developer contact information. They can usually be found in the description.
Please choose a rating from 1 to 5 for this module.