Dialer_OutDialQueAdd
|
VoiceGuide COM
Reference
|
Adds a new entry to Dialer's
OutDialQue database.
The call will be
made as outgoing lines become available, and the time before the
call is made may depend on how many other entries are currently
loaded in the OutDialQue database. No
return information about when the call will be actually made is
provided when this function returns.
If no other
entries are in the OutDialQue database
and there are outgoing lines available then the call will be made
immediately.
Please not
that the parameters I this function have changed from VoiceGuide v6
to VoiceGuide v7.
Syntax
v7
object.Dialer_OutDialQueAdd
sPhoneNumber, sPhoneNumberPrefix, sActivateTime, sDayTimeStart, sDayTimeStop, sDaysCallAllowed, sLineSelection, sCampaignName, iPriority, sOnAnswerLive, sOnAnswerMachine, sFaxToSend, sOnNotAnswered, sOnRetriesExhausted, iAnswerTimeout, iRetriesLeft, iRetriesDelay, sRV,
sCallOptions, sEscalationCalls
Syntax
v6
object.Dialer_OutDialQueAdd
sPhoneNumber, iActivateTime, iDayTimeStart, iDayTimeStop, sDaysCallAllowed, sLineSelection, iPriority, sAnnounceMessage, sOnAnswerLive, sAnswerMachineMsg, sRV,
iAnswerTimeout, iCallRetriesLeft, iDelayBetweenRetries, sOnNotConnected, sOptionsXml, sEscalationCalls
|
Part
|
Description
|
|
|
|
object
|
VoiceGuide object
|
|
|
|
sPhoneNumber
|
The telephone number to be
called
|
|
|
|
sPhoneNumberPrefix
|
Optional prefix dialed
before the telephone number.
|
|
|
|
ActivateTime
|
Date and Time when the call
should be made.
In v7 the time can be
specified as a string in any locally valid date/time format. This
format is recognized worldwide:
YYYY-MM-DD HH:NN:SS AM/PM the
AM/PM sign can be omitted if using
24-hout time notation. The
YMMDDHHNN format can also be
used.
In v6 the time can be
specified as a number in format
YMMDDHHNN.
|
|
|
|
DayTimeStart
|
Time of the day before which
the call to this number should not be made.
In v7 the time can be
specified as a string in any locally valid date/time format. This
format is recognized worldwide:
HH:NN:SS AM/PM the
AM/PM sign can be omitted if using
24-hout time notation. The
HHNN format can also be
used.
In v6 the time can be
specified as a number in format
HHNN.
eg: 8am
would be specified as the number 800. To allow this telephone
number to be dialed from midnight onwards set to 0
|
|
|
|
DayTimeStop
|
Time of the day after which
the call to this number should not be made.
In v7 the time can be
specified as a string in any locally valid date/time format. This
format is recognized worldwide:
HH:NN:SS AM/PM the
AM/PM sign can be omitted if using
24-hout time notation. The
HHNN format can also be
used.
In v6 the time can be
specified as a number in format
HHNN.
eg: 9pm
would be specified as the number 2100. To allow this telephone
number to be dialed at any time of day set to 0
|
|
|
|
sDaysCallAllowed
|
Days of the week when the
call can be made. Specify each day using the first two characters
of that day eg: to call on weekdays
only specify "MoTuWeThFr". If not used
(ie: can call on all days) set to empty
string ""
|
|
|
|
sLineSelection
|
If the outbound call may
only be made on particular phone lines then these lines should be
listed in this setting. Line IDs may be specified as a comma
delimited list of "LineIDs"
(eg: 6,7,8) or using XML notation,
(eg: <LineId>2</LineId><LineId>3</LineId>)or specified as a comma
delimited list of the Dialogic line identifiers (eg: dxxxB1C2,dxxxB1C3).
If left blank
then any available lines will be used.
|
|
|
|
sCampaignName
|
Campaign name associated
with this call. Used for users own categorizing of calls. Can be
left as an empty string.
|
|
|
|
iPriority
|
At what priority level the
calls should be made. A lower number indicates a higher priority.
ie: 1 is the
highest priority, then 2, then 3 ... etc. Number of priority levels
is unlimited.
|
|
|
|
sOnAnswerLive
|
VoiceGuide script to run
when the call is answered by a real person.
|
|
|
|
sOnAnswerMachine
|
Sound file (or VoiceGuide
script) to be played if the call is answered by an answering
machine. The sound file will be played after the answering
machine's welcome message finishes. If not used set to empty string
""
|
|
|
|
sFaxToSend
|
.PDF/.TIF/.TIFF file to send, or VoiceGuide script to be started
immediately after dialing. If this setting specified then the
sOnAnswerLive and sOnAnswerMachine are effectively ignored, as
when sending fax the fax calling tone has to be sent immediately
after dialing. If not used set to empty string ""
|
|
|
|
sOnNotAnswered
|
.EXE/.COM/.BAT or .VBS
(VBScript) to run when the call has not been answered. If not used
set to empty string ""
|
|
|
|
sOnRetriesExhausted
|
.EXE/.COM/.BAT or .VBS
(VBScript) to run when the call has not been answered and there are
no more retries left. If not used set to empty string ""
|
|
|
|
iAnswerTimeout
|
How many seconds will the
Dialer wait for the call to be answered. Default value of 60 will
be used if this entry is set to 0
|
|
|
|
iCallRetriesLeft
|
How many more times will
the Dialer attempt to call this number if the next call is
unsuccessful. To only make one call attempt set to 0
|
|
|
|
iRetriesDelay
|
How many minutes will the
Dialer wait before attempting to call again. If not used set to
0
|
|
|
|
sRV
|
Result Variables which will
be available to the VoiceGuide script used on this call. If not
used set to empty string ""
|
|
|
|
sCallOptions
|
XML formatted
options string. If not used set to empty string ""
|
|
|
|
sEscalationCalls
|
Can be used to specify
multiple escalations levels. XML format is used to specify the
escalation calls. Please see the VoiceGuide's help file's section
on the ‘Out Dial’ file for details on the XML format used to
specify call details. If not used then set to empty string
"".
|
|
|
Remarks
Version 7
Examples:
Example
1
Straightforward
example.
set vg
= CreateObject("vgServices.CommandLink")
vg.Dialer_OutDialQueAdd
"ext1002@10.1.1.4", "", "2009-11-28 9:00:00 AM", "9:00 AM", "5:00
PM", "", "", "BookingConfirmCampaign", 1, "c:\ConfirmBooking.vgs",
"c:\CallBackDetails.wav", "", "c:\ifNotAnswered.vbs",
"c:\ifRetriesExhausted.vbs", 90, 2, 30, "[CustomerID]{44563}", "", ""
set vg = Nothing
Version 6
Examples:
Example
1
Straightforward
example.
set vg
= CreateObject("VoiceGuide.CommandLink")
vg.Dialer_OutDialQueAdd "0,5551234", 0,
0, 0, "", "", 1, "c:\sendinfo\announce.wav",
"c:\sendinfo\InfoMenu.vgs", "c:\sendinfo\CallBackDetails.wav", "",
90, 2, 5, "", "", ""
set vg = Nothing
Example
2
More advanced
example.
Note how
CStr() function
needs to be used around a variable which needs to be passed in as a
string and which is composed of numbers. If CStr() is not used VBScript will try to pass that
variable as a number instead of as a string, which will generate an
error.
Result
Variables which will be available to scripts ran when the call is
made are specified as well.
set vg
= CreateObject("VoiceGuide.CommandLink")
sTelNumber = "5551234"
vg.Dialer_OutDialQueAdd CStr(sTelNumber), 0, 0,
0, "", "", 1, "c:\sendinfo\announce.wav",
"c:\sendinfo\InfoMenu.vgs", "c:\sendinfo\CallBackDetails.wav",
"[CustomerID]{44563}", 90, 2, 5, "",
"", ""
set vg = Nothing
