You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

132 lines
4.4 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. =====================
  5. FreeSWITCH Click2Dial
  6. =====================
  7. The technical name of this module is *freeswitch_click2dial*, but this module
  8. implements much more than a simple *click2dial*! This module adds 3
  9. functionalities:
  10. 1) It adds a *Dial* button in the partner form view so that users can directly
  11. dial a phone number through FreeSWITCH. This feature is usually known as
  12. *click2dial*.
  13. 2) It adds the ability to show the name of the calling party on the screen of
  14. your IP phone on incoming phone calls if the presented phone number is
  15. present in the partner/leads/employees/... of Odoo.
  16. 3) It adds a phone icon (*Open Caller*) in the top menu bar
  17. (next to the Preferences) to get the partner/lead/candidate/registrations
  18. corresponding to the calling party in one click.
  19. Installation
  20. ============
  21. To install this module, you need to:
  22. * Click on the module and install it
  23. Additionally, you will need the FreeSWITCH ESL python module. The easiest way is
  24. pip install FreeSWITCH-ESL-Python. Otherwise, you will find it under
  25. ${FREESWITCH_SRC_TOP_DIR}/libs/esl/python. Go to
  26. ${FREESWITCH_SRC_TOP_DIR}/libs/esl. Type make. Then make pymod. You will then
  27. need to install ${FREESWITCH_SRC_TOP_DIR}/libs/esl/python/ESL.py and
  28. ${FREESWITCH_SRC_TOP_DIR}/libs/esl/python/_ESL.so into the appropriate places
  29. on your Odoo/Odoo server.
  30. (https://wiki.freeswitch.org/wiki/Event_Socket_Library#Installation for more
  31. information.) An alternative method would involve
  32. https://github.com/gurteshwar/freeswitch-esl-python.
  33. Configuration
  34. =============
  35. To configure this module, you need to:
  36. * Settings > Technical > FreeSWITCH Servers.
  37. * Setup you server.
  38. * Configure users under Settings > Users > $USER > Telephony tab.
  39. Usage
  40. =====
  41. To use this module, you need to:
  42. * See scripts/get_caller_name.py to see how to set caller and callee name
  43. * Click on Dial next to any phone number covered by associated modules.
  44. 1) *click2dial*. Here is how it works :
  45. * In Odoo, the user clicks on the *Dial* button next to a phone number
  46. field in the partner view.
  47. * Odoo connects to the FreeSWITCH Event Socket and FreeSWITCH makes the
  48. user's phone ring.
  49. * The user answers his own phone (if he doesn't, the process stops here).
  50. * FreeSWITCH dials the phone number found in Odoo in place of the user.
  51. * If the remote party answers, the user can talk to his correspondent.
  52. 2) Using Odoo to provide Caller ID Name in FreeSWITCH. To understand how to
  53. use this, please see get_caller_name.py, which should be installed per the
  54. instructions in the script on the Odoo/Odoo server. This works for
  55. incoming and outgoing calls, per instructions in the script.
  56. 3) *Open Caller* Here is how it works :
  57. * When the user clicks on the phone icon, Odoo sends a query to the
  58. FreeSWITCH Manager Interface to get a list of the current phone calls
  59. * If it finds a phone call involving the user's phone, it gets the phone
  60. number of the calling party
  61. * It searches the phone number of the calling party in the
  62. Partners/Leads/Candidates/Registrations of Odoo. If a record matches,
  63. it takes you to the form view of this record. If no record matchs, it
  64. opens a wizard which proposes to create a new Partner with the presented
  65. phone number as *Phone* or *Mobile* number or update an existing Partner.
  66. It is possible to get a pop-up of the record corresponding to the calling
  67. party without any action from the user via the module *base_phone_popup*.
  68. Known issues / Roadmap
  69. ======================
  70. * None
  71. Bug Tracker
  72. ===========
  73. Bugs are tracked on `GitHub Issues
  74. <https://github.com/OCA/connector-telephony/issues>`_. In case of trouble, please
  75. check there if your issue has already been reported. If you spotted it first,
  76. help us smashing it by providing a detailed and welcomed feedback.
  77. Credits
  78. =======
  79. Contributors
  80. ------------
  81. * Trever L. Adams
  82. Maintainer
  83. ----------
  84. .. image:: https://odoo-community.org/logo.png
  85. :alt: Odoo Community Association
  86. :target: https://odoo-community.org
  87. This module is maintained by the OCA.
  88. OCA, or the Odoo Community Association, is a nonprofit organization whose
  89. mission is to support the collaborative development of Odoo features and
  90. promote its widespread use.
  91. To contribute to this module, please visit http://odoo-community.org.