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.

114 lines
4.0 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. Log-call
  6. ========
  7. When a call has completed within Asterisk, FreeSWITCH or similar
  8. a callback can be added in a hangup handler to call a script
  9. which sends a request to Odoo to log the call.
  10. This module requires a module providing _get_ucp_url and _get_jitter
  11. functions in PhoneCommon. These provide a URL template for downloading
  12. recordings (false is fine) and the number of seconds to use to make
  13. sure there are no problems in merging call logs, respectively.
  14. Merging of call logs is automatic if, and only if, the call existing in
  15. the database as a state time between the start of the new call minus jitter
  16. and end of the new call plus jitter. It keep the data making the call the
  17. longest. It will keep the original attachment, ignoring a new one. It will
  18. append the new call description to the old making sure that the old ends with
  19. a new line.
  20. Installation
  21. ============
  22. To install this module, you need to simply click install.
  23. Configuration
  24. =============
  25. To configure this module, you need to go to the configuration page for the
  26. FreeSWITCH server in question, within Odoo, make sure to edit the ucp_url
  27. field to be a url template for call recordings.
  28. The following macros are allowed:
  29. {odoo_type} (inbound, outbound)
  30. {odoo_src} (source phone number}
  31. {odoo_dst} (destination number)
  32. {odoo_duration} (length of call)
  33. {odoo_start} (start time of call in seconds since epoch)
  34. {odoo_filename} (file name on server)
  35. {odoo_uniqueid} (FreeSWITCH UUID of call)
  36. Make sure to set time jitter compensation which is the number of seconds to
  37. subtract from new call start and add to new call end, for call merging, to
  38. compensate for system/database load and time drift between FreeSWITCH server
  39. and Odoo/Odoo database server(s). 5 seconds is likely a good start. Above 10
  40. seconds you get into the realm where you may have distinct calls confused.
  41. 20 - 30 seconds begins to guarantee this. It is best to keep this low and use
  42. a method to keep time synced.
  43. Usage
  44. =====
  45. To use this module, you will need to use one of the scripts in logcall/scripts
  46. which is appropriate for your server. You will also need Asterisk Logcall,
  47. FreeSWITCH Logcall, or something similar to provide ucp_url and
  48. server_jitter_compensation. Configure those.
  49. Note: the scripts, properly used, will work in most situations. Adjust for your
  50. local conditions. Please, contribute useful changes.
  51. For users who wish to enable automatic call logging, they will need to set the
  52. "Automatically Log Incoming Calls" preference.
  53. The user that will be handling to call backs should have "Phone System
  54. Integration and Logging" checked. It probably should be the same user you use
  55. for caller pop-up and Caller ID notification from other modules in
  56. connector-telephony. It should have no other permissions or group memberships
  57. besides what is set by those mentioned here.
  58. Known issues / Roadmap
  59. ======================
  60. None at this time.
  61. Bug Tracker
  62. ===========
  63. Bugs are tracked on `GitHub Issues
  64. <https://github.com/OCA/connector-telephony/issues>`_. In case of trouble, please
  65. check there if your issue has already been reported. If you spotted it first,
  66. help us smashing it by providing a detailed and welcomed feedback.
  67. Credits
  68. =======
  69. Images
  70. ------
  71. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  72. Contributors
  73. ------------
  74. * Trever L. Adams <trever.adams@gmail.com>
  75. * Ondřej Kuzník <ondrej.kuznik@credativ.co.uk>
  76. Maintainer
  77. ----------
  78. .. image:: https://odoo-community.org/logo.png
  79. :alt: Odoo Community Association
  80. :target: https://odoo-community.org
  81. This module is maintained by the OCA.
  82. OCA, or the Odoo Community Association, is a nonprofit organization whose
  83. mission is to support the collaborative development of Odoo features and
  84. promote its widespread use.
  85. To contribute to this module, please visit https://odoo-community.org.