GVP 8.5.1 Support for GIR Recording
Features
- A new IVR Profile service-type is introduced: record, which is dedicated for IVR Profiles that are associated with recording.
[https://enu.docs.genesys.com/Documentation/GVP/latest/GDS/COpts851-8 GVP 8.5.1 Support for GIR Recording]
GVP 8.5.1 Support for GIR Recording
New Options
Keep Alive
enabletcpkeepalive
Section: fm
Valid values: 0 or 1
Default value: 1
Takes effect: At start/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.
tcpkeepaliveidle
Section: fm
Valid values: a non-negative integer
Default value: 60
Takes effect: At start/restart
Number of seconds that libcurl will wait while the connection is idle, before sending keepalive probes.
tcpkeepaliveinterval
Section: fm
Valid values: a non-negative integer
Default value: 60
Takes effect: At start/restart
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 Profile
Extend Resource Manager for looking up a recording IVR Profile. This applies to existing usage of MSML VoIP Service DN with RURI parameter media-service=record.
Look up all the IVR Profiles for the selected tenant with gvp.general.service-type that includes record;
- If the call contains X-Genesys-geo-location, the IVR Profile with a matching
gvp.general.geo-location is selected. It is possible this will yield multiple matching IVR Profiles; no specific behavior is currently defined and RM may choose any matching IVR Profiles;
- If the call does not contain X-Genesys-geo-location and there is only one IVR Profile with
record service-type, use that one.
Fall through to step 2 for any other conditions to use the existing method.
- If none of the above matches, select the IVR Profile named record. This is the existing
method.
- If none of the above matches, select the default IVR Profile as the recording IVR Profile. This is
the existing method.
gvp.general.geo-location
Configured where: IVR Profile-level
Valid values: Any string value
Default value: No default value (undefined parameter)
In cases where 'X-Genesys-geo-location' was provided in initial INVITE, this parameter will be used for selecting 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.
gvp.general.service-type
Configured where: IVR Profile-level
New valid value: record
Use to inform that this IVR Profile is for being used as recording.
Pass-through capability in support of GIR recording
In summary, for pass through support, we should have the following config options:
[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
Effectiveness: Immediately/session (can be updated through setting gvp.config.msml.conference.passthrough_enabled within the Request-URI parameters)
Valid values: true, false
Default value: true
Description: enable/disable pass through feature.
These existing configuration parameters must be changed in order to make pass through feature ready:
[conference] record_otherdnhearstone
Effectiveness: Immediately/session
Valid values: 0(No), 1=(Yes)
Default value: 1
Value required for pass though: 0
Specifies whether the second conference participant hears the repeating tone that indicates the call is being recorded.
[conference] record_recorddnhearstone
Effectiveness: Immediately/session
Valid values: 0(No), 1=(Yes)
Default value: 1
Value required for pass though: 0
Specifies whether the first conference participant hears the repeating tone that indicates the call is being recorded
These parameters should be checked if respective sdp.map.origin is defined:
[mpc] sdp.map.origin.0.confgain
[mpc] sdp.map.origin.1.confgain
...
[mpc] sdp.map.origin.9.confgain
Effectiveness: At start/restart
Valid values: 0-1000
Default value: 100
Value required for pass though: 100
Specifies the input gain factor to apply for the SDP matching connection when joining the conference.
Existing Options
Use these existing options to configure IVR Recording.
callrec_default_type
Section: conference
Valid values: string
Default values: Empty string
Takes effect: Immediately/session
The default recording type for MSML conference recording. Example formats: audio/wav, audio/wav;codec=ulaw, audio/mp3. If left empty, the MCP will use wave file with the default platform codec.
record.amazonpostmode
Section: [msml].
Valid values: "http" or "https"
Default values: "http"
Takes effect: Immediately/session
This parameter specifies the mode to be used for uploading recording files to Amazon s3 during MSML call recording. When set to 'https', MCP would use 'HTTPS' protocol for uploading the recording files to Amazon s3 and when set to 'http', MCP would use 'HTTP' protocol. The default mode is 'HTTP'. Note that if both primary recording destination(recdest) and secondary recording destination(recdest2) are configured to use s3 URI format(s3:bucketname) then MCP would use either 'HTTP' or 'HTTPS'(depending upon the configuration value of this parameter) for uploading the two recording files to Amazon s3.
record.amazonallowpublicaccess
Section: [msml].
Valid values: "true" or "false"
Default values: "false"
Takes effect: Immediately/session
Specifies the access permissions for the recording file uploaded to Amazon s3 during MSML call recording. When set to 'false', MCP would restrict access to the uploaded file to the s3 bucket owner only and when set to 'true', MCP would allow public download access to the uploaded recording file. Note that if both primary recording destination(recdest) and secondary recording destination(recdest2) are configured to use s3 URI format(s3:bucketname) then MCP would grant the same access permissions(depending upon the configuration value of this parameter) 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.