THIS IS FOR ZOIPER BIZ, TO USE ZOIPER CLASSIC FOLLOW THE STEPS HERE.
Step 1: Install - Zoiper and FIVE CRM CTI Suite
Step 2: Outbound calling - System Configuration
Step 3: TROUBLESHOOTING Outbound Calling - System Configuration
Step 4: Outbound Calling - Configuring Zoiper for Outbound
Step 5: Outbound Calling - Configuring the Registry for Hangup
Step 6: Inbound Calling - Configuring the FIVE CRM Inbound Call Program
Step 7: Inbound Calling - Configuring the system
Step 8: Inbound Calling - Configuring Zoiper
What You Will Need
In order to integrate the system with Zoiper you will need the following systems/software:
• | A computer system, with broadband connection and a headset. |
• | A licence of the system. |
• | A licence and installed copy of the Zoiper softphone “Biz” - available from: http://www.zoiper.com/en/ |
• | The FIVE CRM CTI suite - available for free here: https://fivecrm.com/downloads/FIVECRM_agent_setup.exe |
Step 1: Install - Zoiper and FIVE CRM CTI Suite
• | First download and install Zoiper from http://www.zoiper.com/en/ |
• | Next download and install the FIVE CRM CTI suite from: https://fivecrm.com/downloads/FIVE CRM_agent_setup.exe |
• | When installing the FIVE CRM CTI suite please install everything including the .NET framework. |
Step 2: Outbound Calling - System Configuration
The first part of this guide will look at configuring the system for outbound connection to Zoiper. The following must be done for each user and database area:
1. First log in to the system as a user with an access level of 100 (administrator).
2. Once you have logged in select the menu option, Setup > Users > User Profiles.
3. You will be taken to the following screen:
4. Select the user profile that you want to configure dialing for, and you will be taken into their profile options.
5. From this menu select the “permissions” tab:
6. Inside the tab you will see an option to configure the dialing method:
7. Clicking on this will bring you to the configuration options menu.
a). In the Dialing Method drop down select: URL Scheme
b). In the Dial text box enter the command: zoiper:*telephone
c). In the Hangup text box enter the command: zoiperhang:hang
8. Click save. Repeat for all other users that will require outbound calling functionality.
There should be no further set up necessary within the system.
Step 3: TROUBLESHOOTING Outbound calling - System Configuration
There are several things outside of the system’s control that may prevent outbound calling functioning correctly. Here are a list of common problems.
1. Using Internet Explorer - IE is not a stable platform to execute calling campaigns. You should consider using Google Chrome or Firefox.
2. Google Chrome is not up to date - CTI integration is only supported on the latest versions of Google Chrome.
3. I’ve got the latest version of Chrome but I still can’t dial - Chrome’s security is blocking dialing. Just click on the shield present in the address bar and enable the extension. You should only need to do this once.
4. I’m using Firefox and when I click dial it asks me to select a default program this is completely normal - select zoiper.exe. Before finish select “remember my selection option”. You will need to do this for hang-up to.
5. I’ve done all of this, but when I click dial nothing happens - try reinstalling Zoiper. If that fails we recommend calling our Customer Success Support team.
Please find the solution below. Although be aware that doing this incorrectly can cause problems for your Computer:
i) In Windows 7 and Windows 10 click “start” and then in the search bar type “regedit” and hit enter immediately. In Windows 8 swipe right and down to open the “charms bar” (or windows-key + c) - select search and type in “regedit”.
ii) From the HKEY_CLASSES_ROOT, find the Zoiper subfolder and then open all the folders down the following tree - zoiper\\\\shell\\\command
iii) In this directory right click on the registry entry and select “modify”.
iv) Check to see the entry says C:\Program Files (x86)\attractel\zoiper\zoiper.exe dial_string="%1"
v) Your install path may vary, so you will need to check that it is correct.
Step 4: Outbound Calling - Configuring Zoiper for outbound
1. | First install Zoiper http://www.zoiper.com/en/ |
2. | In Zoiper select Settings and then 'Create a new account'. |
3. | Choose the relevant Account type, SIP, IAX or XMPP. This will depend on the type of account you bought from your provider. |
You will need to input your account details here.
Once you have created your account you will have completed the installation and configuration of Zoiper within Zoiper.
To test the connection try dialing a number. If the number rings your SIP account is connected correctly.
Step 5: Outbound Calling - Configuring the Registry for Hangup
To Hangup Zoiper Biz from within the system you will need to create a Registry Entry for Zoiperhang.
**WARNING** You must be careful when editing the Registry. If you do this incorrectly you will cause yourself problems.
If you are having trouble or are unsure, contact Customer Success Support.
i) You will need to download the Registry File for Zoiperhang. You can download this file here. Save the file somewhere you will be able to easily find it.
ii) In Windows 7 and Windows 10 click “start” and then in the search bar type “regedit” and hit enter immediately. In Windows 8 swipe right and down to open the “charms bar” (or windows-key + c) - select search and type in “regedit”.
iii) Left click on HKEY_CLASSES_ROOT. It will highlight the folder as blue.
iv) Go to File > Import. Select the Registry File you just downloaded.
v) You will receive a confirmation message. Scroll down until you see the zoiperhang folder. Keep expanding the arrows until you get to the command line:
vi) When you select the command folder, this will highlight blue. The data line will display as:
vii) You may need to change this so that it is your install path for zoiper. For example it could be: C:\Program Files\Zoiper\Zoiper.exe
To do this, right click on the current text and select Modify. Type or Paste your install path into the Value data. Make sure you do not remove the hang from the end.
You have now set up the Registry for Hanging up Zoiper within the system.
When you next access or re-load the CRM click-to-dial, auto-dial and Hangup will now be functional.
To troubleshoot Zoiper please refer to your softphone supplier
Step 6: Inbound Calling - Configuring the FIVE CRM Inbound Call program
To do this open the following program
The program looks like this:
Fill in the FIVE CRM URL and the Hash.
To get the FIVE CRM URL go into your instance of FIVE CRM and right click anywhere in the active window and select “this frame” and then “show only this frame”. The process will vary between browsers. For help call Customer Success Support.
The address bar will reveal the full URL. Which will look like this: https://europe4.fivecrm.com/687729/index.php
Delete everything after the identifying numbers e.g. https://europe4.fivecrm.com/687729/
Then enter the address into the “FIVE CRM URL” field.
Next you will need to fill in the “Hash” - this is the unique number that identifies the user.
Within the system open the menu option, Setup > Users > User Profiles.
Select the users that you wish to link Zoiper to. In their setup at the top of the screen you will see the user hash:
Enter the information into the field.
You will also need to select the Browser you are using with your FIVE CRM System.
You can choose to remove and/or add a prefix if you need to using the fields provided.
Note: This can be used for removing Country Codes from Incoming numbers if these are not stored in your system)
Make sure the program is closed. Zoiper will call the program when needed, if it is already running it may prevent screen pop.
Step 7: Inbound Calling - Configuring the system
You will need to make a decision on how you would like the system to manage your inbound calling. The most basic option is that the system will search for the incoming number and pop the corresponding account.
If you wish to use a DNID to restrict incoming numbers to particular database areas you will need to configure the below by placing the correct DNID in each database areas.
In both scenarios you should make sure that the database area has a DNID in it - you can just make up a number if you don’t have one.
To do this you will need to go to the menu option, Setup > Database Areas and select the database area that you would like to set up the inbound functionality for.
Inside the database area configuration, go to Dialling and Call Recording and enter the DNID into the “incoming number field”.
NB:// this does not need to be the incoming number it can be any number you want providing that it matches the DNID setup in Zoiper
Step 8: Inbound Calling - Configuring Zoiper
This part of the guide will explain the configuration of Zoiper to enable inbound screen pop.
1. Go into Zoiper’s Settings and select Preferences.
2. The menu looks like this:
3. Go to 'Automation' from the Top Menu. Then select the 'Automation' tab.
4. In the second section, next to 'Open' select Program.
5. The URL field should change to Program. In this field the first part of the Command should point to the FIVEcrmIncomingCall. You will then need to Copy and Paste the Installation Path for FIVEcrmIncomingCall. This will be in the same place that you downloaded the Agent to. In order to do this you will need to find the FIVE CRM Agent you installed earlier:
A. | The spelling must be exact and have all capital and lowercase letters represented |
B. | It should look like this: c:\fivecrm\fivecrmIncomingCall.exe |
C. | The whole command should look like this: |
c:\fivecrm\fivecrmIncomingCall.exe "&cli=$(CALLERNUMBER)&dnis=$(CALLERNAME)”
D. | The only variable here is the DNIS which must match the DNIS configured in the database area earlier. For example, if I set the Database DNIS number to a001, the second part of the command would be: "&cli=$(CALLERNUMBER)&dnis=$a001” |
6. Click OK.
You have now done everything required to integrate Zoiper with the system.