VOIP Recorder

Operations Guide

If you have not read and completed the installation guide you should do that first. If you are consulting this documentation because you are hearing a series of repeating staccato clicks that is because the clicks are inserted into the audio stream when you using a demo license. Purchasing a production license will make them go away.

Once VOIP Recorder is started all normal operations are done through the web interface. The web interface is on port 11500 of your computer which you can access at http://localhost:11500/ from that same computer. It can be accessed from other machines on your LAN using the URL displayed when the application starts up.

If you are running VOIP Recorder on Windows you can use a shortcut to start up the web console by just clicking on the VR icon in the system tray. Right clicking that icon is used to shut VR down.

VOIP Recorder is password protected. The username is "admin" (don't type the quotation marks) and the initial password is "default". You can change the password on the configuration tab of the web console.

The console is divided into four tabs plus a refresh button. The console refreshes itself periodically but you can always force an immediate update by pressing the red [refresh] button in the upper right corner.

The four tabs are the At-A-Glance screen, the Recordings screen, the Caller ID Log screen, and the Configuration screen. Labels that allow you to switch between these tabs are always located at the top of the console.

If you need help just write us at vr-support@penbaynetworks.com

At-A-Glance

At-A-Glance is the central dashboard of the web console. It provides a summary of recent phone activity, the status of VOIP Recorder, the status of your voice mail box, and a report of any live phone calls.


The At-A-Glance Screen

Active Calls

The active calls section provides a list of any calls currently in progress and convient access to their audio. If no calls are currently in progress it lists "none". Each call is described by the time of initiation, the direction (inbound or outbound), the two phone numbers involved and the Caller-ID name of the caller.

In addition to the descriptive information there are three links provided for each active call. The "Listen from Start" link will play the call back from its beginning. The "Listen Live" link will play the audio from the call on your computer as it happens in near real time. The last link allows you to toggle the recording of this call - if the call is currently not scheduled to be recorded the link will say "Record Now", and if the call is currently expected to be saved it will say "Stop Recording". Clicking the link changes the status of that call and updates the label.

VOIP Recorder Status

This box displays information on whether or not VOIP Recorder is detecting a properly functioning Vonage™ connection. When properly configured the Vonage™ servers and ATA pass messages back and forth to each other once in a while even when you are not using the phone. This is so the Vonage™ servers know where your ATA is registered in case it needs to make the phone ring. When VOIP Recorder detects this activity it displays "OK - Phone Activity is Detected". When no such activity has been heard in a while that changes to "No Phone Activity Detected". When that latter message appears, recording will not work. It is normal to take a few moments to change to "OK" status after startup.

Voicemail Status

The number of new and old messages in your Vonage™ voicemail box is displayed in this portion of the At-A-Glance screen. It will read "No Voicemail Pending" if your mailbox is empty or "Unknown" if the mailbox status has not been determined. It often takes a while after startup for a voicemail notification to be observed and the "Unknown" value to be replaced with the accurate status. Accessing your voice mail tends to generate a notification and update the web console quickly thereafter.

Archive Status

VOIP Recorder automatically converts the recorded phone calls into .WAV sound files. This file archive can be managed either by the number of calls in the archive, the disk space they are taking up, or the age of the calls. Individual calls may also be deleted on the Call Recordings tab. The archive status box shows you how many calls are in the archive and how much disk space they are using.

Recent Calls

The recent call list is largely self explanatory. It shows the last 5 calls, either inbound or outbound. These calls are displayed whether or not they are recorded. The format is the same as for the live call list: the time of call initiation, the direction (inbound or outbound) of the call, the caller number, the number being called, and the Caller-ID name of the caller.

Recordings

The Recordings tab is the heart and soul of VOIP recorder. It is here where all the recorded calls are displayed in detail and may be played back, searched, and managed.


The Recordings Screen

Each call includes both basic and advanced information. The basic information includes the Caller-ID name and number and the number being called as well as the date and time of the call. The display of each recording also includes a unique serial number, a listen icon, the duration of the call expressed in minutes and seconds, a priority field, and a button used to purge the recording.

To play back a call just click the "listen" link for that call. A .wav file will be downloaded to your computer and your web browser will open whatever software you have configured for playing back sound files (e.g. iTunes, MoviePlayer, etc..). The sound file is constructed as a stereo .wav file with one party on the left channel and the other party on the right channel.

The display may be sorted on any of those criteria by clicking on the column heading. For instance, to sort the list by time click on the "Date" header. The default sort is A to Z. If you would like a reverse sort (Z to A) just click on the heading a second time.

In addition to automatic archive management (which is setup in the Configuration screen) calls may be manually deleted one at a time by clicking the button in the Purge column. A confirmation dialog comes up to double check you meant to delete the call.

The values set by the priority drop-down box are used during automatic archive management. The priority of a call may be set to either high, normal, low, or "save". When the archive manager needs to delete a call (e.g. you configured a 100MB limit to the archive size and it has grown to exceed that) it will first select from calls at low priority, then normal priority, and only after all calls in the first two classes are exhausted will high priority calls be deleted. Calls marked with the special "save" priority will not be deleted even if configured archive size limits have been exceeded.

Caller ID Log

The Caller-ID log screen contains a potentially large list of all calls observed by VOIP Recorder. These include both calls made and calls received. Calls are logged to this screen even if they are blocked, not recorded, or not answered - it is a record of all call activity.


The Caller ID Log Screen

Blocked calls contain the phrase "BLOCKED" at the right end of the line describing all of the other call info.

As with the Recordings screen the calls may be sorted in either forward or reverse by clicking (or double clicking for reverse) the column header you wish to sort by.

VOIP Recorder will maintain a list of up to 1000 Caller-ID entries. This extensive history is significantly more useful than the short histories typically embedded in a telephone handset.

If you would like to clear the Caller-ID history just click on the "Clear Caller-ID Log" link that appears in blue above and to the right of Destination Number column header.

In addition to the history log, the Caller-ID page contains the phonebook of all stored caller numbers. The Caller-ID name associated with each of these numbers can be changed to something more personal. For instance, "Jane Smith" could be changed to be "Mom". In that case each time Ms. Smith called (or was the callee) the associated pop-up and Caller-ID log entry on VOIP Recorder would show "Mom".

Configuration

The most complicated part of the web console is the configuration screen. Many powerful features can be setup and adjusted here. The good news is that for basic operation you can just ignore this screen - everything just works out of the box. However, if you are having problems or would like to use some advanced features then you should read on.


The Configuration Screen

Save or Restart

The "Save Config" and "Restart VOIP Recorder" links at the upper right corner of the configuration screen are used to persist and activate changes made on the configuration screen. After updating the configuration values that interest you just click "Save Config" and the changes will be reflected in the operation of VOIP Recorder immediately.

Values that require a restart will normally have that restart executed automatically when the configuration is saved but a restart link is provided in case VOIP Recorder seems to be still using old values. An example of such a circumstance would be a change in the automatically discovered IP address of the Vonage™ ATA. If that very unusual event were to happen you would need to restart VOIP Recorder to pick up the change.

Network Addresses

Normally the network addresses needed by VOIP Recorder are automatically probed during startup. The results of that auto-configuration are displayed here in the VOIP Address, VOIP Port, Local Address and Gateway Address fields. The VOIP Address and port refer to your Vonage™ ATA, the Local Address refers to the IP address of your local computer, and the Gateway Address is the IP Address of your home networking router.

When these values are auto discovered the fields are displayed read-only in the console. If you would like to override the auto configuration then simply click the field name to make it writable. Internet Explorer will display the field name in grey when it is read-only. After making it writable you can set the value to the address you prefer. After doing so click the "Save Config" link. Do not make the field read-only again, doing so will re-enable auto configuration.

Routing and Forwarding

The Active ARP Redirection and Active Packet Forwarding options control how VOIP data is redirected to your computer. Most configurations should leave both of these options set to enabled.

Disabling ARP redirection will cause the Vonage™ ATA and servers to communicate directly without the help of another piece of network equipment. If no other equipment performs this re-routing, then VOIP recorder will not be able to see any phone data. You may want to disable this function if you are operating with an enterprise grade switch in port mirroring mode, or if the VOIP recorder code is running directly on a router or bridge.

Forwarding should only be disabled if the VOIP recorder code is running directly on a router or bridge which is already forwarding the VOIP data.

Maximum Archived Call Age

The maximum archive call age parameter is used to establish an expiration policy for call management. Calls older than this value are automatically removed. This can be used to enforce a data retention policy.

If this parameter is set to disabled then recordings are never purged because of their age. Otherwise, the expiration period can be set to one day, one week, thirty days, or ninety days.

Maximum Archived Disk Use

The maximum archive disk use parameter is used to establish an expiration policy for call management. The archive is only allowed to use the amount of disk space specified by this parameter before calls are expired. Calls are selected for expiration according to their priority pools set in the Call Recordings screen.

If this parameter is set to 0 then recordings are never purged because of the disk archive size. Settings greater than 0 represent the number of MegaBytes stored in the call archive before expiration is attempted.

Maximum Number of Archived Calls

The maximum number of archived calls parameter is used to establish an expiration policy for call management. The archive is only allowed to store up to the number of calls specified by this parameter before calls are expired. Calls are selected for expiration according to their priority pools set in the Call Recordings screen.

If this parameter is set to 0 then recordings are never purged because of the number of calls in the disk archive.

(Do Not) Record This Call Touch Tone

VOIP Recorder has the ability to change the record status of calls while they are in progress when the local party (i.e. the owner of the Vonage™ ATA) presses certain touch tone sequences. All calls are set to yes-record status by default but that default might be changed by a filter. See below for more on filters. Whether or not the call is set to record when it begins, that status can be changed with the Record-This-Call or Do-Not-Record-This-Call touch tone sequence.

The sequences may be up to four key presses using 0-9 plus the # or * keys.

The default Record-This-Call sequence is ##1, and the default Do-Not-Record-This-Call sequence is ##2.

There is no limit to the number of times the record status can be toggled back and forth during a single call. Any configured announcement (see below for announcements) is played the first time the call obtains yes-record status. Announcement time might be when the call is established if the filters indicate yes-record status, or it might be when the Record-This-Call sequence is pressed for the first time.

If a call is committed to the archive the recording always begins at call initiation time and contains the entire call regardless of when yes-record status was established.

Use Caller-ID Pop-ups

A desktop pop-up with Caller-id information is created at call initiation time if this configuration item is set to enabled.

Change Admin Password

This setting controls the password for the web console. To change it you will need type the new password into the Change Admin Password field as well as the Confirm Password field. This redundancy is to make sure you do not accidentally introduce a typo. Afterwards click "Save Config" and you will have to re-login with your new password.

The username of "admin" is not alterable.

Update License Key

If you have obtained a new license to replace an expired one or you have purchased a production license to upgrade from a demonstration license you will need to use this field to update the license file of VOIP Recorder. Just paste the new license string into this field and then press the "Save Config" link.

Recording Notifications

There are almost certainly local laws governing the proper procedures for recording telephone calls in your jurisdiction. This discusses the matter a little bit but this documentation cannot replace the advice of a lawyer.

VOIP Recorder has the concept of an automated announcement which notifies one or both parties that the calls is being recorded. It does this by inserting an audio clip of the phrase "Recording" into the call's audio.

Using the "Insert Inbound Announcements" and "Insert Outbound Announcements" parameters you can control whether or not these announcements are made. If they are made you can control who hears them. Inbound announcements are heard on the phone connected to the local Vonage™ ATA. Outbound announcements are heard by the party on the other end of the phone.

As an alternative to spoken announcements, VOIP Recorder can also insert a courtesy beep into the phone call. These short high pitched beeps repeat every few seconds to remind the participants about the recording. They can be enable in either direction and their repeat interval can be set as short as 15 seconds or as long as 3 minutes. Use "Inbound Courtesy Beep Frequency" or "Outbound Courtesy Beep Frequency" to configure the courtesy beeps. They are disabled by default.

Filters

Filters allow you to change the default behavior of whether a caller is recorded, not recorded, or blocked entirely. Blocked calls do not ring the phone. Instead of a ring callers receive a busy signal and are sent to voicemail.

Filters that adjust yes-record or no-record status are applied to both incoming and outgoing calls. Filters that control call blocking only apply to incoming calls - outgoing calls are never blocked.

Each filter has a type. The type is the criteria on which the filtering decision is made. Available types are the calling number, the number being called (called number), and calling name. The calling name is the Caller-ID information of the call originator.

Whether or not a filter matches is based on the filter's type and the name/number criteria. If it does match the action field determines what happens to the call. The options are Do Not Record, Record, Block, or Do Not Block.

Because the default for all calls is to record them you might think only the Do Not Record filter would be necessary. However the Record filter can be used to provide a more fine grained exception to a broad Do Not Record filter. This works because only the first matching record filter is used on any individual call.

As an example consider two filters: Record from Calling Number 3155551212, and Do Not Record from Calling Number 315. This has the net effect of not recording any call from a phone number containing 315 except for calls from 315-555-1212. Block and Do Not Block can be combined the same way.

The Name/Number field is the data applied against corresponding data in the phone call to see if the filter matches. For phone numbers you may specify the full number or just a substring. Only the actual phone digits are used, but you can input it with dashes and spaces if you like and VOIP Recorder will convert an input like 315-555-1212 to 3155551212 for you. The special value * matches any name or number.

Anonymous callers (those without a name or a number) may be matched by specifying the value anonymous as the phone number.

To add a new filter complete the type, action, and name/number fields and then click the "Add This Filter" link. To remove a filter just click the "Remove This Filter" link next to it. The order of the filters is important, only one record or block filter is matched per call and the potential filters are matched in the order you list them.