Common Parameters and VOX| Call Recording Reference

Channel Parameters common to all channel types (analog, digital, voip etc.)

Access to these settings in GUI are found by navigating to Setup->Channels->Edit
All types of the recorder channels support set of common parameters described below

GUI setting	CLI Command format	Description	Extra Notes
	agc [y\|n]	enable/disable AGC	Applicable only to hardware-assisted recording.
	gain [db]	set gain	Applicable only to hardware-assisted recording.
	allowenbl [y\|n]	allow enable/disable channel at runtime. Special permission or Administration permission required.	Available only if dynamic licensing is used and dynamic licenses set is applied to this channel. Dynamic licensing allows you to record only the number of consecutive calls you want to record. This option allows more flexibility when you want to monitor a specific set of users without needing to record all your lines. Please note, this type of licensing runs a risk of missing some calls if the number of inbound or outbound calls exceeds the number of licenses purchased. For Dynamic licensing refer to config license - Licensing configuration
	licgroup [none\|1-n]	set channel license group	add channel to or remove from license group, refer to config license - Licensing configuration
	compress [ulaw\|adpcm\|gsm]	set channel compression codec
	dsp [y\|n]	enable/disable channel hw compression	Applicable only to hardware-assisted recording. Not applicable to VOIP channels.
	name [...]	channel description, 1..20 chars	Channel description is displayed in UI and applied to recording Description field.
	enable [y\|n]	allows to disable channel at startup. `Example:` `cli>` `->config ch 1 enable y`	Note: Always enable your channel to activate recording on it. The disabled channel does not record or report any events. If the channel is a member of dynamic license channel group, and allowenabl=y, the channel can be activated at runtime. For Dynamic licensing refer to config license - Licensing configuration
	maxsilence [sec]	max silence timeout(sec)	VOX activation sensitivity setting. Vox On event happens, when audio level is above highthrld level for minactivity period Vox Off event happens, when audio level is below lowthrld level for maxsilence period
	minactivity [sec]	min activity timeout (sec)	VOX activation sensitivity setting.
	highthrld [Dbx10]	high threshold (Dbx10)	VOX activation sensitivity setting.
	lowthrld [Dbx10]	low threshold (Dbx10)	VOX activation sensitivity setting. Vox On event happens, when audio level is above highthrld level for minactivity period Vox Off event happens, when audio level is below lowthrld level for maxsilence period
	test voxlevel [0-600]	start/stop vox level test (time in sec, default 60 sec)	Utility helps with selection of highthrld and lowthrld values
	event [id]	channel events configuration. See below

Channel Parameter

CLI How to use CLI Tool - refer to CLI Tool Overview		GUI
event [id] Most channel types support one or more events. All supported events are: busytone - busy tone detected dialtone - dial tone detected dtmf - dtmf sequence detected extern - external event received loopdrop - loop drop event detected (analog channels only) looponoff - loop on/off event detected(analog channels only) ring - ring event detected vox - vox event detected t1e1 - t1/e1 event detected. ABCD CAS events configured for T1/E1 boards, mostly for DPXXX boards. To see specific events available for the specific channel, type: event? , in channel config mode `cli>(config)` `->channel 17 event ?` `extern - external event configuration` `dtmf - dtmf event configuration` `cli>(config-ch_17)` To configure individual event , enter event configuration mode All events configuration modes , have a similar menu `cli>(config-ch_1)` `->event busytone` `cli>(config-ch_1-event_busytone)` `->?` `add act [1-n][action] - add event action` `set act [1-n] [action] - update event action` `remove act [1-n] - remove event action` `show - show current configuration` `exit - exit current configuration mode` `cli>(config-ch_1-event_busytone)`		Event config can be reached through Setup->Channels->Edit Clicking Edit on an event will bring up its configuration menu
Event Actions available: start, stop, set and rewrite `cli>(config-ch_1-event_dtmf)` `->add act ?` `start - start recording` `stop - stop recording` `set - (d-channel only), set recording field` `rewrite - (d-channel only), rewrite recording field`
Each action has some or all of the following parameters available: key, field, val and ref `cli>(config-ch_1-event_dtmf)` `->add act stop ?` `key [] - (optional,dtmf or d-channel), dtmf, button, led or lookup value` `field [] - (optional,d-channel only), set recording field: callerid,dialed,note,sessionid,extension,direction` `val [] - (optional,d-channel only), set recording field value` `ref [] - (optional,d-channel only), action reference, links "start" and "stop" actions`

Configuration is more obvious, if you view Event, Action and Action Param grouped in a table.

Please note that some actions (set, rewrite) and Action Parameters (field, val, ref) are not available for regular events, and limited only to D-Channel events.Program may allow setting unsupported parameters, but will ignore them at runtime.

Event	Action	Action Parameter	Parameter values or sample configuration commands	About Event
dtmf	start	key	Parameter is used only for dtmf events. Dial string of following chars [0-9,,#]. Comma can be used as different key options separator e.g. "12, 23" - start recording when dialed 12 or 23*	Dialed tones detected during the call. Call participants control recording by dialing programmed sequences.
dtmf	stop	key	Parameter is used only for dtmf events. Dial string of following chars [0-9,,#]. Comma can be used as different key options separator e.g. "12, 23" - stop recording when dialed 12 or 23*
busytone	start		This combination rarely used
busytone	stop		cli>(config-ch_1) ->event busytone add act stop
dialtone	start		cli>(config-ch_1) ->event dialtone add act start
dialtone	stop		cli>(config-ch_1) ->event dialtone add act stop
extern	start		cli>(config-ch_1) ->event extern add act start	Recorder UI user can manually selected start or stop recording. 3rd party program via API can issue this event. For example, custom program controls recorder and recording
extern	stop		cli>(config-ch_1) ->event extern add act stop
loopdrop	start		Usually, never used	Triggered by external side of the call hangup event. Analog lines only
loopdrop	stop		cli>(config-ch_1) ->event loopdrop add act stop
looponoff	start		cli>(config-ch_1) ->event looponoff add act start	Analog lines only corresponds to On Hook/Off Hook state of the recorded line
looponoff	stop		cli>(config-ch_1) ->event looponoff add act stop
ring	start		cli>(config-ch_1) ->event ring add act start	Ring detected
ring	stop		Usually, never used
t1e1	start		cli>(config-ch_1) ->event t1e1 add act start
t1e1	stop		cli>(config-ch_1) ->event t1e1 add act stop
vox	start		cli>(config-ch_1) ->event vox add act start	Voice activity or silence event. The following parameters affect VOX event generation: maxsilence, minactivity, highthrld, lowthrld Vox On event happens, when audio level is above highthrld level for minactivity period Vox Off event happens, when audio level is below lowthrld level for maxsilence period
vox	stop		cli>(config-ch_1) ->event vox add act stop

CLI		GUI
Standard On / Off Hook event configuration (analog channels): After each successful command you will see: *settings were modified, type 'save' command to save current settings. This has been deleted from the example(s) `cli>(config-ch_1)` `->event looponoff` `cli>(config-ch_1-event_looponoff)` `->add act start` `cli>(config-ch_1-event_looponoff)` `->add act stop` `cli>(config-ch_1-event_looponoff)` `->exit` `cli>(config-ch_1)` `->event loopdrop` `cli>(config-ch_1-event_loopdrop)` `->add act stop` `cli>(config-ch_1-event_loopdrop)` `->exit` `cli>(config-ch_1)` `->exit` `cli>(config)` `->save` Saving... Logger settings were saved. Saving channel settings ... Channel settings were saved Type "reload" command, to take effect. `cli>(config)` `->reload` Reloading... server is busy, wait...		Configuration of the event should resemble the following: After making these changes, it is necessary to Save and Reload at the channel menu
Sample DTMF event configuration Add action to start recording, when "101" dialed on the recorded line during the call `cli>(config-ch_1)` `->event dtmf add act start` `cli>(config-ch_1-event_dtmf)` `->show` `event [dtmf]` `actions:` `[1] start` `cli>(config-ch_1-event_dtmf)` `->set act start key 101` `cli>(config-ch_1-event_dtmf)` `->show` `event [dtmf]` `actions:` `[1] start` `[2] start key 101` `cli>(config-ch_1-event_dtmf)` Remove incorrectly entered action `->remove act 1` `cli>(config-ch_1-event_dtmf)` `->show` `event [dtmf]` `actions:` `[1] start key 101` `cli>(config-ch_1-event_dtmf)`		Configuration of the event should resemble the following: After making these changes, it is necessary to Save and Reload at the channel menu
Sample Radio / VOX Mode event configuration `cli>(config-ch_1)` `->event vox` `cli>(config-ch_1-event_vox)` `->add act start` `cli>(config-ch_1-event_vox)` `->add act stop` `cli>(config-ch_1-event_vox)` `->exit` `cli>(config-ch_1)` `->exit` `cli>(config)` `->save` Saving... Logger settings were saved. Saving channel settings ... Channel settings were saved Type "reload" command, to take effect. `cli>(config)` `->reload` Reloading... server is busy, wait...		Configuration of the event should resemble the following: After making these changes, it is necessary to Save and Reload at the channel menu
Configure VOX RANGE CLI and GUI tools allow testing VOX levels in real time to simplify configuration.
For example to check silence(idle) level, make sure that tested line has silence (no call on it) and enter the following commands: `cli>(config)` `->ch 1` `cli>(config-ch_1)` `->test vox 10` 10 seconds test is started at this time... see below `cli>(config-ch_1)` VOX Level Test Started. -610, -600, -600, -570, -590, -570, -580, -580, -570, -580 -580, -590, -580, -570, -580, -570, -570, -550, -560, -550 -550, -550, -560, -560, -540, -550, -550, -570, -570, -570 -570 `cli>(config-ch_1)` VOX Level Test Stopped.... You had silence on the line, so maximum value of the output can be considered beginning of the silence levels. -540 IS IDLE LEVEL (Remember, this is in negative numbers, so -500 is lower than -400.) LOW PARAMETER SHOULD INDICATE SILENT AT A MARK OF 30 TO 50 OVER IDLE (-500 for IDLE - 540) HIGH PARAMETER SHOULD INDICATE ACTIVE AND BE 30 TO 50 OVER LOW (-450 for IDLE - 540)		GUI configuration of VOX ranges is done by clicking the vslsetupStartVoxTest button in the VOX parameters section of channel settings The GUI will generate a graphical display of VOX activity. The top red bar is Threshold High, and the lower line is Threshold Low. Changes to VOX parameters will be represented in the graph After making these changes, it is necessary to Save and Reload at the channel menu
EXAMPLE NEW SETTINGS BASED ON IDLE OF -540 `cli>(config-ch_1)` `->lowthrld -500` `cli>(config-ch_1)` `->highthrld -450` `cli>(config-ch_1)` `->sh` ch# 1 ---------------------------------------- hwnum: 0 hw: shcti type: SYNWAY_ATP name: enabled: y licgroup: none allowenbl: n compression: mlaw dsp: n agc: y gain: 0 (dB) lowthrld: -500 (dBm10) highthrld: -450 (dBm10) minactivity: 1 (secs) maxsilence: 10 (secs) events: event [vox] actions: [1] start [2] stop ---------------------------------------- `Save and reload recorder..` `cli>(config-ch_1)` `->save` Saving... server is busy, wait... Logger settings were saved. Saving channel settings ... Channel settings were saved Type "reload" command, to take effect. `cli>(config-ch_1)` `->exit` `cli>(config)` `->reload` Reloading... server is busy, wait...

Channel Parameters common to all channel types (analog, digital, voip etc.)

Channel Parameter

CLIHow to use CLI Tool - refer to CLI Tool Overview

GUI

event [id]

CLI

GUI

Configure VOX RANGECLI and GUI tools allow testing VOX levels in real time to simplify configuration.

CLI
How to use CLI Tool - refer to CLI Tool Overview

Configure VOX RANGE
CLI and GUI tools allow testing VOX levels in real time to simplify configuration.