Contents
SIP Cluster: Disable recording and monitoring for manual outbound calls
Starting with release 8.1.103.28, SIP Server can disable recording and monitoring for manual outbound calls in SIP Cluster deployments. This feature is only supported for TMakeCall requests made through a Routing Point and then routed to an external number.
Sample Call Flow
- An agent dials to an external number from a Workspace Web Edition (WWE) desktop.
- WWE translates the destination and submits a TMakeCall request.
- SIP Server receives the TMakeCall request and queues the call on the Routing Point.
- The strategy on the Routing Point issues a TRouteCall request containing make-call-cpd-required = true.
- SIP Server processes the call destination and routes the call to the Trunk Group DN. The agent is connected with the Trunk Group DN. This is similar to the engaging call in Active Switching Matrix (ASM) mode.
- SIP Server issues an internal TApplyTreatment request for playing standard music to the agent.
- SIP Server issues an internal TMakePredictiveCall request with the Call Progress Detection (CPD) extensions and the IVR profile to be selected.
- Once a called party is connected, SIP Server instructs a media server to perform the CPD. This is similar to the outbound call in ASM mode.
- After the CPD is completed, SIP Server issues TApplyTreatment to play the prepared IVR profile. This profile contains the VXML script that plays the recording or monitoring opt-out prompt and collects the user input on it.
- SIP Server merges both call parties by issuing TMergeCall.
- On the completion of the merge call process, the agent and called party are connected.
Feature Configuration
- Configure a
Trunk Group DN for CPD functionality in the SIP Cluster switch. In this Trunk Group DN, add the following configuration options:
- ivr-profile-name: the IVR profile that points to the VXML page responsible for a recording and monitoring opt out prompt.
- beep: whether to apply a beep tone before connecting the agent from the engaging call with the called party from the outbound call.
- predictive-call-timeout
- cpd-extensions
- Set the make-call-cpd-dn option to the Trunk Group DN (created in Step 1) on the Routing Point DN, where TMakeCall requests submitted by agents are queued.
- Set the make-call-cpd-required key extension to true in TRouteCall.
- If required, on the Trunk Group DN, set AnsMachine, FaxDest, and/or SilenceDest keys in the Extensions attribute of TMakePredictiveCall requests. For this feature, a value of connect (in addition to drop) is supported. These keys override respective Application-level configuration options: am-detected, fax-detected, silence-detected.
AttributeExtensions
Key: make-call-cpd-required
Type: String
Valid Values: true, false
Request: TRouteCall
Specifies whether SIP Server applies CPD functionality to the specified TRouteCall destination.
- If set to true, SIP Server applies CPD functionality to the specified TRouteCall destination by converting this request to the Active Switching Matrix (ASM) mode call flow.
- Note: Genesys recommends setting the UseDialPlan extension to agentid when make-call-cpd-required is set to true. SIP Server connects an agent with the configured Trunk Group DN and for the specified destination CPD is done through TMakePredictiveCall. Thus, the dial plan will not be required and only an agent ID provided by SIP Feature Server is added to the response.
- If set to false, SIP Server performs the routing request and no CPD functionality is applied.
If this extension is not specified, then CPD functionality is not applied.
Configuration Options
make-call-cpd-dn
Section: [TServer]
Default Value: An empty string
Valid Values: Any Trunk Group DN
Changes Take Effect: For the next call
When this option is set to a valid Trunk Group DN, SIP Server invokes CPD functionality for the call routed to an external number. The call is queued on a Routing Point when a TMakeCall request is made by an agent.
This option can be configured on the Routing Point DN in the SIP Cluster switch. Or, this option can be specified in the SIP Cluster DN (DN with service-type set to sip-cluster-nodes) to apply to all Routing Point DNs under a SIP Cluster switch. The Routing Point DN setting takes precedence over the SIP Cluster DN setting.
ivr-profile-name
Section: [TServer]
Default Value: An empty string
Valid Values: Any valid IVR profile
Changes Take Effect: For the next call
Specifies the name of the IVR profile to be added in the Request-URI sent to the Media Server.
Sample URI format: sip:msml@<RM:FQDN>;media-service=cpd;gvp-tenant-id=<ivr-profile-name>
beep
Section: [TServer]
Default Value: on
Valid Values: on, off
Changes Take Effect: For the next call
When set to on, SIP Server applies a beep tone for the specified duration to the agent before processing the TMergeCall request. When set to off, SIP Server merges both the engaging and outbound call without playing any beep tone.
predictive-call-timeout
Section: [TServer]
Default Value: 20
Valid Values: 0-1800
Changes Take Effect: For the next call
Specifies, in seconds, the value to be included as an AttributeTimeout value in the TMakePredictiveCall request. If this timeout expires before the call is answered, or if SIP Server receives a BYE message from the Media Server, SIP Server terminates the call.
This AttributeTimeout value is applied only when the predictive-timerb-enabled option is set to false in the Trunk Group DN. When predictive-timerb-enabled is set to true, SIP Server uses the 32-second timer and ignores the timeout specified in this option.
cpd-extensions
Section: [TServer]
Default Value: An empty string
Valid Values: A comma-separated key-value pairs of TMakePredictiveCall without spaces
Changes Take Effect: For the next call
Specifies CPD-related AttributeExtensions to be included in TMakePredictiveCall. SIP Server applies default values to the non-configured extensions. For example:
cpd-record=on,call_answer_type_recognition=positive_am_detection,cpd-on-connect=off,call_timeguard_timeout=2000, AnsMachine=connect,FaxDest=drop,SilenceDest=drop
CPD AttributeExtensions
Key: cpd-record
Type: String
Default Value: off
Valid Values: on, off
Request: TMakePredictiveCall
Key: call_answer_type_recognition
Valid values : no_progress_detection , no_am_detection , positive_am_detection ,full_positive_am_detection, accurate_am_detection, telephony_preset
Default value : positive_am_detection
Key: cpd-on-connect
Valid values : on/off
Default value : off
Key: call_timeguard_timeout
Valid values : Time in msec
Default value : 3000
Key: AnsMachine
Valid values : connect, drop
Key: FaxDest
Valid values : connect, drop
Key: SilenceDest
Valid values : connect, drop
Feature Limitations
- This feature supports only direct outbound calls made by an agent to an external destination through TMakeCall requests.
- Outbound calls to an external destination through T-Library requests—OneStepConference, InitConference, OneStepTransfer, InitTransfer—are not supported.
- If a Trunk Group is configured with 'call_answer_type_recognition=no_progress_detection', then cpd analysis won't be done but still SIP Server generates TApplyTreatment to play the prepared IVR profile. Such configuration in Trunk Group is considered as error/misconfiguration since this feature is meant for providing cpd analysis to outbound calls.