name: Required. The name of the campaign. See
Shared Parameters.
description: Optional description for the campaign. See
Shared Parameters.
linesPerAgent: The number of lines dedicated to each agent in the campaign. Range is 1 to 100. Default is 1.5. This parameter performs as follows in the Outbound Option dialing modes:
Preview mode: Ignored (always 1).
Progressive mode: Used as defined.
Predictive mode: Used as an initial value.
maximumLinesPerAgent: The upper bound for the number of customers the dialer dials for a reserved agent when a campaign is running in predictive mode. Range is 1 to 100. Default is 2.
abandonEnabled: True or false. Default is true.
abandonPercent: When enabled (abandonEnabled is set to true), you can set the abandoned calls limit for the percentage of abandoned calls in the campaign. When disabled (abandonEnabled is set to false), the campaign dials without regard to the abandon limit. Range is 1 to 100. The granularity is to one 10th of a percent. Default is 3.
predictiveCorrectionPace: A count of the number of live voice connections that must occur before the Dialer adjusts. Increasing this number results in less frequent adjustments based on larger sample size. Decreasing this number results in more frequent adjustments using a smaller sample size. Range is 10 to 5000. Default is 70.
predictiveGain: The size of the adjustment to lines per agent each time an adjustment is made. Increasing this number results in larger lines per agent adjustments. Decreasing this number results in smaller lines per agent adjustments. Range is 0.1 to 3.0. Default is 1.
noAnswerRingLimit: The number of times the software allows a dialed phone number to ring. Range is from 2 to 10. Default is 4.
maxAttempts: The maximum number of attempts, including callbacks and retries. Range is from 1 to 100. Default is 3.
minimumCallDuration: Minimum duration (in seconds) of an outbound call. If the outbound call is less than the specified value, Outbound Option considers the call to be customer abandoned and schedules the record for a retry. To disable this feature, set the parameter to 0. Range is 0 to 10. Default is 1.
noAnswerDelay: The time (in minutes) that the software waits before calling back a no-answer call. Range is 1 to 99999. Default is 60.
busySignalDelay: The time (in minutes) that the software waits before calling back a busy phone number. Range is 1 to 99999. Default is 60.
customerAbandonedDelay: If a customer abandons a call, the time (in minutes) that the Dialer waits before calling the customer back. Range is 1 to 99999. Default is 30.
dialerAbandonedDelay: If the Dialer abandons a call, the time (in minutes) that the Dialer waits before calling the customer back. Range is 1 to 99999. Default is 60.
answeringMachineDelay: If an answering machine answers a call, the time (in minutes) that the Dialer waits before calling the customer back. Range is 1 to 99999. Default is 60.
customerNotHomeDelay: If a customer is not home, the time (in minutes) that the Dialer waits before calling the customer back. Range is 1 to 99999. Default is 60.
personalizedCallbackEnabled: If enabled, this parameter allows an agent to schedule a callback to a customer for a specific date and time. A personal callback connects the same agent who initiated the callback to the customer. True or false. Default is false.
rescheduleCallbackMode: Determines how Outbound Option handles a personal callback if the agent is not available. Default is useCampaignDN. Options are as follows:
campaignPurposeType: The type of campaign. Default is agentCampaign. The options are as follows:
ipAmdEnabled: When enabled, directs the Dialer to perform a specific action if it detects an answering machine. True or false. Default is true.
amdTreatmentMode: If enabled (ipAmdEnabled is set to true), when the Dialer detects an answering machine, it does one of the following:
ipTerminatingBeepDetect: When this parameter is set to true, the Dialer transfers the call after detecting the answering machine beep. True or false. Default is false.
timeZone: Required. The refURL and display name for the selected time zone. The default time zone is UTC (Universal Coordinated Time). The display name is the text that may be displayed in a user interface and can be localized.
Note |
If time zone information changed due to periodic updates and the campaign's configured time zone is no longer valid, the following information is returned:
<timeZone>
<refURL>/unifiedconfig/config/timezone/INVALID</refURL>
<displayName>INVALID Time Zone</displayName>
</timeZone>
|
startTime: The time the campaign starts dialing customer numbers. The format for this parameter is hours:minutes. Range is from 00:00 to 23:59. The default value is taken from the Blended_Agent_Options table column values for DialStartHours and DialStartMinutes.
endTime: The time the campaign stops dialing customer numbers. The format for this parameter is hours:minutes. Range is from 00:00 to 23:59. The default value is taken from the Blended_Agent_Options table column values for DialEndHours and DialEndMinutes.
enabled: Whether the dialer is available to call contacts. True or false. Default is false.
startDate: The date that the campaign starts. The format is YYYY-MM-DD.
endDate: The date that the campaign ends. The format is YYYY-MM-DD.
campaignPrefix: Digits to prefix to each customer number dialed from this campaign. Maximum length of 15 digits.
dialingMode: The dialing mode to use for the campaign skill groups. Valid values are as follows:
INBOUND
PREDICTIVEONLY
PREVIEWONLY
PROGRESSIVEONLY
PREVIEWDIRECTONLY
reservationPercentage: The percentage of agents to reserve within the skill groups associated with the campaign. Range is from 0 to 100. Default is 100.
callProgressAnalysis: A collection of parameters for Call Progress Analysis (CPA). Any combination of parameters within this collection can be set. If none of the parameters are provided and CPA is enabled for the campaign by default, CPA recording is set to false and default parameter values are set from the Blended_Agent_Options table.
enabled: When set to false, CPA for all calls made from this Dialer is disabled on a campaign-by-campaign basis, including voice detection, fax/modem detection, and answering machine detection. True or false. Default is true.
record: If enabled is set to true, you can specify this parameter. If you set it to true, the gateway provides a media stream and the Dialer records .wav files. True or false. Default is false.
minSilencePeriod: The minimum silence period (in milliseconds) required to classify a call as voice detected. If many answering machine calls are being passed through to agents as voice, then increasing this value accounts for longer pauses in answering machine greetings. Range is from 100 to 1000. Default is 608.
analysisPeriod: The number of milliseconds spent analyzing this call. If there is a short agent greeting on an answering machine, then a longer value categorizes that answering machine call as voice. If the call is to a business where the operator has a longer scripted greeting, a shorter value categorizes the long, live greeting as an answering machine call. Range is from 1000 to 10000. Default is 2500.
minimumValidSpeech: Minimum number of milliseconds of voice required to classify a call as voice detected. Range is 50 to 500. Default is 112.
maxTimeAnalysis: The maximum number of milliseconds allowed for analysis before identifying a problem analysis as dead air/low volume. Range is 1000 to 10000. Default is 3000.
maxTermToneAnalysis: The maximum number of milliseconds the dialer analyzes an answering machine voice message looking for a termination tone. If the message has an odd tone and the analysis does not recognize it, the call is not transferred or dropped until this timeout occurs. Range is 1000 to 60000. Default is 30000.
skillGroupInfos: A collection of information about the skill groups associated with the campaign.
skillGroupInfosAdded: A collection of skill group references
to be added to the campaign, including the skill group refURL. This parameter is update only. This parameter can be used with
the skillGroupInfosRemoved parameter. See
References.
skillGroupInfosRemoved: A collection of skill group references
to be removed from the campaign, including the skill group refURL of each skill group. This parameter is update only. This parameter can be used with
the skillGroupInfosAdded parameter. See
References.