GVP 8.5.1 Support for GIR Recording

Features

This release of GVP introduces a new IVR Profile service-type: record, which applies to IVR Profiles that are associated with recording.

This page's link: GVP 8.5.1 Support for GIR Recording

New Options

Keep Alive Functionality

enabletcpkeepalive
Section: fm
Valid values: 0 or 1
Default value: 1
Takes effect: At start or restart

Set to 1 to enable sending TCP keepalive probes. Manage the delay and frequency of these probes with the tcpkeepaliveidle and tcpkeepaliveinterval configuration options, described below.

tcpkeepaliveidle
Section: fm
Valid values: a non-negative integer
Default value: 60
Takes effect: At start/restart

Sets the number of seconds that libcurl will wait while the connection is idle, before sending keepalive probes.

tcpkeepaliveinterval
Section: fm
Valid values: any non-negative integer
Default value: 60
Takes effect: At start/restart

Sets the number of seconds that libcurl will wait for an answer after sending a keepalive probe, before sending another probe.

Resource Manager Support for Recording IVR Profiles

Resource Manager (RM) can locate and select a recording-enabled IVR Profile. This functionality mimics GVP's existing usage of an MSML VoIP Service DN when the RURI parameter media-service is set to record.

When enabled, RM finds all IVR Profiles for the selected tenant whose variable gvp.general.service-type=record. Some details:

• If a call contains a value for X-Genesys-geo-location, RM selects the IVR Profile with a matching value in gvp.general.geo-location. If multiple profiles match, RM may choose any one of them.
• If a call does not contain a value for X-Genesys-geo-location and there is only one IVR Profile with record service-type, RM uses that one.
• If neither situation listed above applies, RM selects the IVR Profile named record.
• Finally, if none of the above situations apply, RM selects the default IVR Profile as the recording IVR Profile.

gvp.general.geo-location
Configured where: IVR Profile-level
Valid values: Any valid string
Default value: No default value (option not defined)

When X-Genesys-geo-location is provided in a call's initial INVITE, this option specifies the recording profile.
THIS VALUE NEEDS AN EXAMPLE
WAIT A MINUTE--WHAT DOES GEO-LOCATION HAVE TO DO WITH THE RECORDING PROFILE?

gvp.policy.voicexml-recording-allowed
Configured where: IVR Profile-level (or at tenant-level). This is TYPE-III policy parameter
Valid values: true/false
Default value: true

Enables recording for the selected IVR Profile.
THIS VALUE NEEDS AN EXAMPLE

gvp.general.service-type
Configured where: IVR Profile-level
New additional valid value: record

This option reports the current status of an IVR Profile.

Pass-through capability in support of GIR recording

The following config options support pass-through (a list, then details):

• [msml] conference.passthrough_enabled=true (mandatory)
• [conference] record_otherdnhearstone=0 (mandatory)
• [conference] record_recorddnhearstone=0 (mandatory)
• [mpc] sdp.map.origin.0.confgain=100
• [mpc] sdp.map.origin.1.confgain=100

...

• [mpc] sdp.map.origin.9.confgain=100

[msml] conference.passthrough_enabled
Update using the gvp.config.msml.conference.passthrough_enabled setting, within Request-URI parameters)
Valid values: true, false
Default value: true
Takes effect: immediately

Enables or disables the pass-through feature.
These existing configuration parameters must be changed in order to make pass through feature ready:

[conference] record_otherdnhearstone
Valid values: 0/1 (No/Yes)
Default value: 1
Value required for pass though: 0
Takes effect: immediately

Specifies whether the second conference participant is allowed to hear the repeating tone that indicates the call is being recorded.

[conference] record_recorddnhearstone
Valid values: 0/1 (No/Yes)
Default value: 1
Value required for pass though: 0
Takes effect: immediately

Specifies whether the first conference participant hears the repeating tone that indicates the call is being recorded

The parameters below read like internal settings to me. Does a user need to know these settings?
These parameters should be checked if their value in sdp.map.origin is defined:

• [mpc] sdp.map.origin.0.confgain
• [mpc] sdp.map.origin.1.confgain

...

• [mpc] sdp.map.origin.9.confgain

Valid values: 0-1000
Default value: 100
Value required for pass though: 100
Takes effect: at start or restart

Specifies the input gain factor to apply for the SDP matching connection when joining the conference.

Existing Options, Extended

Use these existing options to configure IVR Recording.

callrec_default_type
Section: conference
Valid values: any valid string
Default values: Empty (no value)
Takes effect: Immediately

Specifies the default recording type for MSML conference recording. Example formats: audio/wav, audio/wav;codec=ulaw, audio/mp3. If empty, the MCP uses the wave file from the default platform codec.

record.amazonpostmode
Section: msml
Valid values: http or https
Default values: http
Takes effect: Immediately

Specifies the mode to use for uploading recording files to Amazon s3, during MSML call recording.

• When set to https, MCP uses the HTTPS protocol.
• When set to http, MCP uses the 'HTTP' protocol (the default).
• If the primary and secondary recording destinations are both configured to use the s3 URI format, then MCP uses the value of this option to specify either HTTP or HTTPS.

record.amazonallowpublicaccess
Section: msml
Valid values: true/false
Default values: false
Takes effect: Immediately

Specifies the access permissions for the recording file that is uploaded to Amazon s3 during MSML call recording.

• When set to false, MCP restricts access to the uploaded file to the s3 bucket owner only.
• When set to true, MCP allows public download access to the uploaded recording file.
• If both primary recording and secondary recording destinations are configured to use s3 URI format, then MCP grants the access permissions specified by this option to the two recording files uploaded to Amazon s3.

record.basepath
Section: [msml].
Valid values: string
Default values: "file://$installationRoot$"
Takes effect: Immediately Description: Path pointing to the root directory for recording media. Name: [msml].record.amazontestserveruri
Valid values: string
Default values: Empty string
Takes effect: Immediately

Test server URL for posting the recording file instead of Amazon s3. Used for testing purposes.

record.irrecoverablerecordpostdir
Section: [msml].
Valid values: string
Default values: "$installationRoot$/cache/record/failed"
Takes effect: Immediately

While doing MSML call recording the recordings are added to a list if they need to be posted to Amazon S3, Call Recording API, HTTP/HTTPS or SpeechMiner. A separate posting thread wakes up from time to time and works on the list of recordings to be posted. This parameter specifies the directory for storing recording files which encounter irrecoverable errors during the post attempts.

record.posttimeout
Section: [msml].
Valid values: Must be an integer that is greater than or equal to 1 and less than or equal to the maximum integer as defined by the Genesys Administrator Help.
Default values: 120000
Takes effect: Immediately/session

The post timeout for recordings which need to be posted to Amazon S3, Call Recording API, HTTP/HTTPS or SpeechMiner. Once this timeout expires the post attempt would be treated as one which encountered recoverable error and would be retried. The default value of this parameter is 120 sec (120000 milli seconds).

record.updateheader
Section: [msml].
Valid values: "true" or "false"
Default values: "false"
Takes effect: Immediately

When set to true the recording file header will be updated on disk during MSML call recording. When set to false the recording file header will not be updated on disk during the recording and the header updation will be performed(if needed) while trying to place the recording file at its final destination.

record.userecordcachedir
Section: [msml].
Valid values: "true" or "false"
Default values: "false"
Takes effect: Immediately

When set to true, record cache dir(specified using config parameter mpc.recordcachedir) is used for FILE based MSML call recording. Once the recording completes, the recording file is moved from the record cache dir to the final recording destination. When set to false, record cache dir is not used for FILE based MSML call recording and the recording file is directly created at the final recording destination. Note that the value of this configuration parameter is ignored and the behavior for 'true' is used if HTCC post is desired.

record.filenametemplate
Section: [msml].
Valid values: string
Default values: "$id$"
Takes effect: Immediately

This parameter specifies the default template for generating MSML recording file name. Any gvp:param present in the template is replaced with its value if specified using MSML. The parameters AWSAccessKeyId(2), callrec_authorization, httpauthorization(2) and AWSSecretAccessKey(2) are not replaced by their value even if specified using MSML due to security concerns. Example:- The template "$id$$record$$MCPDateTime" produces the file name "basirecid12345_source_2013-09-13_08-10-15_." where id is specified as "basicrecid12345" and record is specified as "source" using MSML gvp:param. Using parameter $MCPDateTime enables insertion of MCP local time in the generated file name. Note that there is a 260 character limit(including directory names and extension) for the recording filename on Windows.

record.filenamepostfix
Section: [msml].
Valid values: string
Default values: Empty string
Takes effect: Immediately/session

This parameter specifies the string to be appended to the file name to make it static. If this string is not empty, then it is appended to the file name. Otherwise, the logID is appended.

record.channels
Section: [msml].
Valid values: 1 (mono) or 2 (stereo)
Default values: 2 (stereo)
Takes effect: Immediately/session

This parameter specifies the number of channels for MSML recording to dest( 1- mono, 2- stereo).

callrecording.dtmfhandling
Section: [msml].
Valid values: "as-is" (Record everything as-is from the RTP stream. Inband DTMFs will be recorded, but RFC2833 digits will not) "no-digits" (Strip out all DTMF digits. This includes inband or RFC2833. NOTE: When telephone-event is negotiated on the call, if inband audio DTMFs are received, they will not be removed from the recording) "all-digits" (Record all DTMF digits, including inband, and generate audio for RFC2833 digits)
Default values: "as-is"
Takes effect: Immediately/session

Specifies the recording behavior for DTMFs in MSML Call Recording.

clampdtmf.presilencepackets
Section: [msml].
Valid values: Must be an integer 0 to 50 inclusive
Default values: 0
Takes effect: Immediately/session

Specifies the number of audio packets that will be replaced with silence before a clamped DTMF. This can be used in the case where DTMF tone appears before DTMF RFC2833 event, which may happen when SIP gateway converts DTMF tones to DTMF RFC2833 event. Note the bigger number is set, the more audio delays will be introduced in a conference.

clampdtmf.postsilencepackets
Section: [msml].
Valid values: Must be an integer greater than or equal to 0
Default values: 0
Takes effect: Immediately/session Description: Specifies the number of audio packets that will be replaced with silence after a clamped DTMF. This can be used in the case where DTMF tone appears after DTMF RFC2833 event.

recordcachedir
Section:[mpc].
Valid values: The parameter must be set to a directory path
Default values: "$installationRoot$/cache/record"
Takes effect: At start/restart

This parameter sets the temporary recording cache directory in case of MSML call recording. Once the recording completes the recording files are removed from the cache directory after successfully placing them at the final recording destination.

record.userecordcachedir
Section:[msml]
Valid values: "true" or "false"
Default values: "false"
Takes effect: Immediately

When set to true, record cache dir(specified using config parameter mpc.recordcachedir) is used for FILE based MSML call recording. Once the recording completes, the recording file is moved from the record cache dir to the final recording destination.
When set to false, record cache dir is not used for FILE based MSML call recording and the recording file is directly created at the final recording destination. Note that the value of this configuration parameter is ignored and the behavior for 'true' is used if HTCC post is desired.