Revision as of 00:35, January 24, 2017 by Valentip (talk | contribs) (Example)
Jump to: navigation, search

Call-Handling and Transfer/Conference Events

EventDialing

Event Description

An attempt to make a call on behalf of the telephony object specified by ThisDN is in progress.

EventDialing Contents

Event Attribute

Type

AgentID

Optional

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallTypea

Mandatory

ConnID

Mandatory

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDNb

Optional

OtherDNRoleb

Optional

OtherQueue

Optional

OtherTrunk

Optional

PreviousConnIDc

Optional

Reasons

Optional

ReferenceID

Optional

Server

Mandatory

ThisDN

Mandatory

ThisDNRole

Mandatory

ThisQueued

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a CallType may be Unknown.
b OtherDN may be either a dialed number or not present if T-Server has no information about the other party. OtherDNRole appears if the attribute OtherDN is present.
c PreviousConnID must appear if the value of CallType is Consult.
d ThisQueue must appear in predictive dialing and be equal to ThisDN.

Examples

See the example after EventRinging.

EventRinging

Event Description

A call has been delivered to the telephony object specified by ThisDN.

EventRinging Contents

Event Attribute

Type

AgentID

Optional

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallState

Mandatory

CallType

Mandatory

ConnID

Mandatory

CollectedDigits

Optional

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDN

Optional

OtherDNRole

Optional

OtherQueue

Optional

OtherTrunk

Optional

PreviousConnIDa

Optional

Reasons

Optional

ReferenceID

Optional

Server

Mandatory

ThisDN

Mandatory

ThisDNRole

Mandatory

ThirdPartyDN

Optional

ThisQueueb

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a The attribute must appear if the value of CallType is Consult.
b The attribute must appear in case of an ACD call.

Example

EventRinging Feature Example

EventEstablished

Event Description

For the application associated with the calling party: the telephony object specified by OtherDN has answered (either the calling party answered or the switch simulated an answer if option auto-answer is set on the switch) and the connection has been established. For the application associated with the called party: the call associated with ConnID has been established.

EventEstablished Contents

Event Attribute

Type

Event

Mandatory

Server

Mandatory

CustomerID

Optional

ReferenceID

Optional

ConnID

Mandatory

PreviousConnIDa

Optional

CallID

Mandatory

CollectedDigits

Optional

CallHistory

Optional

CallType

Mandatory

CallState

Optional

AgentID

Optional

ThisDN

Mandatory

ThisQueue

Optional

ThisDNRole

Mandatory

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDN

Optional

OtherTrunk

Optional

OtherQueue

Optional

OtherDNRole

Optional

DNIS

Optional

ANI

Optional

UserData

Optional

Reasons

Optional

Extensions

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

a The attribute must appear if the value of CallType is Consult.

EventAbandoned

Event Description

The caller abandoned the call before it was answered.

EventAbandoned Contents

Event Attribute

Type

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallState

Mandatory

CallType

Mandatory

ConnID

Mandatory

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

PreviousConnIDa

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDN

Optional

OtherDNRole

Optional

OtherQueue

Optional

OtherTrunk

Optional

Server

Mandatory

ThisDN

Mandatory

ThisDNRole

Mandatory

ThisQueueb

Optional

ThisTrunk

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a The attribute must appear if the value of CallType is Consult.
b The attribute must appear in case of an ACD call.

EventDestinationBusy

Event Description

The called party specified by OtherDN is busy with another call.

EventDestinationBusy Contents

Event Attribute

Type

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallStatea

Optional

CallType

Mandatory

ConnID

Mandatory

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDN

Optional

OtherQueue

Optional

OtherTrunk

Optional

PreviousConnIDb

Optional

Server

Mandatory

ThisDN

Mandatory

ThisDNRole

Mandatory

ThisQueue

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a For scenarios initiated with RequestMakeCall, this attribute may have values that clarify the reason for the destination being busy, for instance CallStateSitInvalidNum.
b The attribute must appear if the value of CallType is Consult.

EventDiverted

Event Description

The call has been diverted from the queue to another telephony object.

EventDiverted Contents

Event Attribute

Type

CallHistory

Optional

CallID

Mandatory

CallState

Mandatory

CallType

Mandatory

ConnID

Mandatory

CollectedDigits

Optional

CustomerID

Optional

Event

Mandatory

Extensions

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDN

Optional

OtherDNRole

Optional

OtherQueue

Optional

OtherTrunk

Optional

PreviousConnIDa

Optional

Server

Mandatory

ThirdPartyDNb

Optional

ThirdPartyDNRole

Optional

ThirdPartyQueueb

Optional

ThisDNc

Mandatory

ThisDNRole

Mandatory

ThisQueuec

Mandatory

ThisTrunk

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a The attribute must appear if the value of CallType is Consult.
b Attributes must be present if the value of CallState is Redirected. (See Redirect-Call Service) In all other call scenarios, ThirdPartyDN must be present only if such information is provided by a CTI link.
c These attributes must be equal.

EventHeld

Event Description

The call has been placed on hold.

EventHeld Contents

Event Attribute

Type

AgentID

Optional

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallType

Mandatory

ConnID

Mandatory

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDN

Optional

OtherDNRole

Optional

OtherQueue

Optional

OtherTrunk

Optional

PreviousConnIDa

Optional

Reasons

Optional

ReferenceID

Optional

Server

Mandatory

ThisDN

Mandatory

ThisDNRole

Mandatory

ThisQueue

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a The attribute must appear if the value of CallType is Consult.

EventNetworkReached

Event Description

The call has reached the public network interface.

EventNetworkReached Contents

Event Attribute

Type

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallType

Mandatory

ConnID

Mandatory

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDN

Optional

OtherDNRole

Optional

OtherTrunk

Optional

PreviousConnIDa

Optional

Server

Mandatory

ThisDN

Mandatory

ThisDNRole

Mandatory

ThisTrunk

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a The attribute must appear if the value of CallType is Consult.

EventPartyAdded

Event Description

One or more parties has been added to the call as a result of a conference. If only one party is added (as in the case of a simple conference call), the corresponding telephony object is specified in OtherDN.

If more than one party is added, then the corresponding telephony objects are specified in Extensions.

EventPartyAdded Contents

Event Attribute

Type

AgentID

Optional

ANI

Optional

CallHistory

Optional

CallState

Optional

CallType

Mandatory

ConnID

Mandatory

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDN

Optional

OtherDNRole

Optional

OtherQueue

Optional

OtherTrunk

Optional

Server

Mandatory

ThirdPartyDNa

Mandatory

ThirdPartyDNRolea

Mandatory

ThisDN

Mandatory

ThisDNRole

Mandatory

ThisQueue

Optional

ThisTrunk

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a This attribute is not present if the switch does not distribute it to T-Server.

EventPartyChanged

Event Description

The telephony object specified by OtherDN has replaced the telephony object specified by OtherDN in the previously received event; or the PreviousConnID of the call has been given a new value, ConnID.

EventPartyChanged Contents

Event Attribute

Type

AgentID

Optional

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallStatea

Mandatory

CallType

Mandatory

ConnID

Mandatory

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDNb

Optional

OtherDNRoleb

Optional

OtherTrunkb

Optional

PreviousConnID

Mandatory

Server

Mandatory

ThirdPartyc

Mandatory

ThirdPartyDNRoleb

Mandatory

ThisDN

Mandatory

ThisDNRole

Mandatory

ThisQueue

Optional

ThisTrunk

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a The value can be either Transferred or Conferenced. For more information, see Call Models and Flows.
b The attribute must not appear if the CallState is Conferenced.
c This attribute is not present if the switch does not distribute it to T-Server.

EventPartyDeleted

Event Description

The telephony object specified by OtherDN has been deleted from the conference call in question.

EventPartyDeleted Contents

Event Attribute

Type

AgentID

Optional

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallStatea

Mandatory

CallType

Mandatory

ConnID

Mandatory

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDN

Optional

OtherDNRole

Optional

OtherQueue

Optional

OtherTrunk

Optional

Reasons

Optional

ReferenceID

Optional

Server

Mandatory

ThirdPartyDN

Optional

ThirdPartyDNRole

Optional

ThisDN

Mandatory

ThisDNRole

Mandatory

ThisQueue

Optional

ThisTrunk

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

aThe attribute indicates whether a call is still considered as a conference (that is, the number of parties in the call is more than two).

EventQueued

Event Description

The call has been queued in the ACD group specified by ThisQueue.

EventQueued Contents

Event Attribute

Type

AgentID

Optional

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallState

Optional

CallType

Mandatory

CollectedDigits

Optional

ConnID

Mandatory

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

LastCollectedDigit

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDN

Optional

OtherDNRole

Optional

OtherQueue

Optional

OtherTrunk

Optional

PreviousConnIDa

Optional

Server

Mandatory

ThisDNb

Mandatory

ThisDNRole

Mandatory

ThirdPartyDN

Optional

ThisQueueb

Mandatory

ThisTrunk

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a The attribute must appear if the value of CallType is Consult.
b These attributes must be equal.

EventBridged

Event Description

Used in situations where Coverage Path is available or bridged calls can be handled. EventBridged indicates an extension, besides the one pointed to by ThisDN, has picked up the call, and that the telephony object specified by ThisDN is no longer ringing (although it still can pick up the call, establishing a three-way conversation).

EventBridged is used to describe a state where the call is neither ringing nor established. The nature of a bridge is such that it is possible for a call to move to a bridged state even after it has been released. Because of this, only calls released through CTI will be detected as moving into the bridged state. If a client issues a RequestReleaseCall() on a bridged call with two or more active bridged or bridging parties, EventReleased, with CallState = CallStateBridged, follows for the releasing party; the releasing party then receives EventBridged. At this point, a client may issue a RequestAnswerCall() to activate the call. If the client does this, EventEstablished follows.


Notes:

  • Currently, T-Server does not fully support placing a bridged or bridging call on hold when there is only one active bridge. If a client attempts to place such a call on hold, T-Server does not reflect the held state of all members.
  • Transferring and conferencing a bridged or bridging call currently works only when there is no more than one active bridge member.
  • There may be cases where a call is made from a bridged DN to the principle extension on the bridge. In such an instance, the dialing and ringing between two DNs on the same bridge is happening within the context of a single call. While such a circumstance is supported, the bridged appearance of the call should be ignored and not used.

EventBridged Contents

Event Attribute

Type

Event

Mandatory

Server

Mandatory

CustomerID

Optional

ConnID

Mandatory

PreviousConnIDa

Optional

CallID

Mandatory

CollectedDigits

Optional

CallHistory

Optional

CallType

Mandatory

CallStateb

Optional

AgentID

Optional

ThisDN

Mandatory

ThisQueuec

Optional

ThisDNRole

Mandatory

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDNb

Optional

OtherTrunkb

Optional

OtherQueue

Optional

OtherDNRoleb

Optional

DNIS

Optional

ANI

Optional

UserData

Optional

Extensions

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

a The attribute must appear if the value of CallType is Consult.
b For the Avaya Communication Manager only: In a Coverage Path scenario, the second party that has answered a call must receive CallState=Conferenced, but does not receive information about the other party (OtherDN = NULL). See Call Models and Flows.
c The attribute must appear in case of an ACD call.

EventReleased

Event Description

The telephony object specified by ThisDN has disconnected or has been dropped from the call.

EventReleased Contents

Event Attribute

Type

AgentID

Optional

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallState

Mandatory

Cause

Optional

CallType

Mandatory

ConnID

Mandatory

CollectedDigits

Optional

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

OtherDNa

Optional

OtherDNRolea

Optional

OtherQueuea

Optional

OtherTrunka

Optional

Previousb

Optional

Reasons

Optional

ReferenceID

Optional

Server

Mandatory

ThirdPartyDNc

Optional

ThisDN

Mandatory

ThisDNRole

Mandatory

ThisQueue

Optional

ThisTrunk

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a This attribute does not appear if the release is from a conference. In all other call scenarios, the attribute must be present only if such information is provided by a CTI link.
b The attribute must appear if the value of CallType is Consult.
c The appearance of ThirdPartyDN depends on the following conditions:

If information about the new destination is available from the switch at the moment when EventReleased is generated, then ThirdPartyDN is mandatory. Or, if T-Server has initiated a single-step transfer, redirection, or previously set the forwarding target, this attribute is also mandatory.
If a call has gone through a single-step transfer, been redirected, or forwarded by another application (not the T-Server in question), this attribute is absent.

Example

EventReleased Feature Example

For more information, refer to Call Models and Flows.

EventRetrieved

Event Description

The call has been retrieved from hold.

EventRetrieved Contents

Event Attribute

Type

AgentID

Optional

ANI

Optional

CallHistory

Optional

CallID

Mandatory

CallState

Mandatory

CallType

Mandatory

ConnID

Mandatory

CustomerID

Optional

DNIS

Optional

Event

Mandatory

Extensions

Optional

OtherDNa

Optional

OtherDNRolea

Optional

OtherQueuea

Optional

OtherTrunka

Optional

NetworkCallID

Optional

NetworkNodeID

Optional

Reasons

Optional

ReferenceID

Optional

Server

Mandatory

ThisDN

Mandatory

ThisDNRoleb

Mandatory

ThisQueuec

Optional

ThisTrunk

Optional

time

Mandatory

TransferredNetworkCallID

Optional

TransferredNetworkNodeID

Optional

UserData

Optional

a In all call scenarios, this attribute must be present only if the information is provided by a CTI link.
b The value here is the same as that for the events preceding EventRetrieved (EventEstablished and EventRinging) for the same call.
c The value here is the same as that for the events preceding EventRetrieved (EventEstablished and EventRinging) for the same call. (For non-ACD calls, ThisQueue is not reported)

Comments or questions about this documentation? Contact us for support!