Bria 4 for Mac User Guide Retail Deployments
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 © April 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 Configuring Bria ......................................................................
CounterPath Corporation iv
1 Introduction Bria 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. Bria implements SIP-based standards for phone calls, IM and presence, allowing you to work with different VoIP service providers. Bria also uses XMPP-based standards for IM and presence.
CounterPath Corporation • 2 Support for these firewall traversal solutions: STUN, TURN, or ICE.
2 Installation and Setup 2.1 Getting Ready 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 “Configuring Bria” on page 49. XMPP Accounts If you use an XMPP service for instant messaging or presence, you will need the following information: • • • Jabber ID: user name and domain.
CounterPath Corporation 2.2 Configuring Bria First-time Startup If Bria is not already running, start it as you would any other program. The Bria Login dialog appears with the Profile set to “Manually configure login server”. Set the profile to “No login required” and click Continue. The softphone GUI appears. (Login is used only in enterprise deployments in which a system administrator has set up a provisioning server to automatically configure Bria for you.
Bria 4 for Mac User Guide – Retail Deployments 3. In the General tab, complete the User Details area with the information obtained from your VoIP service provider. 4. Complete the remaining tabs as specified by your service provider or to suit your setup. Settings that you may need to change immediately include: • General tab, Domain Proxy area. • Topology tab, if your computer is on a network and/or behind a firewall. For more information, see page 53. 5.
CounterPath Corporation Setting up for Voicemail Your VoIP service provider may offer voicemail. If it does, then you can set up some voicemail features in Bria. See page 55. Populating your Contact List Typically, you will want to create contacts in order to easily make phone calls, send IMs and transfer files. You can bring in contacts from other sources: • • From a file such as a vCard or comma-separated-values (CSV) file. See page 33.
Bria 4 for Mac User Guide – Retail Deployments 2.3 Troubleshooting Bria includes tools for helping you troubleshoot problems. From the menu, choose Help > Troubleshooting. • • • • Audio tab: 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). Video tab: You can verify that your camera is working.
CounterPath Corporation 8
3 Making Phone Calls 3.1 The Onscreen Softphone Minimize to dock Close window Bria Toolbar. See page 16 Voicemail indicator. See page 24 Missed calls indicator. Opens the History tab. Call entry field. See page 11. Resources.
CounterPath Corporation The Bria Menu The menu contains the following items that are specific to Bria: • • • • Bria 4 > Preferences. See page 64. View. Changes how Bria looks. Also lets you view the messages and chat rooms (if you are a member of one; see page 29). Contacts. Lets you work with contacts. Help. Provides access to various service-related features.
Bria 4 for Mac User Guide – Retail Deployments 3.2 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 Bria attempts to make a connection. Option Keying From the... Dialpad or computer keyboard Description 1. Enter the number or address in the call entry field using the dialpad or the computer keyboard. To turn letters to numbers, see page 13.
CounterPath Corporation Call entry field Click to place the call Auto complete suggestions For information on working with the call, see “Handling an Established Call” on page 16. Dealing with an Auto Attendant If you know that your call will be answered by an auto attendant and you know what menu items you will choose, you can include those menu items (DTMF) in the phone number when you dial it: • • • Before the first DTMF number, include at least one capital P. You can include other Ps.
Bria 4 for Mac User Guide – Retail Deployments Selecting the Account to Use This information applies only if you have more than one SIP account set up and enabled. When you place a call, you can explicitly specify the account to use for that call. The account selection options appear only if you have two or more SIP accounts that are enabled and being used for phone calls.
CounterPath Corporation Placing another Call You can place another call. There is no limit to the number of calls you can make, although eventually the quality of audio and video will degrade because of limitations on the computer. 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 on hold.
Bria 4 for Mac User Guide – Retail Deployments 3.3 Handling Incoming Calls Bria must be running to answer incoming calls. (If Bria is not running, incoming calls may be directed to voicemail; check with your VoIP service provider.) When Bria is in the foreground, the new call appears in its own call panel. When Bria is in the background (the focus is on other application), the incoming call notification appears in the upper-right corner.
CounterPath Corporation 3.4 Handling an Established Call Speakerphone Speaker and microphone control Voicemail See page 24 Missed calls See page 45 Add as Contact If a plus symbol appears here, you can add the current caller as a contact. See “Adding a Contact using an Existing Address” on page 37. Mute your voice Place another call The current call is automatically put on hold). See page 14 Hold and resume Transfer. See page 17 Add video.
Bria 4 for Mac User Guide – Retail Deployments 3.5 Transfering a Call Basic (Unattended) Transfer – Transfer this Call Click the Transfer button The call is put on hold and a call entry field appears. Type a name or number Then click Transfer Now. The call may end immediately. Or it may show “calling”, In this case, do not hang up immediately: if the other person does not answer, the call will come back to you.
CounterPath Corporation Attended Transfer – Call then Transfer You can first speak to the target (the person you are transferring the call to), then click Transfer to complete the transfer.
Bria 4 for Mac User Guide – Retail Deployments 3.6 Handling Video Calls Placing a Video Call Click the down arrow and choose Video call. If you mostly make video calls, you can Option-click this down arrow to reveal the “Set Video Call as default action” menu item. Adding Video If you have a camera, you can click Start Video to add video to an established call. When you add video, the other party may (or may not) start sending their video to you.
CounterPath Corporation 3.7 Conference Calls Starting a Conference Call You can start a conference call by: • • • making a conference call from the dashboard, adding participants to an existing established call, or having two established calls and merging them to a conference call. From the Dashboard • Enter the number or address by typing • Or select from the redial list Then choose Start Conference Call Type a name or number. Click Add. You can add more participants from here.
Bria 4 for Mac User Guide – Retail Deployments From an Existing Call From One Established Call From Two Established Call 21
CounterPath Corporation Managing the Conference Participant menu Conference call menu Mute. When you mute during a video call, you may also want to click Stop Video to stop the video feed. Adding More Participants You can add more participants to an existing conference in any of these ways: • • • Control-click on a contact and choose Add to Conference Call. In the conference call panel, click Invite to Conference Call, enter a name and then click Add.
Bria 4 for Mac User Guide – Retail Deployments Video Conference Calls “Video” appears beside each person Closing the video window stops sending video. Start and stop sending your video to all participants Starting a Conference with Video When you start a conference from established calls, video is included if at least one of the calls already includes video. Video is sent to all the participants. When you start a conference from scratch, video is not included.
CounterPath Corporation 3.8 Voicemail If your service includes voicemail and you have set up voicemail options (page 55), then when you have voicemail messages, the voicemail icon appears at the top of the phone (the icon may include a number). You can click the icon to automatically connect to voicemail and listen to your messages. Voicemail icon 3.9 Forwarding Calls You can enable or disable forwarding so that calls will be forwarded to another number.
4 Other Bria Features 4.1 Instant Messaging Sending an IM 1. There are several ways to select the person to send an IM to. From the Contacts tab Control-click on the contact and choose Send IM. 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 4.2 Sending a Broadcast IM You can send an IM to several people at one time. A broadcast IM is not a conference IM. • With a broadcast IM, each recipient can reply to the IM, but only you will see these replies; the other recipients will not see these replies. With a conference IM, all parties see everyone’s messages and the messages each party sends are seen by everyone. See “Group Chat (Conference IM)” on page 27. • In the Contacts tab, select the desired contacts.
Bria 4 for Mac User Guide – Retail Deployments 4.3 Group Chat (Conference IM) Group chat allows you to exchange instant messages with a group of people in the same session. Group chat differs from a broadcast IM in that all parties see everyone’s messages, and the messages each party sends are seen by everyone else. In a broadcast IM, each recipient can reply to the IM, but only the person who sent the broadcast IM will see these replies; the other recipients will not see these replies.
CounterPath Corporation Managing a Group Chat Leaving a Group Chat Unregistering your XMPPP account or exiting Bria lets you leave all the active group chat sessions. The session continues with the remaining participants. Once you leave a group chat, you will not be able to rejoin the session. The thread in the Messages window becomes inactive (grayed out); you can read chat history, but cannot participate or download unread messages.
Bria 4 for Mac User Guide – Retail Deployments 4.4 Chat Rooms Typically, chat rooms are used only in enterprises and are set up by the system administrator. 4.5 Viewing Messages On the menu bar and choose View > Show Messages to view your recent IM activity for any contact, group chat session, or chat room session. Search all messages. Clicking the x icon deletes the session. Click for more actions such as exporting conversation. The session may be greyed out.
CounterPath Corporation 4.6 Sending and Receiving Files Sending Files If you have an XMPP account, you can send files to another contact who has a Jabber address (meaning that they have an XMPP account). 1. Control-click a contact and choose Send Files; a standard Open dialog box opens. 2. Select the files to send and click Open. The Send Files dialog appears with a “waiting” message. If you want, you can cancel the send before the other person retrieves the file.
5 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 menu bar and choose View > Show Contacts. Add a Contact Search field Contacts are typically organized into groups. Bria includes built-in groups. You can add more groups, as desired. The online status of contacts. See page 39.
CounterPath Corporation 5.1 Populating the Contact List At any time, but particularly when you first deploy Bria, you may want to populate the contact list with contacts from an external source. Populating from the Mac Address Book You can populate the Bria contact list by pulling in the contacts from your Mac Address book. Enabling the Mac Address Book Enable the Mac Address book account that is has automatically set up in Bria.
Bria 4 for Mac User Guide – Retail Deployments Populating by Importing Contacts You can populate the Bria contact list by importing from an external file or files. The new contacts will be added to the existing contacts. Importing You can import a contact list from: • • CSV 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. vCard. A vCard file (*.vcf file).
CounterPath Corporation 5.2 Managing Contacts and Groups Adding a Contact Click , or control-click a group and choose Add Contact to Group. The Contact dialog appears. To enter a phone number, select the type, enter the number, and click + The new number appears in the list Field Description Contact Summary Group Click to show the list of groups. Check each group this contact should belong to. Primary Call If the contact has more than one number, select the primary number.
Bria 4 for Mac User Guide – Retail Deployments Example – Contact with a Softphone Number This example shows how to add a contact when your VoIP service supports online availability via your SIP account. Enter the person’s softphone number in the Softphone field As soon as you add a Softphone entry, this field automatically appears. Bria will share online presence information with this person using this phone number.
CounterPath Corporation Example – Contact with an XMPP Address This example shows how to add a contact who has an XMPP address (for example, a Gmail address). Assuming you have created a corresponding XMPP account in Bria (for example, an XMPP account for your Gmail address), then you can send this person IMs and share online status. Enter the XMPP address in the Instant Message field. Include the domain (e.g. @gmail.
Bria 4 for Mac User Guide – Retail Deployments Adding a Contact using an Existing Address You can add a contact by capturing existing information: • • If you are on a phone call with a person who is not a contact, click the Add to Contacts icon in the call panel. On the History tab, select an entry that is not a contact. Control-click and choose Add Contact. The Contact Profile dialog appears. Complete the dialog as desired and press OK.
CounterPath Corporation 5.3 Using Contacts Hover to reveal icons. Click to send an IM using the primary presence address for this contact. Click to call using the primary phone number. You can watch the contact’s online status, if the contact has a softphone address. See page 41 for the meaning of the online status icons. See “Sharing Online Status” on page 39 for information on obtaining online status information.
Bria 4 for Mac User Guide – Retail Deployments 5.4 Sharing Online Status You can publish your online status to contacts who have softphone address, and you can set up Bria to view the online status of other contacts. Typical online statuses are available, on the phone, busy, and so on.
CounterPath Corporation Allowing Other Parties to See your Status (Publishing your Status) Continuing from above, when the other person allows the notification request, your name is added to their contact list. As soon as you are added to their list, a request is sent back to you requesting that they be able to see you. Bria accepts this request automatically, and the other person can now see your status.
Bria 4 for Mac User Guide – Retail Deployments Setting your Online Status Changing your Status Click the down arrow beside the online status indicator on Bria, and select the desired value. Setting up Online Status Indicators Indicator Available Meaning for your Status Either: Meaning for Others’ Status You can contact this person. • You have set your status to this value. • Bria has determined that you are logged on but not on the phone or idle.
CounterPath Corporation Adding Contacts to the Alert List (Buddy Pounce) You can add a contact to the Alert List in order to request to be notified when the online status of a contact changes. In the contact list, control-click the selected contact or contacts and choose Add to Alert List. The Alert List icon appears beside the contact.
Bria 4 for Mac User Guide – Retail Deployments 5.5 Privacy You can control how contacts and other people can contact you by phone or IM, and you can control whether your contacts can see your availability information (whether you are online, one the phone, and so on). You can set up controls in advance or “on the fly” (as phone calls and presence requests come in). Setting up Controls in Advance To set up controls in advance, see “Preferences – Privacy” on page 65.
CounterPath Corporation 44
6 Using Other Resources 6.1 The History Tab Blue: Incoming call that was answered Red: Incoming missed call Green: Outgoing call, either attempted or established From the menu bar, choose View > Show History. Managing the List of Calls You can control-click on an entry in a list to: • • • • • Delete the call. Delete all entries in this list. Block this person to control whether they can send you phone calls or instant messages, or see your online availability.
CounterPath Corporation Phoning from History You can control-click on an entry to place a call to this person, using the contact method that was used for this call. You can: • • 46 Control-click on an entry and select Call or Video Call to place a call to this person, using the contact method that was used for this call. Place a call to this person and add them to a conference call that is in progress. For more information on conference calls, see page 20.
Bria 4 for Mac User Guide – Retail Deployments 6.2 The Favorites Tab To view the Favorites tab go to the menu bar and choose View > Show Favorites. You can create favorites from your contact list. They will be displayed in both the contact list and in the Favorites tab. Select the desired contacts, then control-click and choose Add to Favorites.
CounterPath Corporation 48
7 Configuring Bria From the menu bar, choose Bria > Preferences. The Preferences window appears. • • When configuring Bria the first time, click the Accounts tab and set up the account. Then complete other tabs as desired. After the initial setup, display whichever tab you want. 7.1 Configuring Accounts: the Accounts Tab Choose Bria > Account Settings from the menu bar. The Account Settings window appears, showing all the accounts set up.
CounterPath Corporation • • Create an XMPP account, if appropriate. For example, if you already have an XMPP account independent of Bria (for example, a Gmail account), you can create an account in Bria and pull your contacts into the Bria contact list. You can then IM these contacts directly from Bria. To create an XMPP account, see page 51. Enable the Mac Address Book account, if desired.
Bria 4 for Mac User Guide – Retail Deployments XMPP Account You create an XMPP account if, for example, you already have an XMPP account independent of Bria (for example, a Gmail account). Fields with a red asterisk are required Table 1: XMPP Account Properties – Account Field Account name Protocol Description If desired, change the account name to something that is meaningful to you. For example, the type of XMPP account such as “Gmail account”. Read-only. Always specifies XMPP.
CounterPath Corporation Table 1: XMPP Account Properties – Account Field Priority 52 Description The priority, as per RFC 3921. The default is 0.
Bria 4 for Mac User Guide – Retail Deployments SIP Accounts – General Fields with an asterisk are required Table 2: Accounts – General 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. If checked, this account is eligible to be used for phone calls. If unchecked, this account will never be used for placing phone calls.
CounterPath Corporation Table 2: Accounts – General Field Send outbound via Description Choose the setting specified by your VoIP service provider: • Domain: If your VoIP service provider requires that traffic be directed to proxies that are discovered via the domain. • Proxy Address: If your VoIP service provider has an outbound proxy address and requires that you provide the address to Bria. For the address enter a domain name (for example, domain.com) or an IP address (for example, 123.456.789.012).
Bria 4 for Mac User Guide – Retail Deployments SIP Accounts – Voicemail These settings let you set up to interact with your VoIP service provider’s voicemail service. They also let you configure Bria to forward calls in several situations, independent of your VoIP service provider’s voicemail service. Your service provider may provide the ability to set up for voicemail outside of Bria, for example, by phoning a softphone address and following the voice prompts, or by accessing a website.
CounterPath Corporation Table 3: Accounts – Voicemail Field Number for sending calls to voicemail Description Complete only if your VoIP service includes voicemail. Optional, but you must complete it if you check “Send calls to voicemail if unanswered”. This is the number that incoming calls will be forwarded to if they are unanswered after the specified interval (below). If you leave this field empty, then Bria will never forward calls to your service providers’ voicemail.
Bria 4 for Mac User Guide – Retail Deployments SIP Accounts – Topology Table 4: Accounts – Topology Field Firewall traversal method 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 Accounts – Presence Presence allows other softphone users to see your online status, and also allows you to see the online status of others. This tab lets you set up to share presence information with contacts. (Note that you do not have to set up to share presence information on an XMPP account.) Once you have configured presence on this page, you can set up rules; see “Sharing Online Status” on page 39 and “Preferences – Privacy” on page 65.
Bria 4 for Mac User Guide – Retail Deployments SIP Accounts – Storage Typically, you leave the storage method as Local. However, if your VoIP service provider provides access to an XCap or WebDav server, you can choose to store some contact data on that server. Contact data gets stored on the server as follows: • • • Softphone numbers and display names from contacts created manually or from a corporate directory or by importing from a file.
CounterPath Corporation SIP Accounts – Transport Table 7: SIP Accounts – Transport Field Signaling Transport Encryption Allow IPv6 Description Contact your VoIP service provider to identify the types of transport that are supported. Then choose a supported transport: • Automatic: Bria sets up the transport based on the capabilities of the network and the Bria computer. Choose this option if you do not care which transport is used. • TCP: This transport provides no signaling security.
Bria 4 for Mac User Guide – Retail Deployments Setting up for Security within Bria The options for media encryption are described in the following table. Table 8: Security Options Option Make and accept only encrypted calls Do not allow encrypted call How Outgoing Calls are Handled How Incoming Calls Are Handled Bria will place all calls with TLS. The call INVITE Bria will only accept INVITEs that are for encrypted calls. will specify SRTP media encryption.
CounterPath Corporation SIP Accounts – Advanced Table 9: SIP Accounts – Advanced Field Description Register Settings Reregister every Minimum time Maximum time The time interval between Bria’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.
Bria 4 for Mac User Guide – Retail Deployments Table 9: SIP Accounts – 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 7.2 General Preferences From the menu bar, choose Bria > Preferences. The Preferences window appears. All the tabs on this window except for “Accounts” are preferences tabs. These tabs let you control the way that you work with Bria. The icons (other than Accounts) let you set up general features of Bria. Preferences – Application This panel lets you set your preferences for general GUI behavior and lets you set up for login.
Bria 4 for Mac User Guide – Retail Deployments Preferences – Privacy You can control how contacts and other people can contact you by phone or IM, and you can control whether your contacts can see your presence information (whether you are online, on the phone, and so on). General Tab In “Global Contact Settings”, choose one option. If you choose “Only people in my contact list”, then all contacts will be able to contact you unless their name or their domain is in the Blocked list (below).
CounterPath Corporation Preferences – Alerts & Sounds This panel lets you control the alert box and lets you assign sounds. Enable Alert Displays • • You can control whether notifications are displayed in different situations. To receive notifications, notifications must also be set up to use either Banners or Alerts under OS’s system preferences (page 4). When “Enable alert displays” is on, Bria shows either a banner or an alert for selected situations.
Bria 4 for Mac User Guide – Retail Deployments Preferences – Devices Bria 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 Bria, unless the device is no longer available, in which case Bria will again select the device to use.
CounterPath Corporation Field Description Zero touch device configuration Typically, leave on. When device configuration is on, if you change your audio or video device, Bria will automatically detect the new device and start using it. Automatic gain control This feature is typically on. Reduce background noise Automatically attempts to remove background noise. Typically on for the speakerphone. Test Devices For information on the Test Devices button, see “Troubleshooting” on page 73.
Bria 4 for Mac User Guide – Retail Deployments Preferences – Codecs Audio Codecs This panel shows all the codecs that are included in the retail version of Bria. 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, Bria offers the enabled codecs and negotiates a common codec with the other party. You cannot change the properties of any codecs.
CounterPath Corporation 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.
Bria 4 for Mac User Guide – Retail Deployments Preferences – Calls These settings let you configure how you want auto answer to handle incoming calls, when Auto Answer is enabled. (To enable Auto Answer, see page 15). Field Description Auto answer These settings let you configure how you want auto answer to handle incoming calls, when Auto Answer is enabled.
CounterPath Corporation Preferences – Directory Typically, directories are used only in enterprises and are set up by the system administrator. Preferences – Advanced Field Description Recording folder The folder where files for recording of phone calls will be saved. Transfer folder The folder where received files will be saved. Web Page Tabs You can set up a web page as a new tab in the Resources panel; it will appear alongside Contacts, History and so on.
A Troubleshooting From the menu bar, choose Help > Troubleshooting. The Troubleshooting window appears. 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).
CounterPath Corporation Testing Video Quality While you are on a phone call, you can test the quality of the video. Note that to perform a valid test, you should be on an established call (not a call attempt).
Bria 4 for Mac User Guide – Retail Deployments 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 Diagnostics If you have contacted CounterPath Customer Support in order to troubleshoot a problem, you may be asked to generate a diagnostic log and send it to CounterPath. Click Select the problem you are experiencing Click Click Perform the actions you want to capture When done, click Advanced again to open the dialog. Click to stop logging Then click to choose a log file to send. The report is sent.
Bria 4 for Mac User Guide – Retail Deployments B Dial Plan When a call attempt is made, the call input (what you type or select in the call entry field) is processed to select the SIP 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 “dial plan” for each account.
CounterPath Corporation B.1 Dial Plan Syntax In Bria, the dial plan establishes the expected patterns of characters for a telephone number or softphone address, and allows for modification (transformation) of input based on the match to a pattern. The dial plan has the following syntax: pattern[|pattern];match=1;=;[match=2; =;] Where: • • • Items in [ ] are optional. Pattern: the pattern that will be matched. One or more patterns.
Bria 4 for Mac User Guide – Retail Deployments Element Origin Description \a Regular expression rules Wildcard for any single alphanumeric character. [digit-digit] Regular expression rules A digit within the specified range. [charactercharacter] Regular expression rules A character within the specified range. [digit1, digit2, digit3] Regular expression rules One of the characters in the collection. . Digit map rules Repeat the last element 0 or more times. For example, xxxx.
CounterPath Corporation B.2 How the Input Is Processed Comparing Input to the Dial Plan Patterns The input is compared to each dial plan in turn, starting with the first listed account. The process is slightly different depending on how the call is placed: • If the input was dragged or selected, then the entire input is compared to each dial plan. If a complete match is found, then that account is selected and the associated transformation is performed.
Bria 4 for Mac User Guide – Retail Deployments B.3 Examples Example 1 \a\a.T|xxxxxxx.T;match=2;pre="9" This simple example shows how to differentiate between a PSTN number and a softphone address, and how to add a “9” dialing prefix only to the PSTN number. Example 2 3xxT|1xxxxxxxxxx|[2-9]xxxxxxxxx|+x.T;match=2;pre="9"; match=3;pre="91";match=4;prestrip=1;pre="9011" 3xxT The first pattern is any three-digit number beginning with 3. No transformation. The assumption is that this is an internal extension.
CounterPath Corporation • Handling of the account prefix (#1), if you are upgrading from Bria 1.1 and are accustomed to entering the account number. Use of # to identify the account is now deprecated. The dial plan should be capable of determining the account to use for this number. However, since users may still be in the habit of entering the account prefix, you may want to include this pattern to handle such a scenario.
Bria 4 for Mac User Guide – Retail Deployments C Contact List Headings Following is a list of all the headings that are used in the Bria contact list. This list can be useful when formatting a contact list in order to import it into Bria. For details, see “Populating by Importing Contacts” on page 33.
CounterPath Corporation D Other Ways to Run Bria D.1 From a Hyperlink You can attach a hyperlink to a phone number or softphone address that, when clicked, starts Bria and dials the number. Bria supports three protocols: sip, tel, and callto. Attach a hyperlink with this format: dial address_or_number For example: dial kperera@domainA.
Bria 4 for Mac User Guide – Retail Deployments E Glossary Broadband Codec Dial plan DTMF Firewall IM MWI Narrowband Presence PSTN SIP account Softphone address USB device vCard 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 86
