Whether you are a small school, or a large campus of buildings, you need to know immediately who dialed 911. With 3CX Emergency Notifier, your emergency responders will know exactly where to go.
1.1. What is 3CX Emergency Notifier?
With 3CX Emergency Notifier, you will have complete control over 911 notifications. You can control the content of notifications, who is notified, and how they are notified (email, SMS, and phone call). Show emergency responders exactly where the problem is located. This is a “MUST HAVE” solution for educational facilities and businesses with multiple buildings.
1.2. Why 3CX Emergency Notifier?
The important features of 3CX Emergency Notifier include the following:
1. Know immediately who dialed 911
2. Call, email or text to any phone number or email address you added
3. Notify critical staff immediately when 911 has been dialed. Notifications include:
a. Who called (extension, mobile number, first and last name)
b. Where (address, floor, pillar, cubicle)
4. Notifications are easily customizable
5. Know exactly where the emergency exists and who made the phone call to 911
6. View the logs of all events to know how and who was notified and update notes accordingly for future reference
1.3. How to Use 3CX Emergency Notifier?
3CX Emergency Notifier is a onetime installation process. Once you install it, the product allows you to gain complete control over 911 notifications using a simple web portal.
Before you begin with the installation steps mentioned in this guide, you need to ensure that your computer meets the minimum requirements mentioned below for installing 3CX Emergency Notifier.
1. 3CX Version 15.5 – 16 (Professional or Enterprise Version Only)
2. Windows 10 or above / Windows Server 2012 or above
3. Microsoft SQL Server 2014 or above (Including the free SQL Express edition)
4. Microsoft Internet Information Server (IIS) 7.0 or above
5. .Net 4.7.2 or above
Download software
You can order 3CX Emergency Notifier on-line at http://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 Emergency Notifier. These prerequisites include Microsoft Internet Information Server (IIS) and Microsoft SQL Server
Install 3CX Emergency Notifier
This User Guide contains step-by-step instructions to successfully install 3CX Emergency Notifier. Begin by extracting the installer from the downloaded zip file (Step 1 above), then run the setup program named EmergencyNotifierInstaller.exe
Register your License Key
You must register your license key to activate 3CX Emergency Notifier. Your license key is included in your order confirmation email, and can also be found in your order history on our website.
Configure General, Email and Voice Settings
To control the access and storage of 911 notifications, you need to configure certain settings by logging into Emergency Notifier Web Portal.
The following section guides you through a detailed walk-through of the installation process.
Step 1: Download 3CX Emergency Notifier
You can check for the software download link included in your order confirmation email. As an alternative, you can also find the link from your order history on our website.
Step 2: Extract the installer from the downloaded .zip file
The file you downloaded in the above step is a compressed .zip file.
1. Position the mouse on the zip file and right-click.
2. From the popup menu, select Extract All to extract the software
Step 3: Start the installation process
1. From the extracted folder, find the file EmergencyNotifierInstaller.exe
2. Double-click the file to start the VoIPTools Setup Wizard.
3. Click Next to continue.
Step 4: Download the VoIPTools 3CX Relay (if required)
3CX permits one 3rd party application to communicate with the 3CX server at a time. To overcome this limitation, VoIPTools created the 3CX Relay Service. The Relay is a lightweight application that is installed directly on the 3CX server. The Relay exposes the 3CX Call Control API (and other VoIPTools services) to all our applications, and manages requests and events between VoIPTools products and 3CX. The Relay also makes it possible to install our VoIPTools products on a remote server (including over the internet).
1. If you have not previously installed the Relay on your 3CX Server, you can download the Relay installer by clicking on the Download Relay button. The Relay must be installed directly on the 3CX server.
2. If you are installing 3CX Emergency Notifier directly on the 3CX server, you can install the Relay simply by clicking the Install/ Upgrade Relay button and following the Relay install instructions.
Step 5: Test Relay Settings
1. In the Relay Type drop down, select Legacy Relay for old Relay or New Relay for new Relay based on the 3CX version of your application.
Figure 2: Test VoIPTools 3CX Relay settings
If you choose ‘Relay Type’ as ‘Legacy Relay’ then ‘3CX Emergency Notifier’ will communicate with old Relay Service, and if you choose ‘New Relay’ then it will communicate with new Relay Service.
2. In the Relay Services Host field, enter “localhost” if installing ‘3CX Emergency Notifier’ on the 3CX server. If 3CX resides on a different server, enter the IP address or FQDN of the 3CX server.
3. In the Relay Services Port field, enter the value as 8700 for Legacy Relayor 8800 for New Relay.
The ‘3CX Emergency Notifier’ will take default port as 8700 for ‘Legacy Relay’ and 8800 for ‘New Relay’. If the default port number doesn’t appear automatically, you can manually enter the respective default port number.
4. Click Test Relay Settings to confirm ‘3CX Emergency Notifier’ can communicate with the Relay services running on the 3CX server.
5. If the ‘3CX Emergency Notifier’ is successfully able to communicate with the Relay services that run on the 3CX server, a Success message box appears. Click OK.
6. Click Next to continue the installation.
Step 6: Configure the database
If this is your first install then, select a valid SQL server and if you are reinstalling then select the existing database.
1. When prompted for the database connection information, click Configure.
2. In the Connection Properties dialog box, enter the SQL server name. If using the free SQL Express edition, the default SQL Instance name is
Figure 6: Connection Properties
3. Enter the login credentials.
a. If using Windows integrated security, select Use Windows Authentication. The VoIPTools installer will create a local windows user name as “VoIPTools” and will give sufficient rights to this user to create / update the SQL database.
Figure 7: Windows Authentication
b. If SQL Server authentication is desired, select Use SQL Server Authentication. Be sure to select a SQL Login that has sufficient permissions to alter the database and create SQL objects. Enter the User name and Password, and select appropriate database value from the Select or enter a database name drop down.
Figure 8: SQL Server Authentication
4. Click Test Connection button to confirm you can connect to SQL
5. Click OK to close the test results dialog
6. Click Next to continue the installation
Step 7: Close the Application
Once the installation is complete, click Close
Step 8: 3CX Emergency Notifier Setup
If you wish to run 3CX Emergency Notifier as a user other than the default local VoIPTools user, you can specify the desired user in the 3CX Emergency Notifier Setup screen. For example, you may need to change the user to a domain account if you are using SQL integrated security and a remote SQL server. Applying this change will perform several tasks.
Tasks:
1. Change the 3CX Emergency Notifier IIS Application Pool login user
2. Recycle the IIS Appication Pool and Website
3. Change the 3CX Emergency Notifier Windows Service login user
4. Grant the user “Login as a service right”
5. Restart the 3CX Emergency Notifier Windows service
Figure 11: 3CX Emergency Notifier Setup
1. In the 3CX Emergency Notifier Setup screen, click Windows tab
2. In the Hub URL field, enter the Hub URL (in most cases, the default value should work)
3. In the Web Portal Password section, select the desired 3CX Password type option based on which using which you want to login to web portal.
4. Click Save
1. In the Services tab, click Start button beside the service you want to start
2. Click Stop button beside the service that you want to stop
3. Click Save to save the changes
Step 9: Check for default data in database server
To verify if you have successfully installed 3CX Emergency Notifier application, you need to log into the data base and check for default data in the basic tables.
1. Log into the SQL database.
2. In the Object Explorer accordion, expand Databases and then expand Tables
3. From the tables list,
a. Open dbo.EmergencyNumbers table to see the emergency contact number “911”
b. Open dbo.Messages table to see message type for the emergency number as Email, SMS and Email Subject.
c. Open dbo.NotificationSettings table to see the emergency contact number “911”
d. Open dbo.Settings table to see the default database settings.
In addition to sending emergency notifications by phone, email, and SMS text, you can also receive
notifications on your desktop.
The following instructions outline how to install the desktop notification application:
Before you launch the application, you need to ensure that the following prerequisites are installed:
If the above component is already installed, you can launch the application. Otherwise, follow the instructions as mentioned below to install the component.
1. On the File Explorer, navigate to:
C:\ProgramData\VoIPTools\Data\Http\wwwroot\3CX Emergency Notifier\Alert
Figure 12: Navigate to ‘3CX Emergency NotifierAlert’
2. Double-click EmergencyAlertUpdater to display Emergency Alert URLUpdate popup.
3. In the Emergency Alert URLUpdate popup, enter your URL in the format
and click Update.
4. In the Emergency Alert Application Update URL popup, click OK.
Figure 14: URL to install prerequisites
5. Open web browser and in the address bar, type the url:
http://localhost:5600/Alert/EmergencyAlerter.htm
6. The following web page appears:
Figure 15: Install Prerequisites
7. Click Install to install the prerequisites.
8. You can now launch the application.
9. On the taskbar and in the notification area, click the Show hidden icons icon to display
notification area overflow
Figure 16: Show hidden icons: Notification Area Overflow
10. In the notification area overflow, right-click on the Emergency Alerts icon and in the right
click menu, click Preferences.
Figure 17: Notification area overflow: Emergency Alerts: Preferences
11. In the Preferences screen and in the Server URL field, enter the url:
12. Click Save to save the url and then click Close to close the Preferences screen.
13. In the notification area overflow, right-click on the Emergency Alerts icon and in the right
click menu, click Exit to exit from the Emergency Alerts.
Figure 19: Notification area overflow: Emergency Alerts: Exit
14. On the desktop, click 3CX Emergency Notifier icon to launch the application.
To access the 3CX Emergency Notifier 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 Emergency Notifier Web).
When connecting to the web portal, you will be asked to provide login credentials:
The Settings screen enables you to register 3CX Emergency Notifier, configure general settings, email server, voice settings, and customize brand settings.
Hover over the mouse on Settings tab to display the drop down menu with the following menu options:
1. Emergency Notifier Settings
2. Site Settings
5.1.1. Emergency Notifier Settings
Emergency Notifier Settings enable you to register 3CX Emergency Notifier, and configure general settings, email server and voice settings.
5.1.1.1. License tab (Registration)
For registration, you need to log into ‘3CX Emergency Notifier’ web portal and perform the following tasks:
1. In the 3CX Emergency Notifier web portal, hover over the mouse on Settings tab and from the drop down menu, select Emergency Notifier Settings.
Figure 21: Select – Emergency Notifier Settings
2. In the Settings screen, click License tab
3. In the Registration section, enter License Key and other details appropriately
4. Click Register
5.1.1.2. Configure General Settings (General tab)
5.1.1.3. Configure Email Server (Email tab)
1. In the Email tab, under Email Server section, in the Server field, enter the IP address or Fully
Qualified Domain Name (FQDN) of your email server. Examples: 192.168.1.20 or
mail.mydomain.com
2. In the Port field, enter SMTP Port number. Default port number is 25.
3. In the From Email: field, enter the reply email addresses for email and SMS notifications.
4. In the Authentication section, enter Username and Password.
5. Click Test button to test if Email Server is able to communicate with 3CX Phone System.
6. Click Save to save the data.
5.1.1.4. Configure Voice Settings (Voice tab)
3CX Emergency Notifier can call your contacts and “play” a recording. The recording can be prerecorded, or
dynamically created using Text-To-Speech. A dynamically created recording can list information about
the extension where the emergency number was dialed. The following settings make it possible for you
to modify some of the attributes of the voice used to make dynamic recording.
1. Under Voice Settings section, check Dynamic Recording check box to turn on Dynamic recordings.
Uncheck the check box if you want to use a prerecorded recording rather than Text-To-Speech.
Prerecorded messages are uploaded on the “Messages” tab.
2. From the Locale dropdown list, select the desired culture.
3. From the TTS Type drop down list, select the TTS Type as Windows TTS or Amazon Polly as per your requirement.
a). Select TTS Type: Windows TTS if you want to create dynamic play files by using the voices installed in your computer.
(i). From the Voice Name drop down list, select the voice that you want to use for dynamic recordings. Usually,
this field displays all of the voices installed on the computer.
(ii). From the Gender dropdown, select Male or Female so that the Emergency Notifier will play the .wav file in male or female voice.
(iii). From the Volume drop down list, select the volume that you want to apply for your recording.
(iv). From the Speech Rate drop down list, select the desired speech rate to adjust the speed of the speech.
b). Select TTS Type: Amazon Polly if you want to create ‘Self Identification Message (.wav file) using Amazon Web Services.
Figure 26: TTS Type: Amazon Polly
(i). In the Amazon Id and Amazon Key fields, enter valid details. To know how to create Amazon Web Services (AWS) account and generate AWS access key ID and secret key id, click here.
(ii). From the Voice Name drop down list, select the voice that you want to use for dynamic recordings. Usually,
this field displays all of the voices installed on the computer.
4. Click Save to save the data.
5.1.2. Site Settings
Site Settings enable you to customize branding settings for the application that include the following:
1. Customize the gradient color of ‘Application Header’
2. Customize grid color in screens that display grid data
3. Customize logo on the ‘Application Header’
4. Customize ‘Header Title Prefix’ on the ‘Application Header’
Custom Brand Settings
1. Hover over the mouse on Settings tab and from the drop down menu, select Site Settings
Figure 28: Select Site Settings
2. In the Custom Branding Settings form, perform the following Brand Setting Customizations:
a. Customize Application Title Header – Gradient Color
i. Beside Header Gradient Color and from the Top Color palette, select the desired color that you want to display as the top color for the ‘Application Title Header’.
Figure 29: Header Gradient Color
ii. From the Bottom Color palette, select the desired color that you want to display at the bottom of the ‘Application Title Header’ in gradient to the selected Top Color.
b. Customize Grid Color
i. From the Grid Color palette, select the color that you want to display for the grid in screens that display grid data.
ii. The final display after applying ‘Grid Color’ branding settings:
c. Customize Logo
i. If you are uploading the logo for the first time then, beside Upload New Logo field, click Browse and select the logo that you want to apply. You will now observe that the logo is added to the Custom Logo drop down list.
ii. From the Custom Logo drop down list, select the logo that you have just uploaded.
d. Customize ‘Header Title Prefix’ Text
3. Once you perform desired customizations, click Apply.
In the Extensions screen you can import extensions from either 3CX phone system or CSV file, and export the extension records in the available various formats like pdf, xls, xlsx, rtf or csv.
5.3.1. Import Extensions from 3CX Phone System
1. In the Extensions screen, select 3CX radio button
2. Click Import Extensions button
5.3.2. Import Extensions from CSV file
1. In the Extensions screen, select CSV radio button
2. Click Choose File button
3. Enter the file path and click Import Extensions button
5.3.3. Add New Extension
1. In the Extensions screen, click to add a new extension
2. In the Extension field, enter valid extension number
3. In the First and Last fields, enter the first and last name of the contact respectively
4. Enter valid Mobile, Floor, Pillar, Cubicle, Address, City, State/ Province and Zip Code details for the new extension
5. Click Save to save the extension
5.4.1. Add New Contact
1. In the Contacts screen, click to add a new contact
2. In the First field, enter the First Name of the contact
3. In the Last field, enter the Last Name of the contact
4. In the Phone field, enter the Phone Number of the contact
5. In the Email field, enter valid Email Address of the contact
6. In the SMS Address field, enter valid SMS Address of the contact
7. From the Extension Group drop down, select the extension group to which you want to assign the contact to
8. Click Save to save the contact
When a ‘Speed Dial’ group receives a call, all the contacts in the group will receive the notifications. The notifications include email or SMS or both. Simply check the email and/ or SMS check box to apply the notification type for the speed dial group.
‘Voice App’ and ‘Alarm’ are the two CFD extensions created manually with a unique id. ‘Voice App Extension’ is programmed on phone and its purpose is to connect the call to its associated contacts. Once the contact receives the call, the ‘Voice App Extension’ internally activates its respective ‘Alarm Extension’ so that it plays the respective audio file for the contact that has received the call.
Only ‘Voice App Extension’ is revealed to the customer and ‘Alarm Extension’ is confidential.
5.5.1. Create Speed Dial
1. In the Speed Dials screen, click to add a new speed dial
2. Enter valid Voice App Extension and Alarm Extension fields respectively
3. In the Description field, enter the description for the speed dial call
4. Check Email and/ or SMS check boxes to apply the notification type for the speed dial call
5. Check Repeat check box if you want to repeatedly play the ‘Audio’ file for the speed dial call
6. From the Audio drop down, select the audio file that you saved on your computer. This file will play as the alarm for the speed dial call
7. Click Publish link to create ‘Voice App Extension’ and ‘Alarm Extension’ in the PBX system
5.5.2. Expand Speed Dial to see Contacts
1. In the Speed Dials screen, click beside Voice App Extension to expand the speed dial
2. Contact Name pop up appears
5.5.3. Add New Contact to Speed Dial
1. Expand the Speed Dial to view its contacts
2. In the Contacts pop up, click to add a new contact to the speed dial
3. From the Contact Name drop down, select the contact you want to add to the group
4. Click Save to save the data
In the Emergency Numbers screen, you can view the list of all the emergency numbers. You can also create a new emergency number here. When an emergency number receives a call, the notification is sent to all the extensions of the extension group to which the emergency number belongs to.
5.6.1. Create New Emergency Number
1. In the Emergency Numbers screen, click to add new emergency number
2. In the Number field, enter valid extension number
3. In the Description field, enter valid description in brief
4. In the Play File field, select the audio file that you already uploaded
5. Click Save to save the data
Messages screen enables you to create an email and SMS to send as notification for a specific speed dial group or emergency number. Here you can either create a new email and SMS message, or edit an existing one.
5.7.1. Create Email Message
1. In the Messages screen, under Notification Messages, select the extension from the extension drop down to which you want to send the email notification
2. In the Email Subject field, enter the subject of the email
3. In the Design editor, type the email content that you want to send as notification to the selected speed dial group or emergency number
4. Click Update to create the email notification
5.7.2. Create SMS Message
1. In the Messages screen, under Notification Messages, select the extension from the extension drop down to which you want to send the SMS notification
2. In the text box, type the SMS content that you want to send as notification to the selected speed dial group or emergency number
3. Click Update to create the SMS notification
4. IVR extension number
The ‘Locations’ screen enables you to create a location (building) by associating an IP address range to the desired group. When a user moves from one location to another, the ‘3CX Emergency Notifier’ automatically updates the group based on the IP address of the phone.
6.1. Create Location
1. In the Locations screen and on the column header, click Add button.
2. From the 3CX Emergency Group dropdown list, select the desired group to which you want to add IP address range.
3. In the IP Address field, enter the IP Address range in either of the two supporting formats as mentioned in the example below:
For Example:
Format 1: 192.168.5.0/24 which means that the IP range is from 192.168.5.0 to 192.168.5.24
Format 2: 192.168.5.0-192.168.5.24 which means that the IP range is from 192.168.5.0 to 192.168.5.24
Figure 44: Select ‘3CX Emergency Group’ and Associate ‘IP Address’ Range
4. At the footer of the Locations page, click Save.
This section guides you through a detailed walk through of creating an AWS account, and generating AWS access key ID and secret key IDs.
1. Open web browser and in the address bar, type the url: https://portal.aws.amazon.com/
2. In the Sign-In page:
3. In the Create an AWS account page:
a). In the Email address field, enter valid email address that you want to use for your AWS account.
b). In the Password field, enter the password for your AWS account and then in the Confirm Password field, retype the password.
c). In the AWS account name field, enter the name that you want to use for your AWS account.
d). Click on Continue.
4. In the Contact Information page:
a). Select the desired Account Type.
b). Enter appropriate details in all the Required Fields* – Full Name, Company Name, Country/Region, Address, City, State/Province or region, Postal code and Phone Number
c). In the Security Check field, enter the security code as displayed on the screen.
d). Check the AWS Customer Agreement check box to indicate that you have read and agreed to the terms of the ‘AWS Customer Agreement’.
e). Click on Create Account and Continue.
5. In the Payment Information page:
a). Enter your Credit/Debit Card Number and Expiration Date details so that AWS can bill your credit or debit card for the usage of AWS products that are not covered by the Free Tier.
b). Click on Secure Submit and provide respective details for authentication.
6. In the Phone Verification page:
a). From the Country/Region code dropdown, select desired country.
b). In the Phone number field, enter your phone number so that AWS can authenticate.
c). Enter the Security Check captcha as displayed on the screen.
d). Click on Call Me Now to immediately receive a call by an automated system.
Figure 49: Generate Automated Call
e). In the Call in progress… popup, 4-digit pin is displayed.
Figure 50: Note PIN and enter in telephone key pad
f). When you receive a call from AWS, answer the call and when prompted, enter the 4-digit number on your phone keypad.
g). Once your identity verification is complete, the screen displays the message as, ‘Your identity has been verified successfully.’
Figure 51: Identity successfully created
h). Click on Continue to select your Support Plan.
7. In the Select a Support Plan page, select the desired support plan. Basic is the default plan and it is free.
8. In the Welcome to Amazon Web Services page, click on Sign In to the Console to navigate to the ‘AWS Sign In’ page.
7.2. Generate Amazon Web Services (AWS) Access Key ID and Secret Key ID
1. In the Sign In page:
a). Enter the E-mail that you have just created while creating your AWS account and click Next.
Figure 54: Enter your AWS account email address
b). Enter the Password of your AWS account and click on Sign in.
2. On the menu bar, click the down arrow beside Services.
3. Under Security, Identity & Co… section, select IAM.
Figure 57: Security, Identity & Co… – IAM
4. Click the down arrow beside Delete your root access keys and then click on Manage Security Credentials.
Figure 58: Delete your root access keys
5. In the popup message box, click on Continue to Security Credentials.
Figure 59: Continue to Security Credentials
6. In the Your Security Credentials page, click on Access Keys (Access Key ID and Secret Access Key)
Figure 60: Access Keys (Access Key ID and Secret Access Key)
7. Click on Create New Access Key.
Figure 61: Create New Access Key
8. In the Create Access Key pop up, click on Download Key File to download the key file that contains the key ID and the secret access key.
9. Once the file downloads, click on Save to save the rootkey.csv file.
10. To open and view the rootkey.csv file, click Open.
Figure 64: Save rootkey.csv file
11. The rootkey.csv file displays as shown in the image below:
12. The Your Security Credentials page will now display your Access Key ID. You can now use your AWS Access Key ID and AWS Secret Key ID to use on your website to link Amazon associate program to the products that you want to put on your website.
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.
Our team is ready to assist you with answers to your technical questions, during normal business hours, which is Monday through Friday, 8:00 AM to 6:00 PM (Central Standard Time), and 8:00 AM to 12:00 AM (Indian Standard Time).
• 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.
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.
Whether through one of our commercial products, or a custom solution built to meet your specific needs, we can help you get the most out of your 3CX investment. Call us today!
Contact Us