eyeBeam 1.
CounterPath eyeBeam 1.5 CounterPath Solutions, Inc. Floor 8, 100 West Pender St. Vancouver, BC Canada V6B 1R8 Tel: 1.604.878.0440 sales@counterpath.com www.counterpath.com © April, 2006 This document contains information proprietary to Counterpath Solutions, Inc., and shall not be used for engineering, design, procurement, or manufacture, in whole or in part, without the consent of CounterPath Solutions, Inc. CounterPath, eyeBeam, and the logo are trademarks of CounterPath Solutions Inc.
CounterPath eyeBeam 1.5 Contents Introduction ............................................................................................................................... 1 What is eyeBeam? .............................................................................................................. 1 Installation and Setup ................................................................................................................ 2 Getting Ready .....................................................
CounterPath eyeBeam 1.5 1 Introduction 1.1 What is eyeBeam? CounterPath’s next generation telephony client, eyeBeam 1.5 lets you integrate your telephony experience with your desktop and mobile computer solutions. With the click of a button or the tap on the keyboard you can dial, answer, or choose how you want to personally manage your calls and availability.
CounterPath eyeBeam 1.5 2 Installation and Setup 2.
CounterPath eyeBeam 1.
CounterPath eyeBeam 1.5 2.3 Configuring eyeBeam 1. Start eyeBeam as you would any other program: Use the Windows Start menu or double-click the desktop icon. The softphone appears. 2. When starting eyeBeam for the first time, you will be prompted for the license key. Type in the license key or copy and paste it. 3. The Call display shows Initializing, followed by Discovering network. If no accounts have been set up, the final message is Awaiting proxy login information. You must set up accounts.
CounterPath eyeBeam 1.5 2.4 Setting up for Voicemail Your VoIP service provider may offer voicemail. If it does, then you can set up some voicemail features in eyeBeam. See “Account Properties – Voicemail” on page 46. In particularly: • If you want to be able to connect to voicemail by clicking on the Call display, you must complete the Number to dial for checking voicemail field.
CounterPath eyeBeam 1.5 3 Using the Softphone 3.
CounterPath eyeBeam 1.5 Display The following information and icons may appear on the Call display: When the phone is ringing with an incoming call, click here to ignore. A message appears to the caller advising that the call could not be made. The phone stops ringing. When the phone is ringing with an incoming call, click here to send the call immediately to voicemail. Information on voicemail is provided by your VoIP service provider; it is not part of eyeBeam.
CounterPath eyeBeam 1.5 3.2 Starting eyeBeam 1. Start eyeBeam as you would any other program: Use the Windows Start menu or double-click the desktop icon. The softphone appears. 2. If you are prompted for a license key, then you have not yet set up eyeBeam. See “Configuring eyeBeam” on page 4. 3. Take the appropriate action: • If one or more accounts have been set up, and at least one account is enabled, the next message is Registering. eyeBeam attempts to log into every enabled account.
CounterPath eyeBeam 1.5 3.3 Placing a Call You can contact someone using: • The SIP address (kpereira@domain.com) • A traditonal phone number, if supported by your VoIP service provider How Keying Description 1. Enter the SIP address or number in the Call display using the softphone keypad or the computer keyboard. • For the name, you can enter the entire name (kpereira@domain.com) or just the name (kpereira).
CounterPath eyeBeam 1.5 3.4 Answering a Call eyeBeam must be running to answer incoming calls. (If eyeBeam is not running, incoming calls may be directed to voicemail, but check with your VoIP service provider to be sure.) The softphone rings and the line of the incoming call is lit. If you have Call Alerts on, the Call Alert box appears. If you have the Bring to front feature on, the phone comes to the front of the screen. For information on alerts and Bring to front, see page 33.
CounterPath eyeBeam 1.5 3.5 Handling a Call While the Call Is in Progress Video If your version of eyeBeam includes video, click Start on the Video drawer to send video to the other party. You will see the other party in the top video panel if they have enabled video at their end. Adjusting Volume and Muting Use the microphone slider (on the left) to adjust the volume of your voice for your listeners. Use the speaker adjustment (on the right) to adjust the sound you are hearing.
CounterPath eyeBeam 1.5 4. Select the original line (the line that is red). The transfer is made and the lines on your softphone are now free (black). Placing a Call on Hold Click Hold or click the line or click another line. To resume a call that is on hold, click the line. AA – Auto Answer Click AA on the dialpad to automatically answer calls as they come in. Flash The Flash button on eyeBeam works the same way as Flash or Link works on a traditional telephone. Click Flash on the dialpad.
CounterPath eyeBeam 1.5 3.6 Conference Calls There are three ways to set up a conference call: • “Manual Setup: AA Off and AC Off”, below • “AA Off and AC On” on page 14 • “Conference Server Mode: AA on and AC On” on page 14 Manual Setup: AA Off and AC Off You can host a conference by calling the other parties involved, or by allowing them to arrange the call themselves. Starting a Conference Call To host a conference between several callers: 1.
CounterPath eyeBeam 1.5 AA Off and AC On “You answer calls manually and eyeBeam adds each to the conference automatically” 1. Click AC on. 2. Manually answer the first call. There is no need to put the call on hold. 3. When the next call comes in, on another line, answer the call. As soon as you answer the call, a conference will be set up between the three parties. • The conference is established even if you had another line on hold.
CounterPath eyeBeam 1.5 Call Information To view information such as the current codecs, hover over the line button (for example, line 1) that the call is being made on. Information appears in the tool tip. Add to the Contacts List At any time during a call, you can click on the Call display to add the other party to the Contacts list. For information on contacts lists, see page 16.
CounterPath eyeBeam 1.5 4 Managing Calls and Contacts 4.1 Calls & Contacts Drawer To display the eyeBeam Calls & Contacts drawer, click the black button toward the extreme right edge of the softphone application. You can open (display) and close (hide) this drawer at any time. Your availability. See page 23 Contacts. See page 17 Calls: received, dialed and blocked calls. See page 21.
CounterPath eyeBeam 1.5 4.2 Contacts Tab Your availability. See page 23. The Contacts menu The search field The availability of others. See page 23. The Contacts tab displays your contacts and lets you specify multiple contact methods for them, including: • • • • SIP address (softphone) Home phone number Cellphone number E-mail. You can identify one of these contacts as the primary contact method. You can phone any contact.
CounterPath eyeBeam 1.5 Using Contacts Call a contact E-mail a contact who has an e-mail address To use the person’s primary number, double-click or drag the contact to the Call display. To choose the number to use, right-click and choose Call, then click the desired number. Right-click and choose Send E-mail. Send an IM to a contact who has a SIP address Right-click and choose Instant Message.
CounterPath eyeBeam 1.5 Contact Properties Dialog Box 1. Enter the desired information on the two tabs. 2. When you click OK, the contact is added to the specified group or groups, with the specified primary contact method displayed in the list. Table 1: Contact Properties Dialog Box Field Name Display as Group(s) Contact Methods Show this contact’s Availability Description Complete as desired. Required.
CounterPath eyeBeam 1.5 Importing Contacts You can import a contacts list from: • A comma-separated file. Use this method to import from a Microsoft® Excel ® file. You will first have to set up the file; see below. • A Microsoft® Outlook® or Microsoft® Exchange contacts list (a *.pst file). • A vCard file (*.vcf file).
CounterPath eyeBeam 1.5 4.3 Calls Tab There are three lists that show calls you have made and received: • • • • Missed Calls: incoming calls that you missed. Received Calls: incoming calls, both answered and missed. Dialed Calls: outgoing calls, both answered, unanswered and hung up.
CounterPath eyeBeam 1.
CounterPath eyeBeam 1.5 4.4 Availability Availability refers to the ability to see whether a person is available or not: online, on phone, busy, and so on. Availability information is displayed in the Calls & Contacts drawer. You can publish your availability to contacts who have SIP addresses, and you can set up eyeBeam to view the availability of other contacts.
CounterPath eyeBeam 1.5 Respond to the request: Button Allow Allow and add Next Action Result The other person will be able to see your availability. The other person will be added to your privacy rules with “Show my Status” set to Yes. This button appears only if the other person is The other person will be able to see your availability. The other person will be added to your Contacts list. The other not already on your contact list.
CounterPath eyeBeam 1.5 The following chart illustrates how the sharing of availability occurs.
CounterPath eyeBeam 1.5 Setting your Availability Changing your Availability Click the down arrow beside the status indicator, and select the desired availability. See Table 2, below.
CounterPath eyeBeam 1.5 4.5 Privacy Rules You can allow or ban another person from contacting you. There are separate rules for incoming phone calls, incoming instant messages, and availability detection. You can ban or allow an individual person, or an entire domain. You can also ban a person in the Received, Dialed or Blocked list. Right-click on the name and choose Ban this Person. Privacy Rules Window Click at the top of the phone and choose Privacy Rules. The Privacy Rules window appears.
CounterPath eyeBeam 1.5 Changing Settings To change the settings for an existing name, click in the cell you want to change; the value changes, for example from No to Yes. Deleting an Entry Click on the entry and click Delete. The entry is immediately deleted.
CounterPath eyeBeam 1.5 5 Instant Messaging (IM) Sending and Receiving an IM To display the IM window, right-click any entry in the Calls & Contacts drawer and select Instant Message. 1. Type the message. Include emoticons and formatting, as desired. 2. Press Send. You can press Ctrl-F to search for text in the large message area.
CounterPath eyeBeam 1.5 6 The eyeBeam Menu Access the eyeBeam menu by clicking at the top of the phone. The menu items are: • Options. Options control the way that you work with eyeBeam and apply to all accounts. See “Options – General – Application” on page 31. • SIP Account Settings. These settings control how eyeBeam interacts with your VoIP service provider, and are set individually for each account. See page 43. • Privacy Rules. See page 56. • Open Diagnostic Log.
CounterPath eyeBeam 1.5 6.1 Options Options are settings and preferences that apply to all accounts. Options – General – Application Table 3: Options – General – Application Field Always on top of other applications Launch when Windows starts Prompt when shutdown Turn letters into digits when typing into the phone Description Click on or off, to suit your preference. Click on or off, to suit your preference. Click on or off, to suit your preference. Click on or off, to suit your preference.
CounterPath eyeBeam 1.5 Table 3: Options – General – Application Field Enable status bar messages Folder for recording Description When clicked on, messages relating to zero touch configuration will appear in a notification balloon at the lower right corner of the screen, whenever the configuration automatically changes. (Notification balloons are supported in newer versions of Windows.) Specify a location for saving files when you record your conversations.
CounterPath eyeBeam 1.5 Options – General – Alerts and Sounds On this page you can: • Work with ringtones. You can import a ringtone (a .WAV file). You can play to try it out. You can activate one ringtone. You can delete a ringtone. • Set up eyeBeam to bring the softphone to the front automatically when a call comes in. • Set up eyeBeam to display the Call Alert box (see right) when a call comes in either always, or only when the softphone is not visible.
CounterPath eyeBeam 1.5 Options – General – Status This screen lets you add status indicators to the standard Availability indicators built into eyeBeam. For more information on availability, see page 23. • You can set the Idle timer. This is the time since you last moved or clicked the mouse or pressed a keyboard key, after which eyeBeam will automatically change your Availability to Idle. • You can add a custom indicator, click New, type in the status description, and assign an icon.
CounterPath eyeBeam 1.5 Options – General – Device T Table 4: Options – General – Device Field Description Headset Speaker device Microphone device Change these fields only if you want to override the device selected by zerotouch device configuration (see page 31). In both these fields, select the headset you are using. The headset is the device that is usually used for audio out (the sound you hear) and audio in (recording your voice).
CounterPath eyeBeam 1.5 Table 4: Options – General – Device Field Description Speakerphone Speaker device Change this field only if you want to override the device selected by zero-touch device configuration (see page 31). Make the appropriate choice: Microphone device • Select the device that you want to use for audio out (the sound you hear) when the Speaker Phone button is pressed. Make sure you select a speaker device (not the headset). • Select None if you do not have a speaker phone.
CounterPath eyeBeam 1.5 Options – Advanced – Audio Codecs This pane shows all the codecs that are included in the retail version of eyeBeam. 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, eyeBeam automatically chooses the best codec based on the other party’s capability, the available bandwidth, and network conditions. You cannot change the properties of any codecs.
CounterPath eyeBeam 1.5 Table 5: Audio Codecs Supported in eyeBeam Codec Narrowband Wideband Royalty-bearing Included in Retail eyeBeam AMR Wideband (G.722.2) 3 3 Broadvoice-32 3 3 Broadvoice-32 FEC 3 3 DVI4 3 3 DVI4 Wideband 3 3 G.711aLaw * 3 3 G.711uLaw * 3 3 G.722 3 G.723 3 3 G.726 3 3 G.
CounterPath eyeBeam 1.5 Options – Advanced – Video Codecs This pane appears only on versions of eyeBeam that include video functionality. 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 service provider supports it.
CounterPath eyeBeam 1.5 Options – Advanced – Network Table 6: Options – Advanced – Network Field Network connection speed Preserve bandwidth Description Complete this field only if you have disabled zero-touch bandwidth detection (see page 31). Select the type of network connection for your computer. When this feature is on, eyeBeam stops sending audio when you are not talking. When this feature is off, eyeBeam always sends audio, which uses more bandwidth but may result in better call quality.
CounterPath eyeBeam 1.5 Options – Advanced – Quality of Service . These fields appear only on versions of eyeBeam that include video. The Quality of Service pane lets you request a specific transport service for audio, video and signaling traffic. There are two types of services. The service to use depends on what your VoIP service provider supports: • GQoS, which is available for audio and video. • DSCP (also known as ToS), which is available for audio, video and signaling.
CounterPath eyeBeam 1.5 Options – Advanced – Diagnostics This screen lets you enable logging to files. Logging uses computer resources, so you should only enable it when instructed by a customer support representative. To set up logging: 1. Click Enable logging. 2. Set the logging level. 3. Specify the folder where logs will be saved. 4. Click Apply. Activity on eyeBeam will be logged to .csv files in the specified folder. A new set of files is started each time you log on.
CounterPath eyeBeam 1.5 6.2 SIP Account Settings SIP Accounts To work with accounts, click at the top of the phone and choose SIP Account Settings. The SIP Account window appears, showing all the accounts set up. Each account is automatically assigned a number: the first account in the list is 0, the second account is 1, and so on. These numbers do not imply any ranking. You can: • • • • • • Resize the columns in this window. Add an account. Remove an account. Enable one or more accounts.
CounterPath eyeBeam 1.5 Account Properties – Account Table 8: Account Properties – Account Field Description User Details Display name User name Password Authorization user name Domain This name is displayed in the eyeBeam display. Other parties will see this name they are when connnected to you. Typically the account number for the SIP account. For example, in kpereira@domain.com, the user name is “kpereira”. Provided by your VoIP service provider. Provided by the service provider.
CounterPath eyeBeam 1.5 Table 8: Account Properties – Account Field Description Send outbound via Choose the setting specified by your VoIP service provider: Dialing Plan • Domain: If your VoIP service provider requires that traffic be directed to proxies that are discovered via the domain. • Proxy: If your VoIP service provider has an outbound proxy address and requires that you provide the address to eyeBeam. For the address enter a domain name (for example, domain.
CounterPath eyeBeam 1.5 Account Properties – Voicemail These settings let you set up eyeBeam to forward calls in several situations. Your service provider may also provide the ability to set up for voicemail outside of eyeBeam, for example, by phoning a SIP 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 eyeBeam 1.5 Table 9: Account Properties – Voicemail Field Number for sending calls to voicemail Description Complete only if your VoIP service includes voicemail. This is the number that incoming calls will be forwarded to if they are unanswered after the specified interval (below), or when you click the icon on the Call display. If you leave this field empty, then this icon will not be displayed. However, leaving this field does not mean that voicemail does not work.
CounterPath eyeBeam 1.
CounterPath eyeBeam 1.5 Table 10: Account Properties – Topology Field Description Firewall Traversal IP Address This setting controls how your IP address is presented. • Discover global address: Let eyeBeam determine your public IP address. This is the recommended setting unless your VoIP service provider advises otherwise. • Use local IP address: use the IP address of the eyeBeam computer. STUN Discovery The recommended setting is Discover global address.
CounterPath eyeBeam 1.5 Account Properties – Presence This tab appears only for the default account. However, the values set on that tab apply to all accounts. In other words, presence as set up on this tab applies to all accounts, not just the default account. If you change the default account, this Presence tab will be visible for the new default account and will not be visible for the previous default account. The values will already be on the new tab: you will not have to set them up again.
CounterPath eyeBeam 1.5 Account Properties – Storage This tab appears only for the default account. However, the values set on that tab apply to all accounts. In other words, storage as set up on this tab applies to all accounts, not just the default account. If you change the default account, this Storage tab will be visible for the new default account and will not be visible for the previous default account. The values will already be on the new tab: you will not have to set them up again.
CounterPath eyeBeam 1.5 Account Properties – Security Table 13: Account Properties – Security Field Signaling Transport Media Encryption Description Contact your VoIP service provider to identify the types of transport that are supported. Then choose a supported transport: • Automatic: eyeBeam sets up the transport based on the capabilities of the network and the eyeBeam computer. Choose this option if you do not care which transport is used. • Encrypted: Currently, this option means TLS will be used.
CounterPath eyeBeam 1.5 Setting up the root certificate on your computer ensures that the connection to the proxy is TLS secure (the first hop). Any proxy in the chain (between you and the caller) that does not support TLS may cause an insecure link in the chain. Therefore, if the other party is outside your domain, you cannot be completely sure that the call is secured at the signaling level, which means that you cannot be sure that it is secured at the media level.
CounterPath eyeBeam 1.5 Table 15: Account Properties – Advanced Field Send SIP keep-alives Use rport Enable session timers Session timer preference Description Typically on, to instruct eyeBeam to send SIP keep-alive messages in order to maintain a “pinhole” through your firewall for SIP messaging. Typically on. 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.
CounterPath eyeBeam 1.5 6.3 Privacy Rules For information on privacy rules, see page 27. 6.4 Open Diagnostic Log and Folder For information on these menu items, see “Options – Advanced – Diagnostics” on page 42.
CounterPath eyeBeam 1.
CounterPath eyeBeam 1.5 Appendix B: Dialing Plan When a call attempt is made, the call input (what you type, select or drag onto the Call display) is processed to select the account to use and to modify the input if that is required to ensure that the call gets placed successfully. This ability to select an account and modify the input relies on the existence of a “dialing plan” for each account.
CounterPath eyeBeam 1.5 Pattern Valid Content The content for a pattern follows the digit map rules of RFC 2705, supplemented by the rules for regular expressions. Where there is an overlap between the digit map and regular expression rules, the digit map rules apply. For this reason, there are some special cases, included in the table below. The following table describes the most common elements. As mentioned, all regular expression elements are supported.
CounterPath eyeBeam 1.5 Transformation Keywords Keyword prestrip poststrip pre post replace Description Strip the first n characters from the input before placing the call. Remove n number of characters from the end of the input before placing the call. Add the specified prefix to the input before placing the call. Attach the specified postfix to the input before placing the call. Replaces the input with the specified string before placing the call.
CounterPath eyeBeam 1.5 Results of the Comparison Table 17: Type of Match Partial match Pending match Complete match No match Conditions Result The characters typed so far follow the pattern but • If you press Enter or Dial, then the default account. No there are not yet enough characters for a pending transformation is performed. or complete match. • If you stop typing for the long timer length (20 seconds), then the default account is selected.
CounterPath eyeBeam 1.5 Example 3 #1xxxxxxxT|#19xxxxxxx|xxxxxxxT|9xxxxxxx|;match=1;prestrip=2;pre=9;match=2; prestrip=2;match=3;pre=9; Table 18: #1xxxxxxxT #19xxxxxxx xxxxxxxT 9xxxxxxx The pattern is a dialing prefix followed by seven digits. The timer forces eyeBeam to wait to allow a match to the second pattern. The #1 is stripped off and 9 is prepended to access an outside line. The pattern is a dialing prefix followed by a 9 and seven digits. The #1 is stripped off. The pattern is seven digits.
CounterPath eyeBeam 1.5 Appendix C: Contact List Headings Following is a list of all the headings that are used in the eyeBeam contacts list. This list can be useful when formatting a contacts list in order to import it into eyeBeam.
CounterPath eyeBeam 1.5 Appendix D: Location of Files System files are copied to the install directory you specified when installing. The default install directory is: C:\Program Files\CounterPath\eyeBeam 1.5\ The directory contains: • • • • • • • • • the executable (eyeBeam.exe) emoticons\*.* eyeCall.dll, used to make calls from Microsoft Outlook. other dll files, including dll files for supported codecs. unins000.dat, which contains information about uninstalls of eyeBeam. *.ico *.cat *.inf *.
CounterPath eyeBeam 1.5 Appendix E: Alternative Ways of Running eyeBeam E.1 From a Hyperlink You can attach a hyperlink to a phone number or SIP address that, when clicked, starts eyeBeam and dials the number. Attach a hyperlink with this format: dial For example: dial kpereira@domain.com E.2 From the Command Line You can start eyeBeam from a DOS prompt. You may need to add eyeBeam.exe to the PATH.
CounterPath eyeBeam 1.5 Appendix F: Glossary AEC AGC AVI Broadband Codec Default account Dialing plan DTMF IM IP IP address Media MWI Narrowband Presence Proxy PSTN Acoustic echo cancelation. Processing of the audio or video signal to reduce the echo effect that can arise with a speakerphone or that can arise if the sound from the speakerphone or headphone leaks into the microphone. Automatic gain control.
CounterPath eyeBeam 1.5 RFC RTP Signaling SIMPLE protocol SIP SIP account SIP address SRTP TCP TLS UDP URI URL USB device VAD vCard VoIP VoIP service provider WAV Request for Comment. A document that describes an aspect of an internet technology. An RFC may be a proposed, draft or full internet standard. Real-time Transport Protocol. A protocol for delivering the media portion of a data transmission over an IP network. SRTP is another media protocol.
