Nortel CTI ToolKit, User Manual

Page: 38 / 108

PeriProducer CTI Toolkit User’s Guide for M1
Page 38 Nortel Networks Confidential # P0606089 Ver: 1.1
The SetWaitEvent , SetIgnoreEvent and SetCtiCondEvent functions can
be performed for the any of the available events:
AgentEvents
,
All
,
CallData
,
Dequeued
,
CallCleared
,
CallEvents
,
Conferenced
,
Dialing
,
Forwarding
,
Held
,
Established
,
LoggedOff
,
LoggedOn
,
NotReady
,
Queued
,
Ready
,
Retrieved
,
Ringing
,
RouteRequest
,
ServiceComplete
,
ServiceInitiated
,
Transferred
,
WorkNotReady
, and
WorkReady
.
The following is important information pertaining to the use of the Set Event
Handling block:
• The Set Event Handling block is often used to synchronize the application
and the Answer block with CSVAPI. Many of the Example Applications
listed in Appendix A show how this block can be used to wait for the call to be
established after the application "falls out" of the Answer block. Depending
on the situation, the waiting event could also be ringing, which allows all
other subsequent data or telephony requests to the CTI resource to function
properly.
• It is generally best if the first use of Set Event Handling in the application
ignores all events, thus clearing the wait conditions of anything leftover from
a previous call.
• The CTI resource must be obtained via the CTI Initialize block (see page 32 )
before Set Event Handling is executed.
• Depending on the parameter specified in the
Application Event Handling
field, the application may receive either a
vrto
or
cticond
condition. The
application can either ask CSVAPI to send a
CTI
condition when it receives a
particular event or (as is usually done) the application waits until a needed
event occurs or until the
vpsrcvtime
value times out with a
vrto
error. If
a
CTI
condition is used, the application must handle the condition
appropriately. Handling of conditions is essential if
SetCTICondEvent
is
specified in the Application Event Handling field.
• The CTI.status parameter is set to 0 if the request is successful and set to 1 if
the request fails.
• In the event that an application’s request comes to the VAPI before it receives
any events from the switch, synchronize the application’s requests with the
call’s events by doing the following:
a. Answer the call.
b. Get CTI resources.
c.
Use
SetWaitEvent
on an Established event.
d. Retrieve the
EventData
or perform the
AttachData
.
• SetWaitEvent is useful when the applicaiton’s execution has to be
synchronized with events. The application’s execution will pause at this block
until it is notified that the event occurred (or until a condition occurs). For
example:
• If the application is setting an Agent to a Ready state using the Agent