X-Lite for Windows User Guide
CounterPath Corporation CounterPath Corporation Suite 300, One Bentall Centre 505 Burrard Street, Box 95 Vancouver, BC V7X 1M3 Tel: 604.320.3344 sales@counterpath.com www.counterpath.com © July 2014 CounterPath Corporation. All rights reserved. This document contains information proprietary to CounterPath Corporation, and shall not be used for engineering, design, procurement, or manufacture, in whole or in part, without the consent of CounterPath Corporation.
Contents Introduction................................................................................................................................ 1 Installation and Setup................................................................................................................. 3 Getting Ready ...................................................................................................................... 3 Starting X-Lite .......................................................................
CounterPath Corporation 2
1 Introduction X-Lite is a softphone from CounterPath that enables you to make VoIP voice and video calls, send and receive instant messages, share online status (presence) information, and exchange files. Standard Telephone Features The CounterPath X-Lite softphone has all standard telephone features, including: • • • • • • Call display and Message Waiting Indicator (MWI). Speakerphone and Mute. Redial, Hold, Do Not Disturb. Call history – list of received, missed, and dialed calls.
CounterPath Corporation 2
2 Installation and Setup 2.1 Getting Ready SIP Account Information After choosing a VoIP service provider, you will need the following information: • • • • User name and domain. For example, 1331@domainA.com. Password Authorization Name (if applicable) Firewall traversal and other network information; see page 5. 2.2 Starting X-Lite First-time Startup If X-Lite is not already running, start it as you would any other program: Use the Windows Start menu or double-click the desktop icon.
CounterPath Corporation 2.3 Configuring X-Lite Setting up Accounts After obtaining SIP account information from your VoIP service provider, you can set up X-Lite accounts. Set up the SIP Account 1. When the softphone appears, click the Go to Account Settings link. The SIP Account window appears. 2. In the Account tab, complete the User Details area with the information obtained from your VoIP service provider. 3. Complete the remaining tabs as specified by your service provider or to suit your setup.
X-Lite for Windows User Guide 2.4 Troubleshooting X-Lite includes these tools for helping you troubleshoot problems: • • You can verify that your microphone, speakers and camera are working and can set the volume to a comfortable level without having to actually place a phone call. While you are on a phone call, you can test the quality of the audio See page 1.
CounterPath Corporation 6
1 Making Phone Calls 1.1 Starting and Quitting X-Lite If X-Lite is not already running, start it as you would any other program: Use the Windows Start menu or double-click the desktop icon. X-Lite appears. To quit X-Lite, choose Softphone > Exit or press Ctrl-Q. 1.2 The Onscreen Softphone Show/hide resources such as contacts, favorites Change layout of contact list Close to system tray. This icon does not shut down X-Lite Minimize to system tray X-Lite menu. See below.
CounterPath Corporation The X-Lite Menu Softphone. • • • Accounts. Preferences. These settings control the way that you work with X-Lite and apply to all accounts. See “Configuring Preferences” on page 10. Exit. To shut down X-Lite. You can also exit by pressing Ctrl-Q. View. Changes how X-Lite looks. Contacts. Lets you work with contacts. Help. Provides access to various service-related features.
X-Lite for Windows User Guide 1.3 Placing a Call Place the call as described in the table below. The outgoing call opens in its own call panel, below any other existing call panels. You will hear a ringing tone while X-Lite attempts to make a connection. Option Keying From the... Dialpad or computer keyboard Description 1. Enter the phone number in the call entry field using the dialpad or the computer keyboard. If entering a softphone address, you can enter the entire address (6045551212@domainA.
CounterPath Corporation Make sure you are on the Phone tab to place a call. Call entry field The Call icon. Clicking the down arrow gives you more call options, such as video call or conference call. Auto complete suggestions. X-Lite makes a call as soon as you choose the suggestion. You can change this behavior so X-Lite does not dial until the call button is pressed (page 10). For information on working with the call, see “Handling an Established Call” on page 7.
X-Lite for Windows User Guide Placing another Call You can place another call. The first call will be put on hold. Place the call in the usual way Existing call is automatically put on hold New outgoing call Switch between the different calls by clicking Resume on the desired call panel. That call becomes the active call and all other calls are put on hold.
CounterPath Corporation 1.4 Handling Incoming Calls X-Lite must be running to answer incoming calls. It can be running in the system tray.(If X-Lite is not running, incoming calls may be directed to voicemail; check with your VoIP service provider.) The new call appears in its own call panel. In addition, the Call Alert box appears. For information on setting call alert preferences, see page 11. Click. If you are on another call, that first call is automatically put on hold.
X-Lite for Windows User Guide 1.5 Handling an Established Call Use speakerphone (when yellow) or headset (when gray) Mute speaker or adjust speaker volume by using slider Conference Calls See page 10 Instant Message See page 15 Mute your voice Hold and resume Start sending video See page 8 Add as Contact Add the current caller as a contact. See “Adding a Contact Using an Existing Address” on page 3. Place another call The current call is automatically put on hold.
CounterPath Corporation 1.6 Handling Video Calls Placing a Video Call Calls made with X-Lite will work without a video camera, but a video camera is necessary to allow other parties to see your image. X-Lite will work with most USB video cameras. From the Dashboard Click the down arrow and choose Video call From the Contact List or History Right-click the contact and Choose Video Call Adding Video If you have a camera, you can add video to a call that started as an audio call.
X-Lite for Windows User Guide Pausing and Resuming Video Click Stop Video in the call panel or close the video window to pause sending your video. Click Start Video to resume sending your video; the video window will open. To display in full screen, hover over the video window and click the two-way arrow icon, or press F11 when the focus is on the video window.
CounterPath Corporation 1.
X-Lite for Windows User Guide Managing the Three-way Call Participant menu Adding another Participant If your conference currently has only one participant, you can add the other participant in any of these ways: • • • Right-click on a contact or history item and choose Add to Conference Call. In the conference call panel, enter a name in the call entry field and click Add.
CounterPath Corporation Video Conference Calls Calls made with X-Lite will work without a video camera, but a video camera is necessary to allow other parties to see your image. X-Lite will work with most USB video cameras. This person has video. This person does not have video. To remedy this situation, stop video and start it again. Video will be sent to all the current participants. Closing the video window stops sending video. Mute.
X-Lite for Windows User Guide 1.8 Voicemail If your service includes voicemail and you have set up voicemail options (page 3), you can click the icon to automatically connect to voicemail and listen to any messages.
CounterPath Corporation 14
X-Lite for Windows User Guide 2 Other X-Lite Features 2.1 Instant Messaging Sending an IM 1. You can send an IM to a contact who has a softphone address. From the Contacts tab Right-click on the contact and choose Send Instant Message. The contact must have a softphone address. Or click on the IM icon that appears to the right of the contact name. An active phone call If the person is a contact, choose Send Instant Message from the call panel menu.
CounterPath Corporation Receiving an IM When an IM is received, either the IM window or a Call Alert pops up. (To control which window appears, choose Softphone > Preferences > Alerts & Sounds.
X-Lite for Windows User Guide 2.2 Viewing Messages To view your recent IM activity for any contact, perform one of these actions: • Click the Messages window icon : • • Click Shift + Ctrl +M. On the menu, click View > Messages.. Search all messages You can copy the messages. Right-click to save or delete a conversation.
CounterPath Corporation 18
1 The Contacts Tab The Contacts tab displays your contacts. Each contact is shown with presence information and icons for singleclick phoning and IMing. If the Contacts tab is not showing, go to the main menu and choose View > Show Contacts. Search entire contact list Move the list back to main window Add a Contact Contacts are typically organized into groups. X-Lite includes built-in groups. You can add more groups, as desired. The online status of others.
CounterPath Corporation 1.1 Managing Contacts and Groups Adding a Contact Click , or right-click a group and choose Add Contact to Group. The Contact Profile dialog appears. To enter a phone number, select the type, enter the number, and click Add The new number appears in the list Field Description Contact Summary Display as If several display names are available, choose the one that you want to show in the contact list. Group Click to show the list of groups.
X-Lite for Windows User Guide Example This example shows how to add a contact when your VoIP service supports online availability via your SIP account. Enter the person’s phone number in any phone field As soon as you add a Softphone entry, this field automatically appears. X-Lite will share online presence information with this person using this phone number.
CounterPath Corporation Modifying the Contact List Changing Contact Information To change the information for a contact, right-click the contact and choose Edit Profile. The Contact Profile dialog appears (page 2). Moving or Deleting a Contact • • To drag one or more contacts to a different group, select them and drag to the title bar of the new group. To delete one or more contacts, select them, right-click, and choose Delete Contact or Delete Selected. The contacts are removed from this group.
X-Lite for Windows User Guide 1.2 Using Contacts Hover to reveal icons. Click the phone icon to call using the primary phone number. Or click the IM icon to send an IM using the primary presence address for this contact. Or right-click and choose from the menu Double-click to phone or IM (depending on how doubleclicking is configured in Preferences > Application).
CounterPath Corporation 1.3 Sharing Online Status You can publish your online status to contacts who have softphone address, and you can set up X-Lite to view the online status of other contacts. Typical online statuses are available, on the phone, busy, and so on.
X-Lite for Windows User Guide Sharing Online Status Watching Others’ Status If a contact has a SIP address in the Softphone field, X-Lite will automatically obtain status information for this address. When you choose to share presence information, X-Lite sends the contact a notification request. The request asks that you be able to see that person’s status. If the person allows this request, then the icon beside their name (in your Contacts) becomes color coded to specify their status.
CounterPath Corporation Setting your Online Status Changing your Status Click the down arrow beside the online status indicator on X-Lite, and select the desired online status. Setting up Status Indicators You can create a custom status indicator: click the down arrow beside the status indicator, and double-click on one of the existing indicators; type your custom status. Status Indicators Indicator Available Meaning for your Status Either: Meaning for Others’ Status You can contact this person.
X-Lite for Windows User Guide 2 Using Other Resources 2.1 History Tab Detach the history list Filter list Green: Outgoing call, either attempted or established Blue: Incoming call that was answered Red: Incoming missed call Managing the Lists of Calls You can right-click on an entry in a list to: • • • • Delete the entry. Delete all entries in the list. Edit the profile if the entry is a contact. Add as contact. The Contact Profile appears (page 2).
CounterPath Corporation 2.2 Favorites Tab To view the Favorites tab, go to the main menu and choose View > Show Favorites. You can create favorites from your contact list. They will be displayed in both the Contacts tab and in the Favorites tab. Select the desired contacts, then right-click and choose Add to Favorites. You can perform nearly all the same actions on the contact in the Favorites tab as you can in the Contacts tab.
1 Configuring X-Lite 1.1 Configuring Accounts To create a SIP account, choose Softphone > Account Settings from the menu. SIP Account Properties – Account Fields with a red asterisk are required Table 1: SIP Account Properties – Account Field Account name Protocol Use for Call Use for IM/Presence Description If desired, change the account name to something that is meaningful to you. For example, the name of the VoIP service provider. Read-only. Always specifies SIP.
CounterPath Corporation Table 1: SIP Account Properties – Account Field Description User Details User ID Domain Password Display name Typically the account number for the softphone account. For example, 6045551212 or 2766. Provided by your VoIP service provider. For example, domainA.com. Provided by your VoIP service provider. Provided by your VoIP service provider. This name is displayed in the X-Lite title bar. Authorization name Other people will see you as this name. May not be required.
X-Lite for Windows User Guide SIP Account Properties – Voicemail These settings let you set up to interact with your VoIP service provider’s voicemail service. Your service provider may provide the ability to set up for voicemail outside of X-Lite, for example, by phoning a softphone address and following the voice prompts, or by accessing a website. Check with your service provider to determine if another setup mechanism is available.
CounterPath Corporation Table 2: SIP Account Properties – Voicemail Field Send calls to voicemail if unanswered Description Complete only if your VoIP service includes voicemail. To send to voicemail after the specified number of seconds. Your service provider may also provide a similar feature that is set up outside of X-Lite. If so, make sure you do not enter competing information in X-Lite and in the service provider’s user interface.
X-Lite for Windows User Guide SIP Account Properties – Topology Table 3: SIP Account Properties – Topology Field Firewall traversal mode Description Choose the setting recommended by your VoIP service provider: • Auto detect using ICE: Automatically determine the contact address for signaling traffic. Advertise the local IP, public IP (discovered via STUN, if available) and media relay IP and use these to automatically determine the best route for media traffic during calls.
CounterPath Corporation SIP Account Properties – Presence Presence allows other softphone users to see your online status and allows you to see the online status of others. This tab lets you configure how online status is handled for contacts who have a softphone number on your SIP account. Table 4: SIP Account Properties – Presence Field Description Presence Mode Choose the setting specified by your VoIP service provider: • Disabled: Presence is not supported. • Peer-to-peer.
X-Lite for Windows User Guide SIP Account Properties – Transport Table 5: SIP Account Properties – Transport Field Signaling Transport Description Contact your VoIP service provider to identify the types of transport that are supported. Then choose a supported transport: • Automatic: X-Lite sets up the transport based on the capabilities of the network and the X-Lite computer. Choose this option if you do not care which transport is used. • TCP: This transport provides no signaling security.
CounterPath Corporation SIP Account Properties – Advanced Table 6: SIP Account Properties – Advanced Field Description Register Settings Reregister every Minimum time Maximum time The time interval between X-Lite’s attempts to reregister in order to refresh the account registration with the VoIP service provider for this account. A value of zero means not to reregister after the initial registration. This value is placed in the “Expires” header field of the REGISTER message.
X-Lite for Windows User Guide Table 6: SIP Account Properties – Advanced Field Description Timers Enable session timers Default session time Session timer preference A session timer is a mechanism to detect whether a call session is still active from the signaling point of view. When the timer expires, a refresh is sent from one party to the other. The timer is then reset. • Turn on to enable session timer. Enter a value in Default session time.
CounterPath Corporation 1.2 Configuring Preferences Choose Softphone > Preferences. The Preferences window appears. The Preferences panels let you control the way that you work with X-Lite. Preferences – Application This panel lets you set your preferences for general GUI behavior. Default Actions This feature lets you control the action performed for the green Call button at the top of the phone. For example, you can configure the button so that it makes a video call instead of an audio call.
X-Lite for Windows User Guide Preferences – Alerts & Sounds The tabs on this panel let you control the Call Alerts box and lets you assign sounds. Alerts You can control whether the Call Alert box is displayed in different situations. You can also control how you are alerted to an incoming IM: either with a small IM Alert box or with the Messages window itself. Sounds You can assign specific sounds to a variety of actions or “events”. 1.
CounterPath Corporation Preferences – Devices X-Lite automatically detects devices at each startup, and selects the most appropriate device for each purpose. If you do not like this selection, you can override it on this panel. If you override a selection, it will apply the next time you start X-Lite, unless the device is no longer available, in which case X-Lite will again select the device to use. Table 7: Preferences – Devices Field Description Zero-touch device configuration Typically, leave on.
X-Lite for Windows User Guide Table 7: Preferences – Devices Field Reduce echos Description Turning this feature on improves sound quality. This feature is typically on. Other Device Ring On Change this field only if you want to override the devices that X-Lite automatically selected. The device where you want to hear the phone ringing: the headset, the speakerphone, or none. Camera This field appears only on versions of X-Lite that include video functionality.
CounterPath Corporation Preferences – Audio Codecs This panel shows all the codecs that are included in the retail version of X-Lite. You can enable or disable codecs as desired. With only one codec enabled, all calls made will use that codec. With more than one codec enabled, X-Lite negotiates a common codec with the other party. You cannot change the properties of any codecs. About Codecs Audio codecs describe the format by which audio streams are compressed for transmission over networks.
X-Lite for Windows User Guide Preferences – Video Codecs Video codecs describe the format by which video streams are compressed for transmission over networks. Some codecs require less bandwidth than others, but may result in lower video quality. You can enable or disable codecs as desired. You may decide to disable a codec even though your VoIP service provider supports it. With only one codec enabled, all calls made will use that particular compression format.
CounterPath Corporation Preferences – Calls Table 8: Preferences – Calls Field DTMF Description You may need to change the DTMF configuration if you cannot interact with interactive voice response systems (auto attendants, voice-activated menus, and so on). Contact your VoIP service provider for the correct setting.
A Troubleshooting Choose Help > Troubleshooting to display the Troubleshooting window. Testing Audio Devices You can verify that your microphone and speakers are working and can set the volume to a comfortable level without having to actually place a phone call.
CounterPath Corporation Testing Audio Quality While you are on a phone call, you can test the quality of the audio. Note that to perform a valid test, you should be on an established call (not a call attempt).
X-Lite for Windows User Guide B Application Hot Keys Function Keyboard Shortcut Answer an incoming call Ctrl + N Decline an incoming call Ctrl + D Display the Messages window Shift + Ctrl + M Redial the last dialed number Ctrl + R or Ctrl + R then Enter End the call Ctrl + E End the conference call (hang up on all participants) Mute your voice during a call Ctrl + M Hold or resume the call when the focus is on Ctrl + H this call panel Turn volume up when the focus is on this call Up key panel
CounterPath Corporation C Dial Plan When a call attempt is made, the call input (what you type, select or drag onto the call entry field) can be modified to ensure that the call gets placed successfully. This ability to modify the input relies on the existence of a “dial plan” for the account. C.1 Dial Plan Syntax The dial plan has the following syntax: pattern[|pattern];match=1;=;[match=2; =;] Where: • • • Items in [ ] are optional.
X-Lite for Windows User Guide The following table describes the most common elements. All regular expression elements are supported. Element | Origin Regular expression rules Description Pipe character, used to separate patterns. 0 1 2 3 4 5 6 7 8 9 Literals Literal digits, used as is. # * a to z Literal characters, used as is. Special cases: Literals • The literal x character is represented by \x. • The literal t character is represented by \t.
CounterPath Corporation C.2 How the Input Is Processed Comparing Input to the Dial Plan Patterns The input is compared to the dial plan. Keep in mind that the input being compared is different depending on whether the input is dragged/selected or typed: • • If the input is dragged or selected, then the entire input is compared to the dial plan. If you are typing the input, then the digits are compared one by one as they are entered. Each time a new digit is entered, the comparison starts over.
X-Lite for Windows User Guide [2-9]xxxxxxxxx The third pattern is any ten-digit number beginning with a number other than 1. The assumption is that this is a local PSTN call within a ten-digit dialing zone. +x.T; The fourth pattern is a number of any length that begins with +, to indicate an international PSTN call from North America. Delete the +, prefix with 9011 (011 is the number to access an international line from North America).
CounterPath Corporation D Exporting Contacts You can export your contacts to a CSV, vCard or PST file. Exporting contacts to a file is particularly useful when you upgrade to X-Lite for Windows or X-Lite for Mac, because you can then import this file into your new softphone and instantly populate the new contact list. 1. From the main menu choose Contacts > Export Contacts. The Export Contacts wizard starts. 2. When you click Next, the export starts. The result is: • • 8 For a PST export, the existing .
X-Lite for Windows User Guide E Other Ways to Run X-Lite E.1 From a Hyperlink You can attach a hyperlink to a phone number or softphone address that, when clicked, starts X-Lite and dials the number. Attach a hyperlink with this format: dial address_or_number For example: dial kperera@domainA.com X-Lite supports three protocols: sip, tel, and callto.
CounterPath Corporation E.2 From the Command Line You can start X-Lite from a DOS prompt. You may need to add the install directory (typically C:\Program Files (x86)\CounterPath\X-Lite) to the PATH. Then type: xlite.exe You can also run these action commands: >xlite.exe -action== where action and input are: call?to the remote URI im?to the remote URI add?contact the contact URI quit For example: C:\>xlite.exe -action=call?to=1331 or C:\>xlite.exe -action=call?to=1331@zippy-phone.
X-Lite for Windows User Guide F Glossary Broadband Codec Dial plan DTMF Firewall HID IM MWI Narrowband Presence PSTN SIP account Softphone address USB device VoIP VoIP service provider Broad or wide bandwidth. In data transmission, the wider the band, the more data it is possible to transmit in a given time span. A cable, DSL and ADSL connection to the network provide broadband for data transmission. A dialup or ISDN connection typically provide a narrow bandwidth for data transmission.
CounterPath Corporation 12
