3CX Survey Creator User Guide


Every organization strives to offer better service to its customers. 3CX Survey Creator enables you to collect information that identifies how your customers feel about the services offered by your organization through phone surveys. This information will enable you to identify areas where your organization can improve, increase the quality of services that you provide, and measure the effectiveness of individual staff members.

1.1. What is 3CX Survey Creator?

3CX Survey Creator creates phone based automated surveys. Through a web based application you create Surveys and associate them with a specialized Digital Receptionist (IVR). To take a survey, the caller is transferred to a 3CX Digital Receptionist where a series of questions are asked and the caller’s responses are saved in a SQL database.

1.2. Why 3CX Survey Creator?

1. To survey callers regarding the quality of service provided by your organization.

2. To analyze the caller’s responses and make informed decisions.

1.3. How to use 3CX Survey Creator?

To create a survey, you need to log into the 3CX Survey Creator web portal as an admin. There you can create questions, group questions into surveys, and associate a survey with a specific extension within 3CX. With Survey Creator you can create an extensive library of surveys, and easily modify existing surveys to further refine the information you collect. As an agent, you can transfer a customer’s call to a survey. Once the customer participates in the survey and exits from the call, the survey results can be viewed by the admin.


Before installing 3CX Survey Creator, you need to ensure that your computer meets the minimum requirements mentioned below:

1. 3CX Version 15.5 – 16 (Professional or Enterprise Version Only)

2. Windows 10 or above / Windows Server 2012 (64 bit) or above

3. Microsoft SQL Server 2014 or above (Including the free SQL Express edition)

4. Microsoft .Net 4.7.2

5. VoIPTools’ 3CX Relay Service installed on the 3CX server

6. Microsoft Internet Information Server (IIS) 7.0 or above

7. Installation on a domain controller may require additional assistance

• Since the add-on ‘3CX Survey Creator ’ includes a CFD application, you will need to install either Pro or Enterprise version of 3CX

• 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


Download software

You can order 3CX Survey Creator 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 Survey Creator. These prerequisites include Microsoft Internet Information Server (IIS) and Microsoft SQL Server

Install 3CX Survey Creator

This User Guide contains step-by-step instructions to successfully install 3CX Survey Creator. Begin by extracting the installer from the downloaded zip file (Step 1 above), then run the setup program named 3CXSurveyCreatorInstaller.exe

Register your License Key

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

4.Step by step Installation Procedure

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

Step 1: Download 3CX Survey Creator

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 3CXSurveyCreatorInstaller.exe

2. Double-click the file to start the VoIPTools Setup Wizard.

3. Click Next to continue.

Figure 1: 3CX Survey Creator Setup Wizard

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 by 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 Survey Creator directly on the 3CX server, you can install the Relay simply by clicking the Install/ Upgrade Relay button and following the Relay install instructions.

If you have already installed the Relay, you need not install it again unless a newer version is required.

Step 5: Test the VoIPTools 3CX 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 Survey Creator’ 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 Survey Creator’ 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 Relay or 8800 for New Relay.

Figure 3: Relay Services Port

The ‘3CX Survey Creator’ 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 ‘3CXSurvey Creator’ can communicate with the Relay services running on the 3CX server.

5. If the ‘3CX Survey Creator’ is successfully able to communicate with the Relay services that run on the 3CX server, a Success message box appears. Click OK.

Figure 4: Success message box

6. Click Next to continue the installation.

Step 6: Configure the database

1. When prompted for the database connection information, click Configure.

Figure 5: Configure Database

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 SQLExpress.

• If you want to use ‘SQL Authentication’, then install SQL Server in ‘Mixed‘ mode.

• If SQL Server is installed on a server other than the server where 3CX Survey Creator is installed, you will need to configure SQL Server to allow remote connections.

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 Username and Password, and select appropriate database value from the Select or enter a database name drop down.

Figure 8: SQL Server Authentication

The first time you install 3CX Survey Creator, DO NOT enter a database name. Choose Select or enter a database name and leave the database name blank. The installer will create the SQL database automatically and apply the necessary permissions. If upgrading 3CX Survey Creator from a previous version, select the existing database from the list.

4. Click the Test Connection button to confirm connectivity to SQL Server.

5. Click OK to save the SQL Connection information.

6. Click Next to create the required SQL database objects.

Figure 9: Configure Database

7. When the installation is complete, click Close.

Figure 10: Installation Complete

5.3CX Survey Creator - Configuration

The 3CX Survey Creator configuration screen enables you to register software, set recording path, check and upload latest versions of the application, start/ stop 3CX Survey Creator service and connect to the web portal.

5.1. Register Software
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 Survey Creator configuration screen, select License tab.

2. Enter your registration information in all the fields (Note the red dot denotes a required field).

3. Click Register.

Figure 11: License

5.2. Configure Recording Path
The Recording Path specifies the original location where the recordings are stored. You can change the default path if required.

1. On the 3CX Survey Creator configuration screen, select Settings tab. By default, the 3CX Survey Creator displays the default recording path.

2. To change the default path (if desired), click More button beside Recording Path field.

3. Browse the desired location where you want to store the recordings.

Figure 12: Settings: Configure Recording Path

5.3. Check for Updates

The Check for Updates button on the License tab enables you to easily download the latest version of 3CX Survey Creator. If a newer version of 3CX Survey Creator is available, the message will indicate that a newer version is available. Clicking the button will automatically download a .zip file of the latest version of the software. You can install the new version directly over the top of a previous version without the need to uninstall the previous version.

5.4. Start/ Stop 3CX Survey Creator Service

1. In the Settings screen, and at the footer, click Start to start the service.

2. Click Stop to stop the service.

5.5. Connect to Web Portal

1. In the Settings screen, click Web Portal button.


2. In the License screen, at the footer, click Web Portal.

6.Web Portal

To access the ‘3CX Survey Creator’ 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 Survey Creator Web).

An admin logs into web portal to create and edit questions or surveys and view survey results. The ‘Survey Results’ screen enables an admin to view customer’s response and feedback. When an agent transfers customer’s call to a survey, the customer participates in the survey and exits from the call. The survey results are then added to the ‘Survey Results’ screen, which can be viewed by the admin.

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

Figure 13: 3CX Survey Creator Web Portal Login

Log in as Admin

As an admin, you can add/edit a question or survey, and you can view the survey result.

Figure 14: Survey Creator – Admin Login screen

Login as Agent

As an agent, you can transfer the customer’s call to a survey. You will not be able to view or listen to the customer’s response or feedback for the survey.

Figure 15: Login as Agent

6.1.Surveys Screen

The Surveys screen allows you to add a new survey, edit or publish an existing survey. Once you create and publish a survey, you need not publish again even if you edit the survey.

The extensions created for Surveys cannot be used for Call Back Surveys.

Figure 16: Surveys screen

6.1.1. Add a Survey

1. On the menu bar, click Surveys

2. In the Survey Maintenance screen, click Add button to create a new survey

3. In the Add/ Edit Survey dialog box and in the Survey CFD field, enter the Survey Extension number.

Once you create a survey, you will not be able to edit Survey CFD data.

4. In the Survey Name field, enter the name for current survey.

5. In the Survey Description field, enter the description for current survey.

6. In the Survey Intro Prompt / Survey Close Prompt sections, you can create a either a new ‘Text-To-Speech’ prompt or upload a pre-recorded prompt.

a). To create ‘Text-To-Speech’ prompt:

i. In the Prompt (Text-To-Speech) text field, enter the welcome data (for Survey Intro Prompt) or closing prompt (for Survey Close Prompt) so that the customer will be able to hear the audio format of the text at the beginning of the call.

ii. In the .WAV File field, enter the name for the ‘Text-To-Speech’ prompt.

Providing name for .WAV File is optional. If you do not provide any name for the ‘Text-To-Speech’ prompt then Survey Creator will auto-generate a new name while creating the audio file.

iii. Click Create to create the Text-To-Speech’ prompt.

b). To upload and play ‘Pre-recorded’ prompt:

i. Beside Prompt .WAV File field, click Browse to browse for the pre-recorded audio file that you saved on your local system.

ii. Click Save to enable the uploaded audio file.

If you click Create, the Survey Creator enables Prompt (Text-To-Speech) file for the customer. On the other hand, if you Browse for the pre-recorded audio file from your local path and click Save, the Survey Creator enables the uploaded file for the customer.

7. To include questions in the survey, from the Available section, select the desired question and click Include. To include all questions in the survey, click Include All.

8. To exclude questions from the survey, from the Included section, select the desired question and click Exclude. To exclude all questions from the survey, click Exclude All.

10. Click Save to save all the data that you have just added to the Add/Edit Survey screen.

Figure 17: Surveys: Add / Edit Survey

6.1.2. Edit a Survey

1. On the menu select Surveys

2. Click Edit button beside the survey that you want to edit

3. To exclude a question, from the Included section, select the questions that you want to exclude and then click Exclude

4. To include a question, from the Available section, select the questions that you want to include and then click click Include

5. Click Save to save your changes

6.1.3. Delete a Survey

1. In the Surveys screen, from the Survey Maintenance screen, click the Delete button beside the survey that you want to delete.

2. In the Confirm Delete message box, click OK

Figure 18: Surveys: Delete a Survey

6.1.4. Publish a Survey

1. In the Surveys screen, from the Survey Maintenance screen, look for the added survey that you want to publish

2. Click the Publish link beside the survey that you want to publish. See that the status is now changed as ‘Published’

Figure 19: Surveys: Publish a Survey

3. Informationmessage box appears. Click OK

Figure 20: Surveys: Survey Published Successfully

Once you publish a survey, you need not publish it again even if you edit your survey.

6.2.Questions Screen

The Questions screen allows you to add a new question or edit an existing question. The agent should select desired ‘Voice Type’ from the ‘Settings’ tab before creating any survey or Text-To-Speech questions.

Figure 21: Questions screen
6.3.1. Add a Question

To create a new question, you can either create an audio file (.wav file) as ‘Text-to-Speech’, or upload a prerecorded .wav file.

The agent should select desired ‘Voice Type’ from the ‘Settings’ tab before creating any survey or Text-To-Speech questions.

1. On the menu bar, click Questions

2. In the Question Maintenance screen, click to add a new question.


a. On the Add/ Edit Question dialog box, in the Question textbox, type the question

b. Enter the WAV File name

c. From the Valid Answer Values drop down, select the value that best answers the question

d. If your question is about taking a feedback from the customer, from the Valid Answer Values drop down, select Record Feedback option to record the feedback

e. Click Create to generate the .wav file

f. Click to save your changes

Figure 22: Add/ Edit Question

Prerecorded Audio File

a. On the Add/ Edit Question dialog box, in the Question textbox, type the question

b. Click the Browse button and select the file to upload

c. Click to save your changes

If you do not click ‘Create/ Browse’ button while creating or editing your audio file (.wav file), your question will not save

6.3.2. Edit a Question

1. Click beside the question that you want to edit

2. To edit ‘Text-To-Speech’, make the desired changes to the text and click Create to update the changes in the audio file

3. You can also edit Valid Answer Values, Locale, Gender and Voice Name

4. To edit ‘prerecorded’ file, click Browse to change the prerecorded .wav file

5. Click to save your changes

6.3.Survey Results Screen

Once a customer participates in the survey and exits from the call, the survey results are added to the Survey Results screen. Here, as an admin, you can view the survey result details like Survey Extension, Survey Name, Survey Date, Question Text, Caller ID, Caller Name, Agent Id, Agent Name, Response and Feedback.

You can also Reset to clear the Survey Results grid data.

Figure 23: Survey Results Screen

6.4.1. Check Survey Result

1. Login to the Survey Creator web portal as an admin

2. In the Survey Results screen, you can see that the new survey result record has been added. You can look at the Response column to know the survey result.

3. If the customer has accepted to give a feedback, you can play the recorded file

Figure 24: Play Customer Feedback Audio File

6.4.2. Reset Survey Results Data

1. On the right corner of the Survey Log header, click Reset

2. In the Delete Confirmation message box, click OK to delete or click Cancel to preserve the data.

Figure 25: Reset Survey Results Grid Data

6.4.Transfer Screen

The Transfer screen allows you to transfer a customer call to survey. Once you transfer, the customer participates in the survey and the admin will be able to view the survey result from the Survey Results screen.

Figure 26: Transfer screen

6.5.1. Transfer Customer Call to a Survey

1. In the Transfer screen, look for Survey Name that you want to transfer to survey

2. Answer the customer call and in the Transfer to Survey column, click to transfer the call to survey

Figure 27: Transfer Customer Call to Survey

6.5.Settings Screen

The Settings tab enables you to configure ‘Text To Speech’ settings so that you may create questions, intro prompt (welcome note), close prompt (closing prompt) as ‘Text To Speech’ (.wav file).

Figure 28: Text To Speech Settings

1. In the Settings tab, and from the TTS Type drop down, select the TTS type as:

a). Windows TTS – if you want to create TTS message (.wav file) using built-in Windows Web Services.

b). Amazon Polly – if you want to create TTS message (.wav file) using Amazon Web Services.

2. From the Locale drop down, select the desired language for your audio file.

3. From the Voice Name drop down, select the desired voice name that you want to apply for the Text-To-Speech wav file.

4. If you have selected the TTS Type as Windows TTS then:

a). From the Gender drop down, select male or female voice.

b). From Voice Name drop down, select desired prerecorded voice that comes with the operating system of your local system.

‘Voice Name’ values are context sensitive to ‘Gender’ drop down

5. If you have selected the TTS Type as Amazon Polly then:

a). In the Amazon Id field, enter valid Amazon Id for the Amazon Polly account.

b. In the Amazon Key field, enter valid Amazon Key for the Amazon Polly account.

6. Click Test to test the generated .wav file for the respective TTS type that you have just configured.

7. Click Save to save the TTS settings.

6.6.Site Settings Screen

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’

Figure 29: Site Settings screen

6.7.1. Custom Brand Settings

1. In the Site Settings tab and 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 30: 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.

Figure 31: Grid Color Palette

ii. The final display after applying ‘Grid Color’ branding settings:

Figure 32: Display of Customized Grid Color

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.

Figure 33: Custom Logo

d. Customize ‘Header Title Prefix’ Text

i. In the Header Title field, enter the text that you want the application to display as ‘prefix’ for the existing title in application header.

Figure 34: Custom Header Title Prefix

2. Once you perform desired customizations, click Apply.

Figure 35: Display of Customized Brand Settings

3. To reset to default settings, click Reset.

6.7.About Screen

The About screen displays current version of the application. From here, you can also update your application to latest version by clicking on Check for Updates button.

Figure 36: About Screen


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, 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.

• 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.

Suggest Edit

Get the Best Solution for your Business

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