Gets the penetration rate of a given contact list, given a set of criteria defining the method of defining a penetrated record.

Namespace: ININ.IceLib.Dialer.Supervisor
Assembly: ININ.IceLib.Dialer (in ININ.IceLib.Dialer.dll) Version: 0.0.0.0 (22.3.0.208)

Syntax

C#
public ContactListPenetration..::..ContactListPenetrationRate GetPenetrationRate(
	ConfigurationId connectionId,
	string table,
	DateTime startDateTime,
	DateTime endDateTime,
	List<string> campaigns,
	List<CampaignDialingMode> callingModes,
	string phoneNumberColumn,
	List<string> wrapupCodes,
	PenetrationRateCalculationMode penetrationCountType,
	List<int> uploadIds
)
Visual Basic
Public Function GetPenetrationRate ( _
	connectionId As ConfigurationId, _
	table As String, _
	startDateTime As DateTime, _
	endDateTime As DateTime, _
	campaigns As List(Of String), _
	callingModes As List(Of CampaignDialingMode), _
	phoneNumberColumn As String, _
	wrapupCodes As List(Of String), _
	penetrationCountType As PenetrationRateCalculationMode, _
	uploadIds As List(Of Integer) _
) As ContactListPenetration..::..ContactListPenetrationRate

Parameters

connectionId
Type: ConfigurationId
The connection ID
table
Type: System..::..String
The name of an existing contact list table in the database pointed to by connectionId.
startDateTime
Type: System..::..DateTime
The starting DateTime value that will be used as a filter.
endDateTime
Type: System..::..DateTime
The ending DateTime value that will be used as a filter.
campaigns
Type: System.Collections.Generic..::..List<(Of <(<'String>)>)>
A list of campaigns to restrict the penetration count based on attempts done with these campaigns. If the list is empty or null, then it will take all attempts from any campaign into account.
callingModes
Type: System.Collections.Generic..::..List<(Of <(<'CampaignDialingMode>)>)>
A list of calling modes to restrict the penetration count based on attempts done with these calling modes. If the list is empty or null, then it will take all attempts from any calling mode into account.
phoneNumberColumn
Type: System..::..String
The phone number column to use to determine the penetration of the contact list. If the string is empty or null, then it will use the total contacts instead of restricting per Phone Number Column.
wrapupCodes
Type: System.Collections.Generic..::..List<(Of <(<'String>)>)>
A list of wrapup codes to restrict the penetration count based on dispositions made on attempts with these wrapup codes. If the list is empty or null, then it will take all attempts from any wrapup code into account.
penetrationCountType
Type: ININ.IceLib.Configuration.Dialer.DataTypes..::..PenetrationRateCalculationMode
The type of calculation used to determine the penetration rate.
uploadIds
Type: System.Collections.Generic..::..List<(Of <(<'Int32>)>)>
A list of penetration upload IDs. This is a required parameter and may not be null.

Return Value

The contact list penetration rate, the number of records penetrated and the total number of records available for the calculation.

See Also