[CV >J] Assign a non-empty value to this variable to specify that Job Control Files are to be written with an entry for every item in a job. The default for version 8 or later is to write only the first FS filename followed by single line containing the negative value of the count of files. This variable is only needed after upgrade from version 7.
VALID_ASCII_EXTS
[CV >C] Assign a white-space-separated list of file extensions (each with a leading '.') to this variable to specify allowable file types which are to be treated as faxable if they appear to contain ASCII data. ASCII files with other file extensions will be rejected. When this variable is not defined, all such files will be treated as faxable ASCII files. Files with extensions .TXT, .ASC and .CVR are always treated as faxable ASCII files and are not affected by this variable. Note that this variable is not used by the SMTP Gateway to override these three extensions to identify a fax cover.
$var_def VALID_ASCII_EXTS ".cap"
VARGROUPS_USED
[SRO] Provides in an FS file a string of digits 0 to 9, and letters from A (=10) to U (=30) for higher numbers, recording the history of the use of variable groups.
VDATEx, VTIMEx
[SRO] These variables expand to the validity date of a public key used for encryption of an e-mail. For details of the optional formats, refer to DATEx and TIMEx. Other than in an e-mail which is encrypted, the variables expand to empty. When included in CERT_VALIDITY, the whole phrase will be expanded to empty if the e-mail has not been encrypted. The date and time are shown in the time zone of the local machine, and TIME_OFFSET is applied if in use. Note that when the certificate expires in a daylight savings period and its date is viewed in a standard time period, or vice-versa, the time shown may be an hour different from the time shown by the Windows certificate properties dialog, which may use the current time zone settings, not those for the expiration date, to convert the UTC time of the certificate.
VMAIL_INDEX
[SRW] This variable should be set to a value between 1 and the number returned by VMAIL_SCAN (inclusive) to reference an entry in the table of message files created by referencing VMAIL_SCAN. If the number assigned to the variable is outside this range, the values returned by VMAIL_NAME and VMAIL_INFO will be empty. The VMAIL_INDEX variable is set to one when you reference VMAIL_SCAN, unless (a) there are no mail message files, in which case it is set to zero or (b) the VMAIL_START variable has been set to last in which case it is set to the number returned by VMAIL_SCAN.
VMAIL_INFO
[SRO] After referencing VMAIL_SCAN and setting VMAIL_INDEX to a valid value, this variable contains information about the voice message file referenced, in the format described below. Otherwise, the value is empty. You may substring this variable and reference the components in $play_var commands (with custom algorithm files) to describe the file to the caller. The format of the information returned is YYYYMMDDHHMMWS, where YYYYMMDD represents the date of the file, HHMM the time of the file, W the day-of-week of the file (Sunday=1), and the remaining characters in the value are the file size in bytes. The provided VMAIL.ALG sample algorithm file will speak the day, date and time from this variable string in US or UK English.
VMAIL_MIN
[SW] This variable sets, for the remainder of the call, the minimum voice message file size in bytes, below which a message will be considered as 'noise' and deleted during a message scan. The default value is 4000, which represents just over a second in the normal recording format of 6kb ADPCM.
VMAIL_NAME
[SRO] After referencing VMAIL_SCAN and setting VMAIL_INDEX to a valid value, this variable contains the full pathname of the voice message file referenced. Otherwise, the value is empty. You may reference this variable on a $image_desc command to play back the message to the caller.
VMAIL_SCAN
[SRO] This variable returns the number of voice messages found in the current recorded message directory. Each time you reference this variable it re-scans the directory to obtain the names of all the message files and sorts them into call number sequence. File names and file information may then be retrieved using the VMAIL_NAME and VMAIL_INFO system variables, after you have set the VMAIL_INDEX variable to reference the specific table entry.
VMAIL_START
[SW] This variable can be set to a keyword of last to start from the most recent message after a VMAIL_SCAN. Any other value of assigned to this variable is treated as first, which is the default. This variable also affects the sequence of playback of messages initiated by a $type playback infobox or selecting the infobox defined in $playback in the user profile. The setting lasts for the remainder of the call or until a new value is assigned to this variable.
VMSG_DIR
[SW] You can set this variable to a new directory name you wish to use for CopiaFacts voice messages. The change takes place immediately and is effective until the end of the call or until changed again. If the value is not a valid directory name, the change will not be made. This feature allows you to change the language in which the call messages are spoken as a result of caller input in a question box. The variable name may also be specified as VMSGDIR, without the underscore. If there is no FAXFACTS.DIG file in the appropriate directory, the existing filename will not be changed.
VOICE_DELAY
[SW] Sets a value in minutes for the delay between voice outbound attempts when infobox logic transfers to state VOICE_RETRY. The value may be preceded by a prefix of 'A' to indicate that the alternate phone number is to be used on the next attempt. If no delay is specified, a default value of 3 minutes is used. A value must be assigned to this variable (using $set_var) during the call to be effective.
VOICE_PARMS
[SW] For calls transferred using $type transfer commands, values of the form "parm=number" may be assigned to this variable to set parameters for the current call transfer only. If any values are set, all $cpb_parm values in the configuration file are ignored for the call. The parameters are applied to the outbound call, not the incoming line, for SC-Bus transfers in which a second line is used. See the examples shown for $dial_cmd, and the list of parameters for $cpb_parm.
VOICEBC_HANGUP
[SWS] Assigning a value in seconds to this variable in an infobox or FS file will cause a hangup by the called party in a voice broadcast to be treated as a successful conclusion of the call if the call duration exceeds the specified value. Assigning a value of 0 causes all calls to be treated as successful if the called party has hung up after connection. Assigning a keyword of fail will cause the call to be failed with outcome code 94 on hangup by the called party: this is the default. It is possible to assign different value at different times in an infobox sequence.
VOIP_CLEAR_CALL_MS
[CV >C] Specifies a minimum interval in milliseconds after a BYE or CANCEL has been processed, before the channel is released. The default value is 10000, which should allow time for the required SIP responses to be handled as part of the call.
VOIP_DELAY_PLAY_IB
[CV >C] Specifies a minimum interval in milliseconds before the start of the first play operation on an inbound VoIP call.
$var_def VOIP_DELAY_PLAY_IB 1000 ; wait one second
VOIP_DELAY_PLAY_OB
[CV >C] Specifies a minimum interval in milliseconds before the start of the first play operation on an outbound VoIP call.
$var_def VOIP_DELAY_PLAY_OB 1000 ; wait one second
VOIP_DTMF_INBAND
[CV >C] Set this variable to a non-empty value to enable DTMF in-band detection (tones), which is no longer the default for Copia VoIP Ports. This variable should be set in the FS file for output calls, or in the USR file controlling an inbound call.
$var_def VOIP_DTMF_INBAND yes
VOIP_DTMF_MININTERVAL
[CV >C] Set this variable to the minimum number of milliseconds to be allowed between tone detections for in-band DTMF tones on Copia VoIP Ports. The default value is 40. In practice the resolution for this value is currently 20ms, and reducing the value to 20ms may still not detect auto-generated tones near the minimum intervals specified by ITU Q.23.This variable should be set in the FS file for output calls, or in the USR file controlling an inbound call.
$var_def VOIP_DTMF_MININTERVAL 20
VOIP_DTMF_TRIGGER
[CV >C] Set this number to the sequential number of the RFC2833 packet signaling a DTMF tone which is to be used as a trigger. The default is 1 to trigger on the first packet for a tone after the end of the previous tone. See the discussion in the Copia VoIP Ports topic. This variable should be set in the FS file for output calls, or in the USR file controlling an inbound call.
VOIP_FROM_NAME
[SRO] This variable contains the SIP Display Name, if available, for incoming calls to Copia VoIP Ports. The first 21 characters are also placed in the ANS log file field.
VOIP_FROM_URI
[SRO] This variable contains the full SIP URI for incoming calls to Copia VoIP Ports.
VOIP_PARM_DELIMITER
[CV >C] Use this only in a FAXFACTS.CFG $var_def command. It defines the delimiter character which you will use to separate parameters defined in VOIP_SET_CUSTOM_PARMS. This delimiter becomes a newline in the INVITE command and is shown as ¶ if the text of the INVITE appears in a trace file. Use this variable when your parameter values contain a semi-colon other than as a delimiter. Avoid choosing a vertical bar character, which has a special use for concatenation if you build the custom parameters string using $set_var comands.
VOIP_GET_CUSTOM_PARMS
[CV >C] Retrieves the values of custom parameters from an INVITE message on an incoming VoIP call on Copia VoIP Ports. Multiple parameter names can be specified, always semi-colon separated, in the value, and the parameters selected are those with an initial substring consisting of the specified parameter name. A CopiaFacts variable is set with the name of the parameter and the value of its arguments.
[CV >C] Allows custom parameters to be added to the INVITE message of an outbound call. The value can contain multiple parameters separated by a delimiter which defaults to a semicolon character.
$var_def VOIP_SET_CUSTOM_PARMS "X-parm1: value 1;X-parm2: value2"
It is recommended that you should follow the advice for these parameters in RFC3261 [7.3.1], which is to follow the field-name immediately with a colon and single space character, and then follow this with the field-value.
Note that if any value in an added name: value parameter contains a semicolon, you must change the default separator character to another delimiter by using a FAXFACTS.CFG variable VOIP_PARM_DELIMITER to specify a different character that you will use to separate parameters. The delimiter becomes a newline in the SIP INVITE command. and this then becomes a ¶ if the INVITE appears in a Copia race file.
VOIP_SET_FROM_NAME
[CV >C] The value of this variable is set as the sender name for a SIP INVITE request sent from Copia VoIP Ports. The keyword anonymous in this variable has special functions described in the $outbound_ani topic.
VOIP_SIP_RESPONSE
[SRO] This variable will be set to the SIP response value (4xx, 5xx, 6xx) for a failed call, when this is enabled using environment variable VOIP_Q931.
VOIP_MUTE_MS
[CV >C] Set this variable to the number of milliseconds for which audio is to be muted after detection of either incoming DTMF or silence on the original half of a linked call on linked Copia VoIP ports.
$var_def VOIP_MUTE+_MS 500
VOIP_P_ASSERTED_ID
[C>CV] The value from a P-Asserted-Identity header field on an incoming INVITE to a Copia VoIP port, if present.
VOIP_PRIVACY
[C>CV] The value from a Privacy header field on an incoming INVITE to a Copia VoIP port, if present.
VOIP_USE_SIPTO
[CV >C] a non-empty value in this variable causes the To: URI from an incoming INVITE to a Copia VoIP port, if present, to be used to provide the DNIS number if present. The expected syntax is "sip:dnis@domain".
$var_def VOIP_USE_SIPTO yes
VOLUME
[SW] Set the playback volume for the remainder of the call or until a new assignment is made. The assigned value is added to the value set by the $volume command, if any, and the result set to the nearest point in the range -10 to 5. A value of -10 represents a reduction of 20db in the standard volume, and 5 represents an increase of 10db.
