Lucent Technologies DEFINITY Enterprise Communications Server Release 5, CallVisor, ASAI Protocol Reference Instructions Manual

							Common Capabilities
Issue 6  June 1997
2-15
Non-Call Related Event Reports
Logout Event Report
The ECS sends the Logout Event Report on a Domain (Split) Control Association.
The ECS sends a FACility message with an invoke FIE containing:
Operation Value = Event Report 
a logout event (Specific Event IE) 
the split (Domain IE), 
the agent’s physical extension
4 (Domain IE), 
[the agent’s logical extension4] (Domain IE), and
[reason code5] (Domain IE).
For coding, see ‘‘Logout Event Report — Domain (ACD Split/Skill) Control 
Association’’ on page 5-31 of Chapter 5, “Byte Level Messages.”
Login Event Report
The ECS sends the Login Event Report on a Domain (Split) Control Association.
The ECS sends a FACility message with an invoke FIE containing:
Operation Value = Event Report 
a login event (Specific Event IE) 
the split (Domain IE), 
the agent’s physical extension
4 (Domain IE), 
[the agent’s logical extension4] (Domain IE), and
work mode (Domain IE). 
For coding, see ‘‘Login Event Report — Domain (ACD Split/Skill) Control 
Association’’ on page 5-29 of Chapter 5, “Byte Level Messages.”
4. In an EAS environment, both the logical and physical extension are provided. In an ACD 
environment, only the physical extension is provided.
5. This IE is included only if the System-Parameters Feature field, Logout Reason Codes is 
“forced” or “requested” and the agent is logging out with a valid reason code (1 to 9). 
						

							Messaging Sequences and ASAI
2-16Issue 6  June 1997 
Third Party Control Associations
The ECS provides three types of Third Party control associations:
1. Call Control, which monitors and controls all parties on a specified call
2. Third Party Domain (Station) Control, which monitors all calls at a specific 
station and allows control of the station only
3. Third Party Domain (ACD Split) Control, which monitors logout events for 
all agents in a given split
These control capability groups encompass call feedback event reports and call 
control operations (although, as Table 2-2 shows, there are different subsets).
Table 2-2. Use of Call Control Capabilities in Third Party Associations
Call Control CapabilityDomain 
(Station)
Control Call ControlDomain 
(Split) 
Control
Third Party Make Call (I) no yes no
Third Party Take Control (I) no yes no
Domain Control Request (I) yes
(Extension)no yes
(ACD split)
Third Party Auto Dial yes no no
Third Party Drop yes yes no
Third Party Hold yes yes no
Third Party Merge yes yes no
Third Party Reconnect yes yes no
Third Party Answer yes no no
Redirect Call yes yes no
Send DTMF Digits yes yes no
Third Party Call Ended/RELease COMplete (T) no yes no
Third Party Clear Call (T) no yes no
Third Party Relinquish Control (T) yes yes yes
Domain Control Ended (T) yes no yes
Third Party Selective Disconnect no yes no
Third Party Selective Reconnect no yes no
(I) is an initiating capability
(T) is a terminating capability 
						

							Call Control Association
Issue 6  June 1997
2-17
These procedures provide descriptions of the messaging procedures.
Call Control Association
A Call Control association allows an adjunct to control all the endpoints on a call 
using those Call Control capabilities shown in Table 2-2. Call control includes: 
establishing a call, taking control of an existing call, controlling a call, and the call 
feedback (event reports) that the ECS provides about a controlled call.
Initiating a Call Control Association
An adjunct begins a Call Control association and obtains control of a call when it:
1. Invokes the ASAI Third Party Make Call capability to set up a call
2. Invokes the ASAI Third Party Take Control capability to obtain control of an 
existing call 
Call Control and Event Reporting on a Call
Control Association
Once the association has been successfully established, the ECS designates the 
associated call as an adjunct-controlled call and thereby provides call feedback 
event reports. During the time the Call Control association exists, the adjunct can 
request Call Control operations.
The ECS terminates the association when the call terminates; the adjunct may 
use Third Party Relinquish Control to terminate the association when it no longer 
needs to control the call.
Termination of a Call Control Association
Either the adjunct or the ECS may terminate a Call Control association.
Three ways an adjunct can terminate such associations are as follows:
nUse the Third Party Clear Call procedure. This disconnects all parties from 
the call and terminates the association.
nUse the Third Party Relinquish Control procedure. This does not dismantle 
the call. The ECS continues normal processing of the call although adjunct 
control of the call (and call feedback) is terminated.
nSend RELease COMplete. For coding, see ‘‘Call Control: Normal Clearing 
Terminates Call Control Association’’ on page 5-67 of Chapter 5, “Byte 
Level Messages.” 
						

							Messaging Sequences and ASAI
2-18Issue 6  June 1997 
The ECS terminates a Call Control association in two ways:
1. If the call terminates and the ECS frees call-associated resources, then the 
ECS invokes the Call Ended capability. For coding, see ‘‘Third Party Call 
Ended — Association Terminates’’ on page 5-66 of Chapter 5, “Byte Level 
Messages.”
2. An internal ECS audit detects that ECS resources are allocated for Call 
Control of a call that no longer exists. If the ECS detects that such an 
association exists, the ECS sends a RELease COMplete containing an 
invoke FIE with:
an Operation Value = Abort and 
a cause indicating that an on-PBX switch audit terminated the
association.
For coding, see ‘‘Call Control: Internal switch Audit Finds Stale Call Control 
CRV’’ on page 5-65 of Chapter 5, “Byte Level Messages.”
If the adjunct uses RELease COMplete to terminate a Call Control association for 
an active, stable call, the ECS 
does not disconnect the call. Rather, the ECS 
terminates the ability of the adjunct to control that call (this is the same as 
relinquish control).
In addition, either the ECS or adjunct may send a RELease COMplete message 
with an abort operation value to terminate a Call Control association.
ASAI considers both the Third Party Relinquish Control and the more efficient 
RELease COMplete to be normal termination of the association. Both have the 
same effect within the ECS.
In general, if the ECS receives any RELease COMplete message for a Call 
Control association, the ECS continues to process the call normally. The 
exception to this occurs when the ECS receives any RELease COMplete 
message on a Call Control association for a switch-classified call while the call is 
in the classification stage (for example, has not yet been classified). In this case, 
the ECS dismantles the corresponding call on receipt of the RELease COMplete 
message.
Third Party Make Call —
Initiating Procedure
The Third Party Make Call procedure includes the following sequence of 
messages:
1. The adjunct sends a REGister message to begin a Call Control association 
on a call reference value. The message contains:
an invoke FIE, 
an invoke identifier, 
Operation Value = third party make call, and parameters for: 
originating address (Calling Party IE),  
						

							Call Control Association
Issue 6  June 1997
2-19
destination address (Called Party IE), 
[Service Circuit = call classifier] (Service Circuit IE), 
[number of rings before destination “no-answer” classification] 
(Call options IE), 
[alerting order] (Call options IE), 
[priority] (Call options IE), 
[supervisor assist flag] (Call options IE), 
[trunk access code or ARS/AAR digits] (Domain IE), 
[trunk access code] (Domain IE), 
[direct agent call flag] (Call Options IE), 
[answer machine detection] (Call Options IE), 
[ACD split extension for direct-agent call] (Domain IE),
6
[return_ack flag if the optional “proceed” is desired] (Call Options IE), 
and [User-to-User Information] (User-User IE).
The Trunk Access Code in the Domain IE may contain either a TAC or 
ARS/AAR digits. TAC or ARS/AAR may optionally be included in the 
destination address. For coding, see ‘‘Third Party Make Call Request’’ on 
page 5-39 of Chapter 5, “Byte Level Messages.”
2. If ECS provisioning permits the ECS to accept the adjunct’s request and 
the adjunct has included the 
return_ack flag in the request, then once the 
ECS originates the call and assigns a call_id, the ECS sends a FACility 
message to acknowledge the request. The message contains an invoke 
FIE with Operation Value = Proceed, the extension of the phone originating 
the call (Connected Number IE), the party_id of the originator (Party ID IE), 
and the call_id of the call (Call ID IE). For coding, see ‘‘Acknowledgment of 
Third Party Make Call Request’’ on page 5-55 of Chapter 5, “Byte Level 
Messages.”
3. Various sequences of event reports and adjunct requests for call control 
may occur. In terms of the message procedure, the event reporting and call 
control are a sequence of FACility messages flowing across the interface. 
The call control procedures section details the messages for each call 
control procedure.
4. The ECS continues to send the adjunct events about the call. The adjunct 
may continue to request call control operations.
5. The association terminates when the ECS or adjunct takes any of the 
actions described in “Termination of a Call Control Association” earlier in 
this chapter.
6. The ACD split extension for a direct-agent call must be present when direct-agent flag is 
also present. When these two parameters are present, the destination address must not be 
a logical agent extension. 
						

							Messaging Sequences and ASAI
2-20Issue 6  June 1997 
Third Party Take Control —
Initiating Procedure
The adjunct uses this capability to take control of a call for future Call Control 
operations. The adjunct must have learned about the call, which could have been 
initiated manually, from an event report or query. The event reports and certain 
query responses include a call identifier that the adjunct may later use as a 
parameter in a Third Party Take Control request to create a new Call Control 
association.
When the adjunct uses Third Party Take Control to take control of a call that was 
once offered to an active notification split or vector domain, the ECS sends the 
event reports for the call over both the call control association and the request 
notification association. The adjunct receives duplicate event reports about a call 
unless it uses the Stop Call Notification capability to cease the event reporting for 
that call on the Notification Association.
1. The adjunct sends a REGister message to begin a Call Control association 
for the call on a new call reference value. The message contains an invoke 
FIE with:
an invoke identifier, 
Operation Value = Third Party Take Control, and 
an argument with a call identifier (Call Identity IE).
This REGister message allocates a CRV for a Call Control association over 
which the adjunct may send third party call control requests.
For coding, see ‘‘Third Party Take Control Request’’ on page 5-42 of 
Chapter 5, “Byte Level Messages.”
2. If the request is successful, the ECS replies with a FACility message 
containing a return result FIE with:
the invoke-id from the Take Control invocation, 
Operation Value = Take Control, 
a list of up to six party identifiers for the 
parties on the call (Party ID IE), and 
a list of up to six extensions of the parties 
on the call (Connected Number IE).
The FACility message does not close the association. The invoke-id in the 
return result has the same value as the invoke-id in the Third Party Take 
Control request. 
For coding, see ‘‘Acknowledgment of Third Party Take Control Request’’ 
on page 5-57 of Chapter 5, “Byte Level Messages.”
If the request is not successful, the ECS returns an error to terminate the 
new call control association. A RELease COMplete message carries this 
failure message. 
						

							Call Control Association
Issue 6  June 1997
2-21
Third Party Relinquish Control — 
Terminating Procedure
Third Party Relinquish Control terminates the association but does not disconnect 
the call. The association is terminated and the ECS stops sending the adjunct call 
feedback for the call. The ECS denies a relinquish control request for a 
switch-classified call in the process of being classified.
To relinquish control, the following messaging takes place:
1. The Adjunct sends a FACility message containing an FIE with an invoke 
component and Operation Value = Third Party Relinquish Control. For 
coding, see ‘‘Third Party Relinquish Control Request’’ on page 5-49 of 
Chapter 5, “Byte Level Messages.”
2. If the ECS accepts the relinquish control request, the ECS replies with a 
RELease COMplete message containing an FIE with a return result 
component. The invoke-id in the return result has the same value as the 
invoke-id in the Third Party Relinquish Control request. For coding, see 
‘‘Call Control: Acknowledgment — Association Terminates’’ on page 5-63 
of Chapter 5, “Byte Level Messages.” 
						

							Messaging Sequences and ASAI
2-22Issue 6  June 1997 
Domain (Station) Control Procedure
The Domain (Station) Control allows an adjunct to:
1. Monitor call-related events for all calls present at a specific station 
extension
2. Perform call control activity for that station extension (and only that station 
extension)
3. Initiate calls outbound from the station extension (and only that station 
extension)
The adjunct uses the Domain (Station) Control Request capability to initiate the 
association. While the association exists, the ECS sends the adjunct event reports 
about any call at that station. The adjunct may use the Auto Dial capability to 
establish a call within the existing Domain (Station) Control association and the 
adjunct may use selected call control capabilities to control calls within the 
association.
Domain (ACD Split) Control
The Domain (ACD Split) Control allows an adjunct to receive agent-related event 
reports for agents in the specified ACD split.
The adjunct uses the Domain Control Request capability to initiate an agent 
control association. While the associations exists, the ECS sends the adjunct 
agent login and agent logout reports. Table 2-2 earlier in this chapter shows the 
subsets of the control capabilities that are used on a Domain (ACD Split) Control 
Association.
Domain Control Request —
Initiating Procedure
The adjunct uses this capability to establish a domain (station or ACD split) control 
association. All call event reports on the domain (station) association include a 
call identifier that the adjunct may later use as a parameter in call control requests 
to specify the call being acted on at the controlled extension.
1. The adjunct sends a REGister message to begin a Domain (Station) 
Control association on a new call reference value. The message contains 
an invoke FIE with:
an invoke identifier, 
Operation Value = Domain Control, and
an argument with the number of the extension to be controlled or the 
extension number of the ACD split for agent related events
(Domain IE).
This REGister message allocates a CRV for a Domain (Station) Control 
association. For coding, see ‘‘Domain Control (Station/ACD Split)  Request’’ on 
page 5-70 of Chapter 5, “Byte Level Messages.” 
						

							Domain (Station) Control Procedure
Issue 6  June 1997
2-23
2. If the ECS accepts the Domain Control request, the contents of the 
acknowledgement depend on whether the domain control association is for 
a station or split:
nStation control acknowledgement:
a FACility message containing a return result FIE with:
the invoke-id in the control request, 
Operation Value = Third Party Domain (Station) Control, and
parameters containing a list of: 
[call_ids (Call Identifier IE)], 
[party_id of the principal’s extension on the call (Party ID IE)], 
and [the state of the principal’s extension on
the call (Specific Event IE)].
The contents of the above FIE are present if and only if calls are 
present at the station. If no calls are present, the contents of the 
response are the same as the acknowledgement for a domain 
control request. For coding, see ‘‘Acknowledgment of  Domain 
(Station) Control Request’’ on page 5-84 of Chapter 5, “Byte Level 
Messages.”
nAgent control acknowledgement:
a FACility message containing a return result FIE with:
the invoke-id in the control request
For coding, see ‘‘Domain Control: Acknowledgment (No 
Parameters) Association Continues’’ on page 5-89 of Chapter 5, 
“Byte Level Messages.”
3. If the request for Domain Control is unsuccessful, the ECS returns an error 
to terminate the new Domain Control association. A RELease COMplete 
message carries this failure message and the Domain Control association 
is not established.
Cancel Domain Control — Terminating Procedure
The adjunct terminates a Domain (Station) Control Association using the Third 
Party Relinquish Control capability in exactly the same way as it uses that 
capability to terminate a Call Control association.
Domain Control Ended — Terminating Procedure
The ECS uses this capability to terminate a Domain (Station/ACD Split) Control 
association. The ECS ends the Domain (Station/ACD Split) Control when, for 
example, the ECS administrator removes the controlled extension or ACD split 
domain from the ECS translation.
The ECS sends a RELease COMplete message to terminate the association. The 
message contains an invoke FIE with: 
						

							Messaging Sequences and ASAI
2-24Issue 6  June 1997 
Operation Value = Domain Control Ended, and 
a cause (Cause IE).
For coding, see ‘‘switch Ends Domain (Station) Control Association’’ on page 5-94 
of Chapter 5, “Byte Level Messages.”
Auto Dial Procedure
The adjunct can use the Auto Dial procedure over an existing Domain (Station) 
Control association to begin an outbound call for the controlled extension. The 
ECS reports event reports for the call within the existing Domain (Station) Control 
association and the adjunct may invoke call control operations for the call also 
within the Domain (Station) Control association.
The ECS sends a Call Initiated Event Report when the user goes off-hook and the 
ECS allocates a call_id that is subsequently used for the call. The station user 
may go off-hook/idle before the adjunct sends the Auto Dial request. The Call 
Initiated Event Report contains the call_id for the resulting call.
 The auto dial procedure includes the following sequence of messages:
1. The adjunct sends a FACility message on an existing extension control 
association. The message contains:
an invoke FIE, 
an invoke identifier, 
Operation Value = AUTO DIAL, 
and parameters for: 
[trunk access code (Domain IE)], 
destination address (Called Party IE), 
[priority] (Call options IE), 
[
return_ack flag if the optional “proceed” is desired] (Call Options IE),
and [User-to-User Information] (User-User IE).
For coding, see ‘‘Third Party Auto Dial Request for an Extension’’ on page 
5-77 of Chapter 5, “Byte Level Messages.”
The Trunk Access Code in the Domain IE may also optionally contain either 
TAC or ARS/AAR digits, or these can be in the called number. USE OF 
THE RETURN-ACK OPTION IS NOT RECOMMENDED.
2. If the ECS accepts the Auto Dial request and the adjunct has included the 
return_ack flag in the request, then once the ECS originates the call and 
assigns a call_id, the ECS sends a FACility message to acknowledge the 
request. The message contains an invoke FIE with:
Operation Value = Proceed, 
the call_id (call Identity IE) of the resulting call, and 
the party_id of the originator (Party ID IE).
For coding, see ‘‘Acknowledgment of  Third Party Auto Dial Request’’ on 
page 5-86 of Chapter 5, “Byte Level Messages.”