3CX Auto Self ID User Guide

1.Introduction

3CX Auto Self ID is a 3CX plugin that enables you to auto-generate the self-identification message that 3CX requires in order to be listed in the company directory.

2.Prerequisites

Before installing 3CX Auto Self ID, you need to ensure that your computer meets the minimum requirements mentioned below:

1. Windows 10 and above (64 Bit)

2. Basic knowledge of web programming and IIS configuration

3. 3CX Commercial License V15.5

• 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

3.Installation


Download software

You can order ‘3CX Auto Self ID’ 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 Auto Self ID’.

 


Install 3CX Auto Self ID

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


Register your License Key

You must register your license key to activate ‘3CX Auto Self ID’. 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 Auto Self ID’

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

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

3. Click Next to continue.


Figure 1: 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 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 Auto Self ID 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 Relay Settings

1. In the 3CX Server Platform drop down, select Windows for old Relay or Linux for new Relay based on the 3CX version of your application.


Figure 2: Test VoIPTools 3CX Relay settings


If you choose ‘3CX Server Platform’ as ‘Windows’ then ‘3CX Auto Self ID’ will communicate with old Relay Service, and if you choose ‘Linux’ then it will communicate with new Relay Service.

2. In the Relay Services Host field, enter “localhost” if installing ‘3CX Auto Self ID’ 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 Windows or 8800 for Linux.


Figure 3: Test VoIPTools 3CX Relay settings


The ‘3CX Auto Self ID’ will take default port as 8700 for Windows and 8800 for Linux. 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 Auto Self ID’ can communicate with the Relay services running on the 3CX server.

5. If the ‘3CX Auto Self ID’ 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.


Figure 5: Installation in progress

Step 6: Run the Application

Once the installation is complete, click Run Application


Figure 6: Run Application

5.3CX Auto Self ID Settings

The 3CX Auto Self ID Settings configuration screen enables you to register software, start/stop ‘3CX Auto Self ID Service’, and configure settings for Text-To-Speech, Schedule Timer, Audio Path and Authentication for Active Directory User/ Remote Local User.

5.1. Register Software

Registration is required to authorize your license key. 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, and reminders if your key is reaching the renewal date.

a. In the 3CX Auto Self ID Settings configuration screen, click License tab, and then in the License Key field, enter valid license key.

b. Enter appropriate details in all the other fields of the page.

c. Click Register


Figure 7: Register Software

d. In the confirmation message box, click OK.


Figure 8: Confirmation message box

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

5.2. Start/Stop ‘3CX Auto Self ID Service’

1. To start or stop a service, at the footer of the 3CX Auto Self ID Settings configuration screen, click Start/ Stop buttons respectively.

2. Click Refresh link to update the status if changes to the service status were made directly in the Windows Service Snap-in.

If the service status is “Unknown”, this is typically caused by the ‘3CX Auto Self ID’ IIS Application Pool user may have insufficient rights.

5.3. Settings Screen

The Settings screen enables you to configure ‘Text-To-Speech’, Audio Path, Schedule Timer, and Culture, Voice Name. You can also change the domain account of the user to ‘Active Directory’ or ‘Remote Local’.

The section below explains instructions to configure various parameters:

1. Configure Text-To-Speech

a. In the configuration screen and in the Settings tab, from the TTS Type drop down, select the ‘Text-To-Speech’ as Windows TTS.


Figure 9: Settings: TTS Type – Windows TTS

b. Select Amazon Poly if you want to create ‘Self Identification Message (.wav file) using Amazon Web Services.


Figure 10: Settings: TTS Type- Amazon Poly

To know how to create Amazon Web Services (AWS) account and generate AWS access key ID and secret key id, click here.

2. Configure Schedule Timer

a. In the Schedule Timer field, set the time in ‘Hr:Min:Sec’ format so that the scheduler creates .wav files for all the surnames of the 3CX extensions, regularly at the scheduled timing.

3. Configure Audio Path

a. In the Audio Path field, browse and set the location where you want to store the audio (.wav) files created by Auto Self ID.

4. Authentication

If the server where ‘3CX Auto Self ID’ is installed and the 3CX server both participate in the same Active Directory (AD) domain, you can enter an AD domain account. However, if both servers are not participating in the same AD domain, you will need to provide credentials for a local windows user that exists on the 3CX server.

Active Directory User

Under Windows Authentication section, if you check Active Directory User check box, you will need to perform several tasks:

a. Change the 3CX Auto Self ID IIS Application Pool login user.

b. Recycle the IIS Application Pool and Website.

c. Change the 3CX Auto Self ID Windows Service login user.

d. Grant the user “Login as a service right”.

e. Restart the 3CX Auto Self ID service.

Domain Name Windows Domain Name
User Name Windows Domain User Name
Password Windows User Password

Remote Local User

If you check Remote Local User check box, a ‘Net Use’ command connects to the remote shared folder using the supplied credentials of a local user that exists on the 3CX server.

Unlike the “Active Directory User” option, this option will NOT make changes to the ‘3CX Auto Self ID’ Windows service account or change the IIS application pool authentication.

Domain Name 3CX Server Name
User Name 3CX Server-Local User Name
Password 3CX Server-Local Password

5. Configure Gender

a. From the Gender dropdown, select Male or Female so that the Auto Self ID will play the .wav file in male or female voice.

6. Culture

a. From the Culture dropdown, select the desired option in order to control the display of dates and currency throughout 3CX Auto Self ID application.

The default ‘Culture’ is en-US.

7. Configure Voice Name

a. From the Voice Name drop down, select desired voice name so that the Auto Self ID will play the .wav file accordingly.

5.4. Check for Updates

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 11: Check for Updates

6.Generate Amazon Associate Product Advertising API Keys

This section guides you through a detailed walk through of creating an AWS account, and generating AWS access key ID and secret key IDs.

6.1. Create Amazon Web Services (AWS) Account

1. Open web browser and in the address bar, type the url: https://portal.aws.amazon.com/

2. In the Sign-In page:

a). Click on Create a new AWS account.


Figure 12: AWS Account Signin 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.


Figure 13: Create Login Credentials

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.


Figure 14: 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.


Figure 15: Enter Payment Information

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 16: Generate Automated Call

e). In the Call in progress… popup, 4-digit pin is displayed.


Figure 17: 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 18: 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.


Figure 19: Support Plans

8. In the Welcome to Amazon Web Services page, click on Sign In to the Console to navigate to the ‘AWS Sign In’ page.


Figure 20: Navigate to AWS Signin Page

6.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 21: Enter your AWS account email address

b). Enter the Password of your AWS account and click on Sign in.


Figure 22: Enter Sign in Credentials

2. On the menu bar, click the down arrow beside Services.


Figure 23: Services

3. Under Security, Identity & Co… section, select IAM.


Figure 24: Security, Identity & Co… – IAM

4. Click the down arrow beside Delete your root access keys and then click on Manage Security Credentials.


Figure 25: Delete your root access keys

5. In the popup message box, click on Continue to Security Credentials.


Figure 26: Continue to Security Credentials

6. In the Your Security Credentials page, click on Access Keys (Access Key ID and Secret Access Key)


Figure 27: Access Keys (Access Key ID and Secret Access Key)

7. Click on Create New Access Key.


Figure 28: 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.


Figure 29: Download Key File

9. Once the file downloads, click on Save to save the rootkey.csv file.


Figure 30: Open with Notepad

10. To open and view the rootkey.csv file, click Open.


Figure 31: Save rootkey.csv file

11. The rootkey.csv file displays as shown in the image below:


Figure 32: rootkey.csv file

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.

You can see only your Access Key ID in your AWS account, but you will not see your Secret Key ID ever again. Hence, ensure that you will never lose your downloaded key file.


Figure 33: Access Key ID created

7.Configure ‘Call By Name’ feature

You can create a digital receptionist in the ‘3CX Management Console’ and configure it to implement the ‘Call by Name’ feature. When you dial the digital receptionist that is configured for the ‘Call by Name’ feature, and press the associated Key ID followed by the first three letters of the desired ‘Last Name’, the ‘Auto Self ID’ will play the respective ‘Full Name’ of the person that you are trying to contact.


Figure 34: 3CX Management Console: Create Digital Receptionist and Configure ‘Call by Name’ feature

Instructions to configure ‘Call by Name’ feature:

1. In the 3CX Console Management, navigate to SIP Trunks.

2. Under General section and in the Enter a name field, enter the name for the digital receptionist.

3. In the Extension field, enter valid digital receptionist number.

4. To configure Call by Name feature, under Menu Options, beside desired Key ID, from the Actions column, select Call by Name value from the drop down list.

5. At the top of the page, click OK to save the settings.

6. To implement the feature:(For example)

a). On your ‘3CX Phone System’, dial the extension of the digital receptionist that is configured for the ‘Call by Name’ feature.

b). Press the Key ID that is configured with Call by Name action.

c). The digital receptionist will play the prompt as, “please enter the first three letters of last name of the person you are trying to contact”

d). Enter the first three letters of the last name of the person that you are trying to contact.

e). If there are multiple last names matching the 3 digits that you have entered, then the digital receptionist will play the prompt to press 0 or 1 or 2 to select the desired contact from the matching list. Once you have selected the desired contact, the digital receptionist will play the ‘Full Name’ of the person you are trying to contact.

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