VoIP:3rd Party Integration: Difference between revisions

From VTX Public Wiki

(→‎HubSpot: PhoneMondo)
(→‎ZOHO: change titel from Video Training to Demo Video)
Line 2: Line 2:
As basis for integration into third-party products mostly Action URL and TAPI functions are required. Our Softclients support these functions with version > = 7.1
As basis for integration into third-party products mostly Action URL and TAPI functions are required. Our Softclients support these functions with version > = 7.1


= Softclients =
=Softclients=
Softclients are available for Microsoft Windows and MacOS operating system. Most of CRM using Microsoft Windows.
Softclients are available for Microsoft Windows and MacOS operating system. Most of CRM using Microsoft Windows.


To setup Softclient refere to the configuration helper
To setup Softclient refere to the configuration helper

* DesktopCommunicator
*DesktopCommunicator
* DesktopOperator
*DesktopOperator
* DesktopCTI
*DesktopCTI


'''Install the Softclient'''
'''Install the Softclient'''
Same setup guide for all Softphones
Same setup guide for all Softphones
* DE: [https://www.vtx.ch/media/pdf/desktop-control-quick-user-guide-de.pdf Quick User Guide Softclient]
* FR: [https://www.vtx.ch/media/pdf/desktop-control-quick-user-guide-fr.pdf Quick User Guide Softclient]


*DE: [https://www.vtx.ch/media/pdf/desktop-control-quick-user-guide-de.pdf Quick User Guide Softclient]
== Registry of CALLTO and TEL protocol ==
*FR: [https://www.vtx.ch/media/pdf/desktop-control-quick-user-guide-fr.pdf Quick User Guide Softclient]

==Registry of CALLTO and TEL protocol==
The softclient in most of cases automatically registers itself during the installation for the '''CALLTO''' and '''TEL''' protocols.
The softclient in most of cases automatically registers itself during the installation for the '''CALLTO''' and '''TEL''' protocols.
This configuration can change due to the installation of other software.
This configuration can change due to the installation of other software.
Line 21: Line 23:
''Example based on Microsoft Windows 10''
''Example based on Microsoft Windows 10''


* Open Windows Settings and open Default apps menu
*Open Windows Settings and open Default apps menu
* Search for your standard Browswer App
*Search for your standard Browswer App
* Select Choose default apps by protocol
*Select Choose default apps by protocol
<table>
<table>
<tr><td>
<tr><td>
Line 50: Line 52:
TEL protocol assigned to DesktopControl Dialer
TEL protocol assigned to DesktopControl Dialer


== Set up hotkey ==
==Set up hotkey==
In order to enable an outgoing call from a third-party product, Softphones also offers a hotkey.
In order to enable an outgoing call from a third-party product, Softphones also offers a hotkey.
By default it is set to Ctrl+F12 (Strg+F12)
By default it is set to Ctrl+F12 (Strg+F12)
Line 56: Line 58:
It can get personalised to your needs
It can get personalised to your needs


* open Settings / Keyboard
*open Settings / Keyboard
* search for "Dial selected number"
*search for "Dial selected number"
* choose your own setup
*choose your own setup


== Set up Action URL ==
==Set up Action URL==


Open the Action URL settings in the Softclient and add the following setting:
Open the Action URL settings in the Softclient and add the following setting:
* '''Call events''' => Incoming call
* '''Status''' => activated
* '''Scope''' => External calls
* '''Action type''' => Run application
* '''URL''' => <APPLICATION_URL> can be found in the respective [[VoIP:3rd_Party_Integration#CRM_Systems|'''CRM System chapters''']]


*'''Call events''' => Incoming call
== Set up Standard Browser ==
*'''Status''' => activated
*'''Scope''' => External calls
*'''Action type''' => Run application
*'''URL''' => <APPLICATION_URL> can be found in the respective [[VoIP:3rd_Party_Integration#CRM_Systems|'''CRM System chapters''']]

==Set up Standard Browser==
For the integration into Softclients you need the file path of your standard web browser. This is referred to in the documentation with the placeholder <BROWSER>
For the integration into Softclients you need the file path of your standard web browser. This is referred to in the documentation with the placeholder <BROWSER>


Line 85: Line 88:
Always allow the browser to open the app
Always allow the browser to open the app


=== Microsoft Edge ===
===Microsoft Edge===
Example: <BROWSER> = "C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe"
Example: <BROWSER> = "C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe"


=== Firefox ===
===Firefox===
Example: <BROWSER> = “C:\Program Files\Mozilla Firefox\firefox.exe”
Example: <BROWSER> = “C:\Program Files\Mozilla Firefox\firefox.exe”


=== Chrom ===
===Chrom===
Example: <BROWSER> = “C:\Program Files(x86)\Google\Chrome\Application\chrome.exe"
Example: <BROWSER> = “C:\Program Files(x86)\Google\Chrome\Application\chrome.exe"


= CRM Systems =
=CRM Systems=


== HubSpot ==
==HubSpot==
[[File:HUBSPOT.jpg|thumb]]
[[File:HUBSPOT.jpg|thumb]]
There are currently 2 different types of inegration with HubSpot. First option with VTX Softphone directly, second option uses the third-party product from [https://www.phonemondo.com/ PhoneMondo]
There are currently 2 different types of inegration with HubSpot. First option with VTX Softphone directly, second option uses the third-party product from [https://www.phonemondo.com/ PhoneMondo]
Line 103: Line 106:




=== HubSpot & VTX Softphone ===
===HubSpot & VTX Softphone===
[[File:HubSpot-icon.jpg|50px|right]]
[[File:HubSpot-icon.jpg|50px|right]]
[[File:Softphone.jpg|70px|right]]
[[File:Softphone.jpg|70px|right]]
The following integration is possible for HubSpot with DesktopCommunicator/DesktopCTI/DesktopOperator
The following integration is possible for HubSpot with DesktopCommunicator/DesktopCTI/DesktopOperator
* Contact information for incoming calls
* Outgoing call from the application


==== Contact information ====
*Contact information for incoming calls
*Outgoing call from the application

====Contact information====
Add the following <APPLICATION_URL> into the URL field according to the chapter [[VoIP:3rd_Party_Integration#Set_up_Action_URL|'''Set up Action URL''']] :
Add the following <APPLICATION_URL> into the URL field according to the chapter [[VoIP:3rd_Party_Integration#Set_up_Action_URL|'''Set up Action URL''']] :


Line 121: Line 125:
"''C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe''" https://app.hubspot.com/contacts/''35276967''/contacts/list/view/all/?globalSearchQuery=$call.remote_number&query=$call.remote_number
"''C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe''" https://app.hubspot.com/contacts/''35276967''/contacts/list/view/all/?globalSearchQuery=$call.remote_number&query=$call.remote_number


==== Outgoing calls ====
====Outgoing calls====
All numbers can be called via Softclient by clicking on the number
All numbers can be called via Softclient by clicking on the number


Line 127: Line 131:
'''TEL''' prococol must be configured as described in chapter [[VoIP:3rd_Party_Integration#Registry_of_CALLTO_and_TEL_protocol|'''Registry of CALLTO and TEL protocol''']]
'''TEL''' prococol must be configured as described in chapter [[VoIP:3rd_Party_Integration#Registry_of_CALLTO_and_TEL_protocol|'''Registry of CALLTO and TEL protocol''']]


=== HubSpot & PhoneMondo ===
===HubSpot & PhoneMondo===
[[File:HubSpot-icon.jpg|50px|right]]
[[File:HubSpot-icon.jpg|50px|right]]
[[File:PhoneMondo.jpg|100px|right]]
[[File:PhoneMondo.jpg|100px|right]]
Line 133: Line 137:


If you like extensive integration with HubSpot you can use the PhoneMondo product in combination with the VTX Softclients.<br>
If you like extensive integration with HubSpot you can use the PhoneMondo product in combination with the VTX Softclients.<br>
{{ Notice|1=PhoneMondo is a third-party product and VTX does not guarantee this function}}
{{Notice|1=PhoneMondo is a third-party product and VTX does not guarantee this function}}


VTX vPBX offers the following integration with PhoneMondo:
VTX vPBX offers the following integration with PhoneMondo:


* Read the following information<br>
*Read the following information<br>

https://www.phonemondo.com/de/addons/hubspot/
https://www.phonemondo.com/de/addons/hubspot/




==== Set up TAPI Line ====
====Set up TAPI Line====
For the function of PhoneMondo the local TAPI driver from the VTX Softphone is used for both, incoming and outgoing calls.
For the function of PhoneMondo the local TAPI driver from the VTX Softphone is used for both, incoming and outgoing calls.


The TAPI line of the previously successfully installed Softclient must be connectd to PhoneMondeo. Proceed as followed:
The TAPI line of the previously successfully installed Softclient must be connectd to PhoneMondeo. Proceed as followed:

* Login to PhoneMondo
*Login to PhoneMondo
* Open the Lines settings
*Open the Lines settings
<table>
<table>
<tr><td>
<tr><td>
Line 152: Line 158:
</td></tr>
</td></tr>
</table>
</table>

* Select the Softclient (DesktopControl/DesktopOperator)
*Select the Softclient (DesktopControl/DesktopOperator)
* Activate it
*Activate it
<table>
<table>
<tr><td>
<tr><td>
Line 161: Line 168:
The Softclient TAPI is now successfully connected to PhoneMondo
The Softclient TAPI is now successfully connected to PhoneMondo


==== Outgoing Calls ====
====Outgoing Calls====
All numbers can be called via the Softclient by clicking on the icon<br>
All numbers can be called via the Softclient by clicking on the icon<br>
HubSpot and PhoneMondo using TEL protocol which must be configured as described in chapter [[VoIP:3rd_Party_Integration#Registry_of_CALLTO_and_TEL_protocol|'''Registry of CALLTO and TEL protocol''']]
HubSpot and PhoneMondo using TEL protocol which must be configured as described in chapter [[VoIP:3rd_Party_Integration#Registry_of_CALLTO_and_TEL_protocol|'''Registry of CALLTO and TEL protocol''']]


== Twixtel ==
==Twixtel==
[[File:TWIXTEL.jpg|thumb]]
[[File:TWIXTEL.jpg|thumb]]
Twixtel is available in DE/FR/IT, no english version available. Latest Version 61 is from 2019.<br>
Twixtel is available in DE/FR/IT, no english version available. Latest Version 61 is from 2019.<br>
Line 173: Line 180:
Tested and working with IP-phones (Yealink + Snom) using DesktopCTI (not tested with DC or DO only)
Tested and working with IP-phones (Yealink + Snom) using DesktopCTI (not tested with DC or DO only)


=== Configure TAPI in TwixTel ===
===Configure TAPI in TwixTel===

* Open TwixTel
*Open TwixTel
* In Menu Option choose '''Setup Anruferkennung/Wählen'''
*In Menu Option choose '''Setup Anruferkennung/Wählen'''
* In Telecommunication Setup Tab change Apparate-Typ to '''TAPI: DesktopControl'''
*In Telecommunication Setup Tab change Apparate-Typ to '''TAPI: DesktopControl'''
* Enter your Prefix (ex: 071)
*Enter your Prefix (ex: 071)
* Click on Tapi button to activate the Tapi driver
*Click on Tapi button to activate the Tapi driver
* Afterwards test with '''Konfiguration Testen''' if the TAPI got successfully installed and the IP-phone/Softphone can be reached
*Afterwards test with '''Konfiguration Testen''' if the TAPI got successfully installed and the IP-phone/Softphone can be reached
* Confirm with OK
*Confirm with OK
* Restart TwixTel
*Restart TwixTel


<table>
<table>
Line 195: Line 203:
</table>
</table>


=== Configure Options of ''Anrufer Identifikation'' ===
===Configure Options of ''Anrufer Identifikation''===

* Start '''Anrufer Identifikation''' (Task bar)
* In '''Anrufer Identifikation''' go to menu '''Datei - Einstellungen'''
*Start '''Anrufer Identifikation''' (Task bar)
*In '''Anrufer Identifikation''' go to menu '''Datei - Einstellungen'''
* Configure ''Länge der Liste der Anrufenden'': 1000
*Configure ''Länge der Liste der Anrufenden'': 1000
* Activate ''ShowCall Symbol im Infobereich der Taskleiste (SysTray) zeigen''
*Activate ''ShowCall Symbol im Infobereich der Taskleiste (SysTray) zeigen''
* Set value to minimize Caller-Window in ''Das Anruferkennungs-Fenster kann nach einem Anruf automatisch minimiert werden. Wählen Sie die Verzögerung aus der Liste aus:'' '''Nach 15 Sek. minimieren'''
*Set value to minimize Caller-Window in ''Das Anruferkennungs-Fenster kann nach einem Anruf automatisch minimiert werden. Wählen Sie die Verzögerung aus der Liste aus:'' '''Nach 15 Sek. minimieren'''
* Confirm with OK
*Confirm with OK


<table>
<table>
Line 215: Line 224:
</table>
</table>


== ZOHO ==
==ZOHO==
[[File:ZOHO.jpg|thumb|300x300px]]
[[File:ZOHO.jpg|thumb|300x300px]]
The following integration is possible for ZOHO with DesktopCommunicator/DesktopCTI/DesktopOperator
The following integration is possible for ZOHO with DesktopCommunicator/DesktopCTI/DesktopOperator

* Contact information for incoming calls
*Contact information for incoming calls
* Outgoing call from the application
*Outgoing call from the application
=== Video Training: Integrate ZOHO ===

===Demo Video: Integrate ZOHO===
Video showing setup to be able to use click-to-call and number lookup for ZOHO using DesktopControl with Action URL
Video showing setup to be able to use click-to-call and number lookup for ZOHO using DesktopControl with Action URL
<table>
<table>
Line 228: Line 239:
</table>
</table>


=== Contact information ===
===Contact information===
Add the following <APPLICATION_URL> into the URL field according to the chapter [[VoIP:3rd_Party_Integration#Set_up_Action_URL|'''Set up Action URL''']] :
Add the following <APPLICATION_URL> into the URL field according to the chapter [[VoIP:3rd_Party_Integration#Set_up_Action_URL|'''Set up Action URL''']] :


Line 240: Line 251:




=== Outgoing calls ===
===Outgoing calls===
All numbers can be called via the Softclient by clicking on the green icon
All numbers can be called via the Softclient by clicking on the green icon
<table>
<table>

Revision as of 10:15, 4 August 2022

VTX vPBX offers integration into several third-party systems. Customers wish to get contact information on incoming call and would like to do outgoing calls from their CRM As basis for integration into third-party products mostly Action URL and TAPI functions are required. Our Softclients support these functions with version > = 7.1

Softclients[edit | edit source]

Softclients are available for Microsoft Windows and MacOS operating system. Most of CRM using Microsoft Windows.

To setup Softclient refere to the configuration helper

  • DesktopCommunicator
  • DesktopOperator
  • DesktopCTI

Install the Softclient Same setup guide for all Softphones

Registry of CALLTO and TEL protocol[edit | edit source]

The softclient in most of cases automatically registers itself during the installation for the CALLTO and TEL protocols. This configuration can change due to the installation of other software.

Example based on Microsoft Windows 10

  • Open Windows Settings and open Default apps menu
  • Search for your standard Browswer App
  • Select Choose default apps by protocol
Default apps by protocol


CALLTO
Serch for CALLTO and check or chage the default to the application DesktopControl Dialer

assign CALLTO protocol to DesktopControl Dialer

CALLTO protocol assigned to DesktopControl Dialer


TEL
Search for TEL and check or change the default to the application DesktopControl Dialer

assign TEL protocol to DesktopControl Dialer

TEL protocol assigned to DesktopControl Dialer

Set up hotkey[edit | edit source]

In order to enable an outgoing call from a third-party product, Softphones also offers a hotkey. By default it is set to Ctrl+F12 (Strg+F12) This function enables a marked number to be dialed via the Softclient. All characters that cannot be selected are automatically removed and the number normalized. It can get personalised to your needs

  • open Settings / Keyboard
  • search for "Dial selected number"
  • choose your own setup

Set up Action URL[edit | edit source]

Open the Action URL settings in the Softclient and add the following setting:

  • Call events => Incoming call
  • Status => activated
  • Scope => External calls
  • Action type => Run application
  • URL => <APPLICATION_URL> can be found in the respective CRM System chapters

Set up Standard Browser[edit | edit source]

For the integration into Softclients you need the file path of your standard web browser. This is referred to in the documentation with the placeholder <BROWSER>

If you want to initiate an outgoing call from the third-party applications using CALLTO or TEL protocol, configure the application according to "Registry of CALLTO and TEL protocol" The web browser will show a popup window for each call, which can get deactivated in most browsers

Depending on the operating system and installation path, the examples can be different from your installation Easiest way to find the right path is by rightclick on the application - Settings

Browser URL

Always allow the browser to open the app

Microsoft Edge[edit | edit source]

Example: <BROWSER> = "C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe"

Firefox[edit | edit source]

Example: <BROWSER> = “C:\Program Files\Mozilla Firefox\firefox.exe”

Chrom[edit | edit source]

Example: <BROWSER> = “C:\Program Files(x86)\Google\Chrome\Application\chrome.exe"

CRM Systems[edit | edit source]

HubSpot[edit | edit source]

HUBSPOT.jpg

There are currently 2 different types of inegration with HubSpot. First option with VTX Softphone directly, second option uses the third-party product from PhoneMondo



HubSpot & VTX Softphone[edit | edit source]

HubSpot-icon.jpg
Softphone.jpg

The following integration is possible for HubSpot with DesktopCommunicator/DesktopCTI/DesktopOperator

  • Contact information for incoming calls
  • Outgoing call from the application

Contact information[edit | edit source]

Add the following <APPLICATION_URL> into the URL field according to the chapter Set up Action URL :

<BROWSER> https://app.hubspot.com/contacts/<HUBSPOT_URL>/contacts/list/view/all/?globalSearchQuery=$call.remote_number&query=$call.remote_number

<BROWSER>: replace placeholder <BROWSER> with your browser used by follow chapter Set up Standard Browser
<HUBSPOT_URL>: replace placeholder <HUBSPOT_URL> with your personal HUBSPOT installation ID (i.g. 35276967)

Example of URL using Edge + ZOHO:
"C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe" https://app.hubspot.com/contacts/35276967/contacts/list/view/all/?globalSearchQuery=$call.remote_number&query=$call.remote_number

Outgoing calls[edit | edit source]

All numbers can be called via Softclient by clicking on the number


TEL prococol must be configured as described in chapter Registry of CALLTO and TEL protocol

HubSpot & PhoneMondo[edit | edit source]

HubSpot-icon.jpg
PhoneMondo.jpg


If you like extensive integration with HubSpot you can use the PhoneMondo product in combination with the VTX Softclients.

VTX vPBX offers the following integration with PhoneMondo:

  • Read the following information
    https://www.phonemondo.com/de/addons/hubspot/


Set up TAPI Line[edit | edit source]

For the function of PhoneMondo the local TAPI driver from the VTX Softphone is used for both, incoming and outgoing calls.

The TAPI line of the previously successfully installed Softclient must be connectd to PhoneMondeo. Proceed as followed:

  • Login to PhoneMondo
  • Open the Lines settings
PhoneMondo Lines.jpg
  • Select the Softclient (DesktopControl/DesktopOperator)
  • Activate it
PhoneMondo DesktopControlTAPI.jpg

The Softclient TAPI is now successfully connected to PhoneMondo

Outgoing Calls[edit | edit source]

All numbers can be called via the Softclient by clicking on the icon
HubSpot and PhoneMondo using TEL protocol which must be configured as described in chapter Registry of CALLTO and TEL protocol

Twixtel[edit | edit source]

TWIXTEL.jpg

Twixtel is available in DE/FR/IT, no english version available. Latest Version 61 is from 2019.
TwixTel is not supported anymore and will not be updated anymore!
You risk to get wrong lookup of data

Tested and working with IP-phones (Yealink + Snom) using DesktopCTI (not tested with DC or DO only)

Configure TAPI in TwixTel[edit | edit source]

  • Open TwixTel
  • In Menu Option choose Setup Anruferkennung/Wählen
  • In Telecommunication Setup Tab change Apparate-Typ to TAPI: DesktopControl
  • Enter your Prefix (ex: 071)
  • Click on Tapi button to activate the Tapi driver
  • Afterwards test with Konfiguration Testen if the TAPI got successfully installed and the IP-phone/Softphone can be reached
  • Confirm with OK
  • Restart TwixTel
Setup Anruferkennung/Wählen
Telecommunication Setup
Activate TAPI
Test TAPI

Configure Options of Anrufer Identifikation[edit | edit source]

  • Start Anrufer Identifikation (Task bar)
  • In Anrufer Identifikation go to menu Datei - Einstellungen
  • Configure Länge der Liste der Anrufenden: 1000
  • Activate ShowCall Symbol im Infobereich der Taskleiste (SysTray) zeigen
  • Set value to minimize Caller-Window in Das Anruferkennungs-Fenster kann nach einem Anruf automatisch minimiert werden. Wählen Sie die Verzögerung aus der Liste aus: Nach 15 Sek. minimieren
  • Confirm with OK
open Anrufer Identifikation
Twixtel Identifikation
Settings bevore changements
Settings after changements

ZOHO[edit | edit source]

ZOHO.jpg

The following integration is possible for ZOHO with DesktopCommunicator/DesktopCTI/DesktopOperator

  • Contact information for incoming calls
  • Outgoing call from the application

Demo Video: Integrate ZOHO[edit | edit source]

Video showing setup to be able to use click-to-call and number lookup for ZOHO using DesktopControl with Action URL

Contact information[edit | edit source]

Add the following <APPLICATION_URL> into the URL field according to the chapter Set up Action URL :

<BROWSER> https://crm.zoho.eu/crm/<ZOHO_URL>/search?searchword=$call.remote_number

<BROWSER>: replace placeholder <BROWSER> with your browser used by follow chapter Set up Standard Browser
<ZOHO_URL>: replace placeholder <ZOHO_URL> with your personal ZOHO installation ID (which can be found in the URL of your browser when opening ZOHO CRM, i.g. org12345678900)

Example of URL using Edge + ZOHO:
"C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe" https://crm.zoho.eu/crm/org12345678900/search?searchword=$call.remote_number


Outgoing calls[edit | edit source]

All numbers can be called via the Softclient by clicking on the green icon

dial out via ZOHO

CALLTO prococol must be configured as described in chapter Registry of CALLTO and TEL protocol