Introduction #

‘3CX Do Not Call’ is a Windows service that monitors all outbound calls. If the dialed number is on an internal Do-Not-Call list, then the call will be dropped; and the dialing extension will receive an email notification if it has been selected in the ‘Send Email’ list.

How do I Install the ‘3CX Do Not Call’? #

VoipTools will give you a download link and license key after purchase. You can simply go through the simple installer to proceed with the installation.

What Are The Features? #

1. Ability to set an expiry date on each entry.
2. Ability to manually add numbers to the list.
3. Receive email notification when calling a number on an internal Do-Not-Call list, if the dialing extension is selected in ‘Send Email’ list.
4. View the call log history of all the extensions that dialed the numbers on ‘Do Not Call List’.

Prerequisites #

Before installing ‘3CX Do Not Call’, you need to ensure that your computer meets the minimum requirements mentioned below:

1. 3CX Version V16 and V18 (Professional or Enterprise Version Only)
2. Microsoft .Net 4.7.2
3. Microsoft SQL Server 2014 or above (Including the free SQL Express edition)
4. Windows 10 or above / Windows Server 2012 or above (64 bit)
5. Microsoft Internet Information Server (IIS) 7.0 or above

Note:

• When installing SQL Server, we recommend you install it in “Mixed Mode” to include SQL Authentication, and install SQL Management Studio
• When installing IIS, be sure to install Basic Authentication, .Net Extensibility, and ASP.Net 4.X

Installation #

Download software

You can order ‘3CX Do Not Call’ on-line at https://www.voiptools.com.  Your order confirmation email will include your license key and a link to download the software.

Install Prerequisites

There are a number of prerequisites that must be installed prior to installing ‘3CX Do Not Call’. These prerequisites include Microsoft Internet Information Server (IIS) and Microsoft SQL Server

Install ‘3CX Do Not Call’

This User Guide contains step-by-step instructions to successfully install ‘3CX Do Not Call’. Begin by extracting the installer from the downloaded zip file (Step 1 above), then run the setup program named 3CXDoNotCallInstaller.exe

Register your License Key

You must register your license key to activate ‘3CX Do Not Call’. Your license key is included in your order confirmation email, and can also be found in your order history on our website.

Step By Step Installation Procedure #

The following section guides you through a detailed walk-through of the installation process.

Step 1: Download 3CX Do Not Call #

You can find the software download link in the Order Confirmation Email, or you can find it in your order history on our website.

Step 2: Install the Prerequisites #

Click on the software installer downloaded in Step 1. The installation wizard will automatically identify the prerequisites and assist you with each installation required to 3CX Do Not Call. It includes .NET Framework (Web Installer), SQL Server Express (Web Installer), and SQL Server Management Studio.

1. Click the downloaded installer executable to launch the Prerequisites Setup Wizard and click Next.

2. In the Prerequisites window, install all the required prerequisites identified by the installer, or select/ unselect the applications based on your requirements and click Next to continue.

The installer will download and install the selected applications. It may take several minutes to complete.

2. The Microsoft SQL Server License Terms page gets displayed if you install SQL Server Express. Click Accept to acknowledge the license terms and continue.

3. In the Media Location field, browse to change the location and click Install to begin the installation of SQL Server Express.

4. Click Close when you install the prerequisites.

4. Click Next when the installation is complete.

5. Click Yes in the Confirmation Message Box to reboot the computer.

Step 3: Start the installation process #

1. Click Next on the 3CX Do Not Call Setup Wizard screen.

2. On the Select Installation Folder window, the Folder field displays the path where the 3CX Do Not Call gets installed. You cannot change the location path.
3. Click Next to continue

Step 4: Test Relay Settings #

1. In the 3CX Relay Services window, in the Relay Host field, enter the IP address or FQDN of your 3CX server.
2. Enter 8801 in the Relay Port field.
3. Enter the public key you took from VoIPTools Relay services in the Public Key text area.

1. Click the Test Relay Settings to confirm ‘3CX Do Not Call’ can communicate with the Relay services running on the 3CX server.
2. If the ‘3CX Do Not Call’ is successfully able to communicate with the Relay services that run on the 3CX server, a Success message box appears. Click OK. If the test fails, you will not be able to continue until communication with the relay is established.

Click Next to continue with the installation.

Note:

• You must set the Relay Port to 8801.
• If the test was unsuccessful:
  • Confirm you have the correct firewall port open (default TCP 8801) on the 3CX server and the firewall protecting the 3CX server.
  • Confirm that you have entered the correct IP address / FQDN for the 3CX server.
  • Confirm that the 3CX Do Not Call and Relay use the same port and protocol.

NOTE:

If the Relay test fails, you cannot continue the installation until you establish communication with the Relay.

Step 5: Configure the database #

When configuring 3CX Do Not Call, select an existing Microsoft SQL Server instance in your environment. The database server can be a remote SQL Server (How-to configure SQL server to permit remote connections (https://www.voiptools.com/configure-sql-server-for-remote-access-over-internet/)) or a local instance running on the VolPTools server.

1. On the SQL Database window in the Server field, select the desired instance of SQL Server.
2. To use SQL Authentication, uncheck the Trusted Connection checkbox.
3. In the Username and Password fields, enter valid SQL login account credentials.

NOTE:

• We recommend you use SQL Authentication rather than Windows authentication. Many of our tools leverage a Call Flow Designer (CFD) application running on the 3CX. Frequently our CFD applications require access to a SQL database. If the 3CX server and the database server are not in an Active Directory domain, Windows authentication will fail.
• To use SQL Authentication, you must configure the SQL server to run in Mixed Mode. If you install SQL Server with our tools, we configure SQL in Mixed Mode.

4. To use Windows Integrated Authentication (not recommended), check the Trusted Connection (Windows integrated authentication) checkbox.

NOTE:

In the Database field, the installer will automatically display the default database name. We encourage you to use the default name. To upgrade or reinstall 3CX Do Not Call, select the current database name from the list.

5. Click the Test SQL Connection button to confirm connectivity to SQL Server.
6. Click OK on the Test Results message box.

Step 6: Installing 3CX Do Not Call #

1. Click Install in the Ready to Install window.

The application installation may take several minutes to complete.

2. Check the Launch 3CX Do Not Call checkbox and click Finish when the installation is complete.

Web Portal #

To access the ‘3CX Do Not Call’ web portal, click the Web Portal button on the configuration program, or click on the desktop icon that was created during the installation process (‘3CX Do Not Call’ Web).

When connecting to the web portal, you will be asked to provide login credentials.

1. In the Extension field, enter your 3CX extension number.
2. In the PIN field, enter your 3CX voicemail PIN.
3. Click Login button to login to your account.
4. Check Remember me check box so that next time you can login automatically without providing login credentials.

Note: ‘Remember Me’ feature will work until the time cache is not cleared.

As an agent, you will be able to see only Reports and About screens.

Settings Screen #

The Settings screen enables you to set global exclusions, set the ‘Scheduled Time’ to delete expired phone numbers, start/stop the Windows service, configure culture settings, email server settings, and register your license key.

 Global Exclusions #

You may have a situation where certain extensions need the ability to call phone numbers that are on the Do Not Call list.  The Exclusion tab allows you to select the extensions that can bypass the Do Not Call restrictions.

1. Place a checkmark next to the extensions you wish to exclude from the Do Not Call restrictions.
2. Press the Save button to commit the changes.

Register Software (License screen) #

Registration is required to authorize your software. Registering also makes it possible for VoIPTools to provide a replacement key if your license key is ever lost. Also, it enables VoIPTools to notify you of any product updates.

1. On the 3CX Do Not Call configuration screen, click the Settings tab, and then select the License tab.
2. Enter your registration information in all the fields (Note the red dot denotes a required field).
3. Click Register.

Note: The license key permits you to install the software on one computer. This is not free software.

Settings Screen #

From here, you can configure ‘Scheduled Time’, and restart ‘3CX Do Not Call’ application with new settings.

1. Under General, and in the Scheduled Time field, enter the desired time so that the timer will check regularly at the scheduled time for contacts that have reached expiry date and deletes them contact from the ‘Do Not Call List’.
2. Select either of the desired Block/White List option based on your requirement:
   • Select Block List if you want to block the outbound calls in the Contacts list. OR,
   • Select White List if you want to allow outbound calls in Contacts list but block those that are not in Contacts list.
3. 3. In the NSN Length field, select the desired number (Say, ‘X’ digits for instance) so that, if X digits from the right of the phone number match with that of the imported number then, ‘3CX Do Not Call’ considers the number.
   • For example, if the original number is 18016424655(11 Digits) and configured NSN Length is 10 then, 3CX Do Not Call will match last 10 digits from the right of the original number with that of the imported number i.e. (8016424655). Hence using this feature, our application will work even without a country code.
4. Press Reload button to log all the users out of ‘Do Not Call’ and restart the application with new settings.

General Screen #

From here, you can configure Culture settings and start/stop the ‘3CX Do Not Call’ service.

 Culture #

You can set the default display culture used when displaying dates and times. The portal will automatically update the display of the underlying UTC date/ time stored in the database to the selected culture. This is a global setting.

• From the Display Culture dropdown, select the language to control the display of data for the complete ‘3CX Do Not Call’ web portal. The default language is English-US.

Start/Stop Service #

• To start or stop a service, click Start/ Stop button.
• Click Refresh link to update the status if changes to the service status were made directly in the Windows Service Snap-in.

Note: If the service status is “Unknown”, this is typically caused by the ‘3CX Do Not Call’ IIS Application Pool user may have insufficient rights.

Field Definitions #

START/ STOP	A Windows Service (3CX Do Not Call) runs in the background. You can monitor the status of this service here (Running, Stopped, Unknown). If you make changes to any of the settings, it is necessary to stop and start the service.
REFRESH	The ‘Refresh’ link will update the status if changes to the service status were made directly in the Windows Service Snap-in.

Email Screen #

From here, you can configure ‘Email Server Settings’.

• Configure Email Notifications
  1. On the Settings screen, click the Email tab.
  2. Check the Enable Notifications checkbox if you want to enable email notifications.
• Add Email Address
  1. To define who should receive notifications, on the left of Email Address column header, click  Add button and add email addresses. The grid supports batch edit which enables you can add or delete or edit multiple addresses before you save update them.
  2. In the Email Address field, enter the email address where notifications should be sent.
  3. Click Save changes to save the email address to the grid.
• Update Email Address
  1. From the Email Address list, select and edit the desired email address that you want to edit.
  2. Click Save changes to save the updated email address to the list.
• Delete Email Address
  1. In the Email Address list, look for the email address that you want to delete.
  2. Beside the desired email address, click  Delete button.
  3. To save your changes, press the Save Changes button
• Email Notification Settings
  1. In the Mail Server text field, enter the mail server name (IP address or ‘Fully Qualified Domain Name’ (FQDN)) from which you want to send the notifications.
  2.  In the Port field, enter the port number of the mail server. Default port number is 25.
  3.  In the Reply Address field, enter the email address from which you want to send the notifications.
  4.  In the User and Password fields, enter the login credentials of the email account from which you want to send the notifications (if required by your mail server).
  5. If you want to reveal the password, click the More button; and to conceal it, click the same button once again.
  6. Check SSL/TLS check box if your server requires a secure connection to relay email.
  7. To test your email settings, you can send a sample email notification to the configured email addresses by clicking on the Test button.
  8. Click Save to save all the email servers and notification settings.

Import Screen #

You can access the Import screen only as a ‘Manager’. Here, you can import contacts from a CSV file into the central repository of contacts.

Note:It is mandatory to restart the ‘Do Not Call’ Service once you import new contacts in order to apply DNC.

Import Contact List

1. Log into the ‘3CX Do Not Call’ Web Portal with ‘Manager’ credentials.
2. In the Import screen, and in the Import File field, click Browse button to select the import file (.csv).
3. In the List Name field, enter the name for the contact list.

Note: If you do not specify List Name, then the contact will be created without a list name.

4. Select the Delimiter option according to the one that you have specified in the import file (.csv).

Note: Comma is the default delimiter

5. Click Get Fields button to load the CSV column headers into the CSV File list box.
6. Move each one of the columns from the CSV File list box into the CSV Field list box using the appropriate buttons such that the columns in CSV Field list box will match with those of Contact Field list box.
7. If you want to overwrite existing contacts, check Update existing contacts check box.

Note: Be sure to map the Name and Phone fields.

8. Click Import button to import all the contacts from the CSV file into the central repository of contacts.

Add Extensions to White List

1. In the Settings screen, if you select:
   • Block List then,
     1. In the Import screen, you will not be able to call any of the contact numbers in the imported contact list.
     2. To enable desired extensions to call any of the specific contact number, simply expand the desired contact number and then add the desired extensions to the white list.

Note: This functionality will work only for ‘Block List’ and not for ‘White List’.

1. • White List then,
     1. In the Import screen, you can call all the contact numbers in the imported contact list.
2. Once the grid displays the result, you can export the display data to the desired format by clicking appropriate button. The possible formats are .pdf, .xls, xlsx and .rtf

Send Email Screen #

The Send Email screen enables you to select desired contacts from the list of all the contacts to which you want to send email notification in case if they call the contacts that are in ‘Do Not Call List’

1.  In the Send Email screen, select all the extensions for which you want to send email notifications.
2. Click Update to save the changes.

Note: If a caller calls an extension on a DNC list then the call simply disconnects and the caller will receive an email notification if selected or will not receive any notification if not selected in the ‘Send Email’ list.

Reports Screen #

The Reports screen enables you to view the history of all the call logs related to ‘Do Not Call List’. The information includes extension number, agent name, dialed number and date & time.

Support #

Visit our website to access our on-line manuals and receive quick answers to most of your questions. Otherwise, you can contact us by phone, email, live chat and on the VoIPTools forums.

Support Hours (USA and India) #

Our team is ready to assist you with answers to your technical questions and we now offer 24/7, 365 days a year.

Windows Event Log (Applications and Services ? VoIPTools) #

The Windows Event Log lists various errors, information messages and warnings related to all our VoIPTools applications and services. The data here can be used for troubleshooting various application errors.

Forums #

Our forum is intended for VoIPTools customers to collaborate on real-life challenges, solutions and best practices. You can participate on our forum at: https://www.voiptools.com/community/

Submit a Bug #

If you suspect a bug in any of our VoIPTools products, you can bring it to our notice by reporting your issue at: https://www.voiptools.com/report-a-bug/

Live Chat #

Our chat support team is ready to acknowledge your queries in real-time. You can start a live chat with us by simply clicking on the Live Chat button at the lower right corner of our web page.

Email #

You can email us at: support@voiptools.com. Be sure to describe your issue in detail. We’ll get back to you within one business day of receiving your request.

Phone #

You can call us at +1 801-642-4655 to reach a representative. VoIPTools will accept calls at this number from 8:00 AM to 6:00 PM (Central Standard Time).

Support Services #

Free Support: #

If you purchased our products through a VoIPTools Partner, your Partner will provide first level support. Partners have access to 100% free technical support, provided they participate actively in the troubleshooting process.

VoIPTools customers have access to our on-line manuals and we will respond to emails (next business day) and live chat, but we will not login to your servers remotely.

Paid Support: #

If you purchase “Installation Support’ our support team can login to your servers and install and configure all our tools for you. This includes installing SQL Server Express and Internet Information Server if required. Our team will work with you to configure our applications to best meet your needs.