1
- ===========
2
- VoIP widget
3
- ===========
1
+ ============
2
+ VoIP actions
3
+ ============
4
4
5
5
.. |VOIP | replace :: :abbr: `VoIP ( Voice over Internet Protocol ) `
6
6
7
- The *VoIP * (Voice over Internet Protocol) widget is an add-on made available to Odoo users by
8
- installing the |VOIP | module. Instead of managing mobile devices for every salesperson, fumbling
9
- through call transfers for upset customers, or needing a meeting room to handle a conference call,
10
- utilize the |VoIP | widget to tackle any of these business needs.
11
-
12
- Install the VoIP module
13
- =======================
14
-
15
- To use |VOIP |, it must first be :doc: `installed <../../general/apps_modules >`.
16
-
17
- Once the module is installed, a :icon: `oi-voip ` :guilabel: `(VoIP) ` icon will appear at the top of
18
- the screen. This is where phone calls are made from within Odoo. When this icon is clicked, a |VOIP |
19
- pop-up widget appears on the screen, and is where emails can be sent, user and employee info can be
20
- edited, and activities can be managed. While this pop-up widget is open, the user can navigate
21
- through their Odoo apps.
22
-
23
- .. image :: voip_widget/activity-widget.png
24
- :alt: VoIP widget in Odoo.
25
-
26
- Sign up for a VoIP service provider
27
- ===================================
28
-
29
- While |VOIP | setup is minimal in Odoo, all mapping happens in the external |VOIP | service provider.
30
- Two verified providers are :doc: `OnSIP <onsip >` and :doc: `Axivox <axivox >`. If these providers
31
- cannot be used, an alternate provider must meet these requirements to connect with Odoo:
32
-
33
- - |VOIP | host must provide access to a SIP server via a websocket connection
34
- - |VOIP | host must support WebRTC protocol
35
-
36
- To add the credentials for the alternate provider, go to the **Settings ** app and search for `VoIP `.
37
- In the :guilabel: `Integrations ` section under :guilabel: `VoIP `, click :guilabel: `Manage Providers `.
38
- And then, click :guilabel: `New ` and enter the requested information (like the websocket's URL). Note
39
- that the :guilabel: `OnSIP Domain ` field is where the domain created by the alternate provider goes.
40
-
41
- If any issues with the |VOIP | service provider are encountered, then reach out to their support
42
- team. If any issues when setting up the |VOIP | service provider are encountered in Odoo, then follow
43
- the :ref: `relevant troubleshooting steps <voip/voip_widget/troubleshooting_voip >`.
44
-
45
- .. warning ::
46
- Odoo **cannot ** verify that every alternate provider is compatible with Odoo's systems. However,
47
- if the above requirements are met, then no issues should be found.
48
-
49
- Make a phone call with VoIP
50
- ===========================
51
-
52
- One of the primary purposes of |VOIP | is to make phone calls without needing a phone. Here are the
53
- three ways to make a phone call in the Odoo database:
54
-
55
- - Click the :icon: `oi-voip ` :guilabel: `(VoIP) ` icon, located in the top-right of the navigation bar.
56
- Then, enter the phone number to be called by clicking the :icon: `fa-keyboard-o `
57
- :guilabel: `(keyboard) ` icon, and then entering the phone number to be called.
58
-
59
- - To return to the widget's home page, click the :icon: `fa-keyboard-o ` :guilabel: `(keyboard) `
60
- icon again.
61
-
62
- - Click the :icon: `oi-voip ` :guilabel: `(VoIP) ` icon, located in the top-right of the navigation bar.
63
- Then, click the :icon: `fa-phone ` :guilabel: `(phone) ` icon to redial the last called contact.
64
- - Click the :icon: `oi-voip ` :guilabel: `(VoIP) ` icon, located in the top-right of the navigation bar.
65
- Then, search for a specific contact's name or go to the :guilabel: `Contacts ` tab. Then, select the
66
- contact and click the :icon: `fa-phone ` :guilabel: `(phone) ` icon.
67
-
68
- When receiving calls in Odoo, the |VOIP | widget rings, and displays a notification. To close the
69
- widget, click the :icon: `oi-close ` :guilabel: `(close) ` icon in the upper-right of the widget's
70
- screen.
71
-
72
- .. note ::
73
- The :abbr: `VoIP ( Voice over Internet Protocol ) ` number is the one provided by Axivox. It can be
74
- accessed by navigating to `https://manage.axivox.com/ <https://manage.axivox.com/ >`_. After
75
- logging into the portal, go to :menuselection: `Users --> Outgoing number ` (column).
76
-
77
- Send an email through the VoIP widget
78
- =====================================
79
-
80
- While phone calls are handled through the |VOIP | widget, emails can also be sent through it. This is
81
- helpful for sending follow-up emails to the call participants, emailing a question to a coworker, or
82
- reminding a vendor to send over some components during a check-in call.
83
-
84
- To send an email through the |VOIP | widget, click the :icon: `oi-voip ` :guilabel: `(VoIP) ` icon,
85
- located in the top navigation bar. When this is clicked, the |VOIP | widget will appear in the
86
- bottom-right corner of the page. Then, search for a contact to email or find them in the
87
- :guilabel: `Contacts ` tab of the |VOIP | widget. Next, click the :icon: `fa-envelope-o `
88
- :guilabel: `(envelope) ` icon, and then select the email recipients, enter the email's subject line,
89
- and write the email. When it is ready to be sent, click :guilabel: `Send `. To schedule an email to
90
- send later, click the :icon: `fa-caret-down ` :guilabel: `(dropdown) ` icon next to :guilabel: `Send `,
91
- click :guilabel: `Send Later `, pick the scheduled time, and click :guilabel: `Schedule `.
7
+ The |VOIP | widget is an add-on made available to Odoo users by installing the |VOIP | module. Instead
8
+ of managing mobile devices for every salesperson, fumbling through call transfers for upset
9
+ customers, or needing a meeting room to handle a conference call, utilize the |VOIP | widget to
10
+ tackle any of these business needs.
92
11
93
12
Navigate the VoIP widget
94
13
========================
@@ -109,8 +28,8 @@ This includes incoming and outgoing calls. Any number can be clicked to begin a
109
28
Next activities tab
110
29
-------------------
111
30
112
- Under the :guilabel: `Next Activities ` tab of the |VOIP | widget, a user can see any activities
113
- assigned to them, and which ones are due to be completed for the day.
31
+ Under the :guilabel: `Next Activities ` tab of the |VOIP | widget, a user can see any calls assigned to
32
+ them, and which ones are due to be completed for the day.
114
33
115
34
Click an activity from this tab to perform any of these actions to prepare for and complete (found
116
35
under the **Documents ** heading):
@@ -131,6 +50,16 @@ When viewing the activity, the user can also manage the activity's details and s
131
50
To call the customer related to a scheduled activity, click the :icon: `fa-phone ` :guilabel: `(phone) `
132
51
icon. Click the :icon: `fa-keyboard-o ` :guilabel: `(keyboard) ` icon to dial another number.
133
52
53
+ Add a call to the Next Activities tab
54
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55
+
56
+ To add a call to the :guilabel: `Next activities ` tab, click the green :icon: `fa-phone `
57
+ :guilabel: `(phone) ` icon, while in Kanban view of the **CRM ** application.
58
+
59
+ To remove a call from the :guilabel: `Next activities ` tab, hover over the opportunity that has a
60
+ call scheduled, and click the red :icon: `fa-phone ` :guilabel: `(phone) ` icon that appears with the
61
+ :guilabel: `- (minus) ` icon.
62
+
134
63
Contacts tab
135
64
------------
136
65
@@ -144,6 +73,81 @@ A search feature is also available at the top of the widget, represented by a :i
144
73
:guilabel: `(search) ` icon. Use this tool to find a specific contact. Scheduled activities will not
145
74
appear as search results.
146
75
76
+ Make a phone call with VoIP
77
+ ===========================
78
+
79
+ One of the primary purposes of |VOIP | is to make phone calls without needing a phone. Here are the
80
+ three ways to make a phone call in the Odoo database:
81
+
82
+ - Click the :icon: `oi-voip ` :guilabel: `(VoIP) ` icon, located in the top-right of the navigation bar.
83
+ Then, enter the phone number to be called by clicking the :icon: `fa-keyboard-o `
84
+ :guilabel: `(keyboard) ` icon, and then entering the phone number to be called.
85
+
86
+ - To return to the widget's home page, click the :icon: `fa-keyboard-o ` :guilabel: `(keyboard) ` icon
87
+ again.
88
+
89
+ - Click the :icon: `oi-voip ` :guilabel: `(VoIP) ` icon, located in the top-right of the navigation bar.
90
+ Then, click the :icon: `fa-phone ` :guilabel: `(phone) ` icon to redial the last called contact.
91
+ - Click the :icon: `oi-voip ` :guilabel: `(VoIP) ` icon, located in the top-right of the navigation bar.
92
+ Then, search for a specific contact's name or go to the :guilabel: `Contacts ` tab. Then, select the
93
+ contact and click the :icon: `fa-phone ` :guilabel: `(phone) ` icon.
94
+
95
+ When receiving calls in Odoo, the |VOIP | widget rings, and displays a notification. To close the
96
+ widget, click the :icon: `oi-close ` :guilabel: `(close) ` icon in the upper-right of the widget's
97
+ screen.
98
+
99
+ .. note ::
100
+ The |VOIP | number is the one provided by Axivox. It can be
101
+ accessed by navigating to `https://manage.axivox.com/ <https://manage.axivox.com/ >`_. After
102
+ logging into the portal, go to :menuselection: `Users --> Outgoing number ` (column).
103
+
104
+ Transfer a phone call
105
+ ---------------------
106
+
107
+ In |VOIP |, calls can be transferred between users only after answering the call. Otherwise,
108
+ transfers must be done automatically via the provider console/portal.
109
+
110
+ To transfer a call within the |VOIP | widget, first, answer the call using the green :icon: `fa-phone `
111
+ :guilabel: `(phone) ` icon.
112
+
113
+ Once the incoming call is answered, click the :icon: `fa-arrows-h ` :guilabel: `(left-right arrows) `
114
+ icon. Then, enter the extension of the user the call should be forwarded to. Finally, click
115
+ :guilabel: `Transfer ` to route the call to that phone number.
116
+
117
+ .. tip ::
118
+ To find the extension for a user, consult the |VOIP | administrator. If the user has
119
+ :guilabel: `Administration ` access rights set to :guilabel: `Settings `, find extensions by going to
120
+ :menuselection: `Settings App --> Manage Users --> Select the user --> Preferences --> VOIP -->
121
+ VoIP username / Extension number `.
122
+
123
+ Forward a phone call
124
+ --------------------
125
+
126
+ To forward a call within the |VOIP | widget, first, answer the call using the green :icon: `fa-phone `
127
+ :guilabel: `(phone) ` icon.
128
+
129
+ Once the incoming call is answered, click the :icon: `fa-arrows-h ` :guilabel: `(left-right arrows) `
130
+ icon. Then, enter the full phone number of the user the call should be forwarded to. Finally, click
131
+ :guilabel: `Transfer ` to route the call to that phone number.
132
+
133
+ Send an email through the VoIP widget
134
+ =====================================
135
+
136
+ While phone calls are handled through the |VOIP | widget, emails can also be sent through it. This is
137
+ helpful for sending follow-up emails to the call participants, emailing a question to a coworker, or
138
+ reminding a vendor to send over some components during a check-in call.
139
+
140
+ To send an email through the |VOIP | widget, click the :icon: `oi-voip ` :guilabel: `(VoIP) ` icon,
141
+ located in the top navigation bar. When this is clicked, the |VOIP | widget will appear in the
142
+ bottom-right corner of the page. Then, search for a contact to email or find them in the
143
+ :guilabel: `Contacts ` tab of the |VOIP | widget.
144
+
145
+ Next, click the :icon: `fa-envelope-o ` :guilabel: `(envelope) ` icon, and then select the email
146
+ recipients, enter the email's subject line, and write the email. When it is ready to be sent, click
147
+ :guilabel: `Send `. To schedule an email to send later, click the :icon: `fa-caret-down `
148
+ :guilabel: `(dropdown) ` icon next to :guilabel: `Send `, click :guilabel: `Send Later `, pick the
149
+ scheduled time, and click :guilabel: `Schedule `.
150
+
147
151
.. _voip/voip_widget/troubleshooting_voip :
148
152
149
153
Troubleshooting the VoIP widget
@@ -154,13 +158,13 @@ Each section below goes through common issues with the |VOIP| widget and how to
154
158
Missing parameter
155
159
-----------------
156
160
157
- If a *Missing Parameter * error message appears in the Odoo |VOIP | widget, refresh the Odoo window,
158
- and try again.
161
+ If a *Missing Parameter * error message appears in the |VOIP | widget, refresh the window, and try
162
+ again.
159
163
160
164
Incorrect number
161
165
----------------
162
166
163
- If an *Incorrect Number * error message appears in the Odoo |VOIP | widget, make sure to use the
167
+ If an *Incorrect Number * error message appears in the |VOIP | widget, make sure to use the
164
168
international format, leading with the :icon: `fa-plus ` :guilabel: `(plus) `, followed by the
165
169
international country code (e.g., +16506913277, where `+1 ` is the international prefix for the
166
170
United States.)
@@ -170,7 +174,7 @@ The websocket connection with the server has been lost
170
174
------------------------------------------------------
171
175
172
176
If a *The websocket connection with the server has been lost. Please try to refresh the page. * error
173
- message appears in the Odoo |VOIP | widget, then refresh the page close other browser tabs.
177
+ message appears in the |VOIP | widget, then refresh the page close other browser tabs.
174
178
175
179
This error is caused by returning to the database after a period of inactivity, like lunch, or if
176
180
there are too many browser tabs open.
@@ -180,7 +184,7 @@ Failed to start the user agent
180
184
181
185
If a *Failed to start the user agent. The URL of the websocket may be wrong. Please have an
182
186
administrator verify the websocket server URL in the General Settings. * error message appears in the
183
- Odoo |VOIP | widget, then update the browser and computer.
187
+ |VOIP | widget, then update the browser and computer.
184
188
185
189
This error is caused by the browser or computer not being up-to-date (and can also cause issues with
186
190
the microphone).
0 commit comments