VoIP Client Registration Guide

1. Introduction

1.1 Purpose

This guide provides detailed instructions for technical agents on how to register a VoIP client (Device) to a FreeSwitch server. The aim is to ensure a smooth and efficient registration process for Contaqt’s end-users.

1.2 Scope

The guide covers the registration process for common VoIP clients (softphones, hardware phones, mobile apps) and popular VoIP clients.

1.3 Audience

This document is intended for internal use alone.

 2. Prerequisites&Tools

2.1 User Information

1. Account credentials (username and password for Devices)

2. Server details (SIP server domain, API server domain)

3. Local/Remote control, TeamViewer is advised.

4. PowerShell

5. Latency and Jitter testing tools

2.2 Software/Hardware Requirements

1. Compatible SIP client software or hardware phone

2. Stable internet connection

3. VoIP Client Setup

3.1 Softphone Clients (e.g., Zoiper, X-Lite, 3CX)

3.1.1 Download and Install

1. Direct the users to download the remote control software and the  softphone client from the official website.

2. Provide installation instructions specific to the operating system (Windows, macOS, Linux).

3.1.2 Configuration

1. Open the installed softphone application.

2. Navigate to the account settings or SIP account setup section.

3.1.3 Enter Account Information

1. Username: [Enter the client’s Device username]

2. Password: [Enter the  client’s Device password]

3. SIP Server: [Enter the client’s SIP server address]

3.1.4 Advanced Settings (if applicable)

1. STUN Server: [Enter the STUN server address]

2. Port Number: [Specify the port number if not default, allow ports 5060 for TCP and UDP connections, 5061 for TLS connections]

3. rPort: [Enable if exists]

4. SIP Trust Server: [Enable if exists]

3.1.5 Save and Register

1. Save the entered settings.

2. Initiate the registration process by clicking the 'Register' or 'Connect' button.

3.2 Hardware IP Phones (e.g., Cisco, Yealink, Polycom)

3.2.1 Connect and Power On

1. Connect the IP phone to the network via Ethernet cable.

2. Power on the IP phone and wait for it to boot up.

3.2.2 Access Phone Settings

1. Access the phone's web interface using a web browser. (Use remote if needed)

2. Log in to the web interface using the default or provided credentials. Make sure to reset the default password

3.2.3 Configure SIP Account

1. Navigate to the Accounts and Devices modules on the client’s portal.

2. Enter the following details:

• Account Name: [Enter a descriptive name for the account]

• SIP Server: [Enter the Contaqt Telephony  SIP server address]

• Username: [Enter the Devices username]

• Password: [Enter the Devices  password]

3.2.4 Advanced Settings (if applicable)

1. Configure additional settings such as:

2. NAT Traversal: Enable/disable and configure STUN/TURN server if needed

3. Transport Protocol: Select UDP/TCP/TLS as required

4. STUN Server: [Enter the STUN server address]

5. Port Number: [Specify the port number if not default, allow ports 5060 for TCP and UDP connections, 5061 for TLS connections]

6. rPort: [Enable if exists]

7. SIP Trust Server: [Enable if exists]

3.2.5 Save and Reboot

1. Save the settings and reboot the phone to apply changes.

2. Verify that the phone registers successfully with the VoIP service.

3.3 Mobile VoIP App - Acrobit

3.3.1 Download and Install

Instruct users to download the VoIP app from the App Store

 (iOS - https://apps.apple.com/us/app/cloud-softphone/id567475545) 

or Google Play Store

 (Android - https://play.google.com/store/apps/details?id=com.contaqt.cloudphone&pli=1).

3.3.2 Configuration

1. Open the installed app and navigate to the QR Scanning section.

2. Scan the QR code on the user profile of your Sip account

3.3.3 Advanced Settings (if applicable)

Configure additional settings such as:

1. STUN Server: [Enter the STUN server address]

2. Transport Protocol: Select UDP/TCP/TLS as required

3.3.4 Save and Register

1. Save the settings and initiate the registration process.

2. Verify that the app registers successfully with the VoIP service.

4. Troubleshooting

4.1 Common Issues

1. Registration Failure: Check username/password, SIP server address, and network connectivity.

2. One-Way Audio: Verify NAT traversal settings (STUN) and firewall configuration.

3. Call Drops: Check network stability and QoS settings.

For more info on registering different Sip clients, please see here.