8000 [IMP] VoIP: Devices + Integrations Revamp · odoo/documentation@3d863a9 · GitHub
[go: up one dir, main page]
Skip to content

Commit 3d863a9

Browse files
justinmallettejustinmallette
committed
[IMP] VoIP: Devices + Integrations Revamp
Co-authored-by: Zaz Linkous <ZazLinkous@gmail.com>
1 parent ac6af9f commit 3d863a9

File tree

1 file changed

+95
-157
lines changed

1 file changed

+95
-157
lines changed

‎content/applications/productivity/voip/devices_integrations.rst

Lines changed: 95 additions & 157 deletions
Original file line numberDiff line numberDiff line change
@@ -1,196 +1,134 @@
1-
========================
2-
Devices and integrations
3-
========================
1+
=============================
2+
VoIP devices and integrations
3+
=============================
44

5-
:abbr:`VoIP (Voice over Internet Protocol)` can be used on many different devices, such as a
6-
computer, tablet, mobile phone, and many more. This is helpful in that it reduces costs, and
7-
employees can work from anywhere in the world, so long as they have a broadband internet connection.
5+
.. |VOIP| replace:: :abbr:`VoIP (Voice over Internet Protocol)`
6+
.. |SIP| replace:: :abbr:`SIP (Session Initiation Protocol)`
87

9-
Odoo *VoIP* is SIP (Session Initiation Protocol) compatible, which means it can be used with *any*
10-
:abbr:`SIP (Session Initiation Protocol)` compatible application.
8+
While |VOIP| is available on Odoo's desktop experience, it can also be used through the :doc:`Odoo
9+
mobile app <../../../administration/mobile>` and through third-party apps as well. As long as the
10+
app is compatible with |SIP|, it can be used to make and receive calls with Odoo |VOIP|.
1111

12-
This document covers the process of setting up Odoo *VoIP* across different devices and
13-
integrations.
14-
15-
Odoo is fully-integrated with all Odoo apps, allowing users to click into any app, and schedule a
16-
call as an activity in the chatter.
17-
18-
.. example::
19-
For example, in the *CRM* app, a user can click into an opportunity, and click on
20-
:guilabel:`Activities` in the chatter.
21-
22-
Next, they can choose :guilabel:`Call`, and under :guilabel:`Due Date`, they can select a date.
23-
24-
Once they click :guilabel:`Save`, an activity shows up in the chatter.
25-
26-
Should the :guilabel:`Due Date` be for today's date, the activity shows up in the :abbr:`VoIP
27-
(Voice over Internet Protocol)` widget.
28-
29-
.. image:: devices_integrations/crm-voip-widget.png
30-
:align: center
31-
:alt: View of CRM leads and the option to schedule an activity for Odoo Discuss.
32-
33-
Odoo VoIP (laptop/desktop computer)
34-
===================================
35-
36-
The Odoo *VoIP* (Voice over Internet Protocol) module and widget can be used from any browser on a
37-
laptop or desktop device. Simply click on the :guilabel:`☎️ (phone)` icon in the upper-right corner,
38-
while in the Odoo database, and the widget appears.
12+
Odoo |VOIP| is fully integrated with the **Contacts**, **CRM**, **Sales**, and **Helpdesk** apps.
13+
While the benefits are most clearly felt when using |VOIP| from the Odoo database, it can also be
14+
used from apps like :ref:`Linphone <voip/linphone>` and :ref:`Zoiper Lite <voip/zoiper>`.
3915

4016
.. seealso::
41-
To see how to use the :abbr:`VoIP (Voice over Internet Protocol)` widget on a desktop/laptop
42-
computer, check out this documentation: :doc:`voip_widget`.
43-
44-
Odoo VoIP (tablet/mobile device)
45-
================================
17+
Using |VOIP| through the Odoo mobile app or through a third-party tool still requires a |VOIP|
18+
service provider. Learn more about signing a :doc:`VoIP service provider <../voip>`.
4619

47-
The Odoo *VoIP* app can be used on tablets and mobile phones, through the Odoo Android or Apple IOS
48-
applications. Additionally, a mobile web browser can be used to access the database.
20+
VoIP via the Odoo mobile app
21+
============================
4922

50-
.. warning::
51-
Odoo Android and Apple IOS applications are no longer being maintained by Odoo on the Android and
52-
Apple portals. This means Odoo support only handles limited scopes of Odoo Android or Apple IOS
53-
support tickets.
54-
55-
.. important::
56-
While outgoing calls can be placed using Odoo on a mobile device, be aware that Odoo is **not** a
57-
full :abbr:`VoIP (Voice over Internet Protocol)` application, and does **not** ring on incoming
58-
calls. If the user needs to be reachable on a mobile device at all times, an app, like Zoiper,
59-
should be used. Apps like that stay connected in the background at all times.
23+
Odoo |VOIP| is available through mobile browsers as well as through the Odoo app (available through
24+
the Apple App Store and Google Play Store). Odoo recommends using a mobile browser to access a
25+
database, rather than the mobile apps.
6026

61-
For more information, see this documentation: :ref:`voip/zoiper`.
27+
.. danger::
28+
Odoo mobile apps available in app stores are no longer supported by Odoo. Learn more about
29+
:doc:`Odoo's mobile apps <../../../administration/mobile>`.
6230

63-
While in the mobile application on a mobile device/tablet, access the Odoo *VoIP* widget, by tapping
64-
on the :guilabel:`☎️ (phone)` icon in the upper-right corner. The widget appears in the lower-left
65-
corner.
31+
Make a call through the mobile app
32+
----------------------------------
6633

67-
When first making a call from the tablet using the mobile application, the user is prompted to
68-
:guilabel:`Allow` the database to use the microphone. Click :guilabel:`Allow` when prompted to
69-
continue with the call using the microphone.
34+
To make a call through the Odoo mobile app, first tap the :icon:`oi-voip` :guilabel:`VoIP` icon at
35+
the top of the screen. From here, the |VOIP| widget will appear on the screen. After that, the user
36+
can start a call using one of three ways:
7037

71-
This step is **necessary**, whether using the mobile Odoo application or web browser.
38+
- Enter the phone number to be called by clicking the :icon:`fa-keyboard` :guilabel:`(keyboard)`
39+
icon, and then entering the phone number.
40+
- Click the :icon:`fa-phone` :guilabel:`(phone)` icon to redial the last called contact.
41+
- Search for a specific contact's name or go to the :guilabel:`Contacts` tab. Then, select the
42+
contact and click the :icon:`fa-phone` :guilabel:`(phone)` icon.
7243

73-
.. image:: devices_integrations/allow-mic.png
74-
:align: center
75-
:alt: Allow the database to access the microphone.
44+
When the first call from the mobile app is made, a prompt to allow the database to use the device's
45+
microphone appears. When this prompt appears, click :guilabel:`Allow` to continue with the call.
7646

77-
Odoo then asks how to make the call. The two options are : :guilabel:`VOIP` or :guilabel:`Phone`
78-
(should the tablet be enabled for calling). Click the box next to :guilabel:`Remember ?` should this
79-
decision be the default moving forward.
80-
81-
.. image:: devices_integrations/voip-phone.png
82-
:align: center
83-
:alt: Window prompt to choose whether to use VOIP or the devices phone to make the call.
84-
85-
Here is the layout of what the Odoo *VoIP* app looks like on a mobile device:
47+
.. important::
48+
Allowing the app to use the device's microphone is **necessary**, regardless of whether the
49+
mobile Odoo application or web browser is used. If permission is not granted, calls cannot be
50+
made from the app.
8651

87-
.. image:: devices_integrations/voip-odoo-dashboard.png
88-
:align: center
89-
:alt: Layout of what the VoIP app looks like on the a mobile device.
52+
Odoo then asks how to make the call. The two options are to either use |VOIP| or use the phone's
53+
connection. Click the box next to :guilabel:`Remember ?` should this decision be the default moving
54+
forward.
9055

9156
.. _voip/zoiper:
9257

9358
Zoiper Lite
9459
===========
9560

96-
*Zoiper Lite* is a free :abbr:`VoIP (Voice over Internet Protocol)` :abbr:`SIP (Session Initiation
97-
Protocol)` dialer with voice and video.
98-
99-
To start using the *Zoiper* app, download it to the device, via the `Zoiper download page
100-
<https://www.zoiper.com/en/voip-softphone/download/current>`_.
101-
102-
A mobile device is the most common installation, and this document covers how to set up on the
103-
*Zoiper* IOS application. Screenshots and steps may differ depending on the set up conditions.
61+
*Zoiper Lite* third-party alternative to Odoo |VOIP|. It is a free |VOIP| |SIP| dialer with voice
62+
and video.
10463

105-
After installing the *Zoiper* application on the mobile phone, open the application, and tap on
106-
:guilabel:`Settings`. Navigate to :menuselection:`Accounts`, and tap on the :guilabel:`+ (plus)`
107-
icon to add an account.
64+
To start, download the *Zoiper Lite* app from either the `Google Play Store
65+
<https://play.google.com/store/apps/details?id=com.zoiper.android.app>`_ or `Apple's App Store
66+
<https://apps.apple.com/us/app/zoiper-lite-voip-soft-phone/id438949960>`_. This section will cover
67+
setting up *Zoiper Lite* for an iOS device while using :doc:`Axivox <axivox/axivox_config>` as the
68+
|VOIP| service provider, so the experience may differ for other operating systems or |VOIP| service
69+
providers.
10870

109-
If the :abbr:`VoIP (Voice over Internet Protocol)` account is already set up, then click
110-
:guilabel:`Yes`. This means an account username and password has already been produced.
71+
Once *Zoiper Lite* is installed on the mobile device, open the app and tap :guilabel:`Settings`.
72+
Navigate to :menuselection:`Accounts`, and tap the :guilabel:`+ (plus)` icon to add an account.
11173

112-
.. image:: devices_integrations/account-settings-zoiper-group.png
113-
:align: center
114-
:alt: Zoiper account setup, shown in the view from a mobile device.
74+
If a |VOIP| service provider is signed, then tap :guilabel:`Yes` when the app asks if the user has
75+
an account username and password. From here, tap :guilabel:`Manual configuration` unless the |VOIP|
76+
service provider's country is known (if it is, then tap :guilabel:`Select provider` and find the
77+
provider through the list).
11578

116-
Next, tap on :guilabel:`Select a provider`. On the screen that populates, tap :guilabel:`Country`,
117-
in the upper-right corner, to narrow the providers down to a specific country. Choose the country
118-
for the provider that is being configured, then find the :guilabel:`Provider`, and select it.
79+
If :guilabel:`Manual configuration` was tapped, tap :guilabel:`SIP account`. From here, under
80+
:guilabel:`SIP OPTIONS`, fill out the fields:
11981

120-
.. example::
121-
If the provider being configured is *Axivox*, then select :guilabel:`Belgium`. Then, choose
122-
:guilabel:`Axivox` as the provider.
82+
- :guilabel:`Account name`: How this account appears in *Zoiper Lite*. Can be anything.
83+
- :guilabel:`Domain`: The |VOIP| service provider's domain. This is unique to each service provider
84+
account.
85+
- :guilabel:`Username`: The user's |SIP| username. This is unique to each user account in the
86+
service provider account.
87+
- :guilabel:`Password`: The user's |SIP| password. This is unique to each user account in the
88+
service provider account.
12389

124-
.. image:: devices_integrations/provider-zoiper-odoo.png
125-
:align: center
126-
:alt: Zoiper account setup, choosing the provider.
90+
.. tip::
91+
To access this information through the *Axivox* portal, click :guilabel:`Users`, then choose a
92+
user and click :guilabel:`Edit`, and finally click the :guilabel:`SIP Identifiers` tab.
12793

128-
Under :abbr:`SIP (Session Initiation Protocol)` options, enter the :guilabel:`Account name`,
129-
:guilabel:`Domain`, :guilabel:`Username`, and :guilabel:`Password`. All this information varies,
130-
based on the account.
94+
Once all of this information is entered, tap the green :guilabel:`Register` button at the top of the
95+
screen. *Zoiper* will confirm the information, then show a message saying :guilabel:`Registration
96+
Status: OK` if everything was correct. From here, the *Zoiper Lite* app can now be used to make and
97+
take phone calls using the |VOIP| service.
13198

132-
.. tip::
133-
To access this information, via the *Axivox* portal, navigate to :menuselection:`Users --> Choose
134-
user --> Edit --> SIP Identifiers tab`. The :guilabel:`SIP username`, :guilabel:`Domain`,
135-
:guilabel:`SIP password`, and :guilabel:`Address of the proxy server` are all present in this
136-
tab.
137-
138-
.. list-table::
139-
:header-rows: 1
140-
141-
* - Zoiper Field
142-
- Axivox Field
143-
* - Account name
144-
- *Can be anything*
145-
* - Domain
146-
- Domain
147-
* - Username
148-
- SIP username
149-
* - Password
150-
- SIP password
151-
152-
Once this account information is entered, click the green :guilabel:`Register` button at the top of
153-
the screen. Once the registration information is checked, *Zoiper* populates a message, stating
154-
:guilabel:`Registration Status: OK`.
155-
156-
At this point, *Zoiper* is now set up to make phone calls using the :abbr:`VoIP (Voice over Internet
157-
Protocol)` service.
158-
159-
.. image:: devices_integrations/sip-options-zoiper.png
160-
:align: center
161-
:alt: Zoiper account setup, registration successful.
99+
.. _voip/linphone:
162100

163101
Linphone
164102
========
165103

166-
*Linphone* is an open-source :abbr:`VoIP (Voice over Internet Protocol)` :abbr:`SIP (Session
167-
Initiation Protocol)` softphone, used for voice, video, messaging (group and individual), as well as
168-
conference calls.
169-
170-
To start using the *Linphone* app, download it to the device, via the `Linphone download page
171-
<https://new.linphone.org/technical-corner/linphone?qt-technical_corner=2#qt-technical_corner>`_.
104+
*Linphone* is a third-party alternative to Odoo |VOIP|. It is a free |VOIP| |SIP| dialer with voice,
105+
video, messaging (direct messages and group chats), and can support conference calls.
172106

173-
A mobile device is the most common installation, and this document covers how to set up the
174-
*Linphone* IOS application. Screenshots and steps may differ depending on the circumstances.
107+
To start, download the *Linphone* app from either the `Google's Play Store
108+
<https://play.google.com/store/apps/details?id=org.linphone>`_ or the `Apple App Store
109+
<https://apps.apple.com/us/app/linphone/id360065638>`_. This section will cover setting up
110+
*Linphone* for an iOS device while using :doc:`Axivox <axivox/axivox_config>` as the |VOIP| service
111+
provider, so the experience may differ for other operating systems or |VOIP| service providers.
175112

176-
To begin configuring *Linphone* for use with a :abbr:`SIP (Session Initiation Protocol)` provider,
177-
first open *Linphone*, and an assistant screen appears.
113+
Once *Linphone* is installed on the mobile device, open the app and tap on :icon:`fa-bars`
114+
:guilabel:`(menu)`. From here, tap :guilabel:`Assistant`, then tap :guilabel:`Use SIP ACCOUNT`. Read
115+
the warning message, then tap :guilabel:`I understand`.
178116

179-
From this screen, select :guilabel:`Use SIP Account`. Then, on the following screen, enter the
180-
:guilabel:`Username`, :guilabel:`Password`, :guilabel:`Domain`, and :guilabel:`Display Name`. Once
181-
complete, press :guilabel:`Login`.
117+
From here, under :guilabel:`SIP OPTIONS`, fill out the fields:
182118

183-
At this point, *Linphone* is ready to start making calls, once there is a green button at the top of
184-
the application screen that reads, :guilabel:`Connected`.
185-
186-
.. image:: devices_integrations/linphone-odoo-setup.png
187-
:align: center
188-
:alt: Linphone account setup, registration successful.
119+
- :guilabel:`USERNAME`: The user's |SIP| username. This is unique to each user account in the
120+
service provider account.
121+
- :guilabel:`PASSWORD`: The user's |SIP| password. This is unique to each user account in the
122+
service provider account.
123+
- :guilabel:`DOMAIN`: The |VOIP| service provider's domain. This is
124+
unique to each service provider account.
125+
- :guilabel:`DISPLAY NAME`: How this account appears in *Linphone*. Can be anything.
189126

190127
.. tip::
191-
*Linphone* makes a variety of applications for mobile and desktop devices in operating systems,
192-
such as Windows, Linux, Apple, and Android. Because *Linphone* is an open-source project, many
193-
new updates are released on a regular basis.
128+
To access this information through the *Axivox* portal, click :guilabel:`Users`, then choose a
129+
user and click :guilabel:`Edit`, and finally click the :guilabel:`SIP Identifiers` tab.
130+
131+
Tap :guilabel:`UDP` for :guilabel:`TRANSPORT`, then tap :guilabel:`LOGIN`.
194132

195-
See `Linphone's wiki-documentation page
196-
<https://wiki.linphone.org/xwiki/wiki/public/view/Linphone/>`_.
133+
From here, *Linphone* can be used to make and take calls once a green banner that says
134+
:guilabel:`Connected` appears at the top of the screen.

0 commit comments

Comments
 (0)
0