Section II – Functional Modules > Interaction Interface > Events Bottom of Page
| Genesys 8.0 SCXML Technical Reference
< Action Elements

## Events

The following are the common events across interactions.

The event namespace convention is — interaction.xxxx

The following are the Interaction action result events:

Event | Attributes | Description
--- | --- | ---
interaction.terminate.done |  | This event indicates the success of the request and that the interaction is being terminated.
requestid | This is the ID associated with the request.
interactionid | This is the interaction id that was terminated.
error.interaction.terminate |  | This indicates that an abnormal condition occurred while trying to perform this request. This event will be sent as a result of a timeout of the request as well or due to problems with the request itself.
requestid | This is the ID associated with the request.
error | This is the type of error that occurred. The following are the possible values: unknown invalidstate.state (null, ringing, hold, transferring, treating, routed) remote
description | This is a more detailed description of the error.
interaction.redirect.done |  | This event indicates the success of the request and that the interaction is being redirected.
requestid | This is the ID associated with the request.
interactionid | This is the interaction id associated with the request.
error.interaction.redirect |  | This indicates that an abnormal condition occurred while trying to perform this request. This event will be sent as a result of a timeout of the request as well as due to problems with the request itself.
requestid | This is the ID associated with the request.
error | This is the type of error that occurred. The following are the possible values: unknown invalidstate.state (null, ringing, hold, transferring, treating, routed) invaliddestination badtranslation remote
description | This is a more detailed description of the error.
interaction.associate.done |  | This event indicates the success of the request and that the interaction is now associated the SCXML session.
requestid | This is the ID associated with the request.
interactionid | This is the interaction ID associated with the request.
error.interaction.associate |  | This indicates that an abnormal condition occurred while trying to perform this request. This event will be sent as a result of a timeout of the request as well as due to problems with the request itself.
requestid | This is the ID associated with the request.
error | This is the type of error that occurred. The following are the possible values: unknown invalidserver nointeraction
description | This is a more detailed description of the error.
interaction.pick.done |  | This event indicates the success of the request and that the interaction is being picked.
requestid | This is the ID associated with the request.
interactionid | This is the interaction ID associated with the request.
error.interaction.pick |  | This indicates that an abnormal condition occurred while trying to perform this request. This event will be sent as a result of a timeout of the request as well as due to problems with the request itself.
requestid | This is the ID associated with the request.
error | This is the type of error that occurred. The following are the possible values: unknown invaliddestination invalidsource invalidserver
description | This is a more detailed description of the error.
interaction.accept.done |  | This event indicates the success of the request and that the interaction is being picked.
requestid | This is the ID associated with the request.
error.interaction.accept |  | This indicates that an abnormal condition occurred while trying to perform this request. This event will be sent as a result of a timeout of the request as well as due to problems with the request itself.
requestid | This is the ID associated with the request.
error | This is the type of error that occurred. The following are the possible values: unknown invalidstate.state (null, hold, transferring, treating, routed) reject.reason (reason is the reason why the destination reject it.) remote
description | This is a more detailed description of the error.
interaction.clear.done |  | This event indicates the success of the request and that the resource's connection to the interaction is being cleared.
requestid | This is the ID associated with the request.
interactionid | This is the interaction ID where the resource's connection is cleared.
resource | This is the resource's address ID of the resource's connection being cleared. [This is unclear.]
error.interaction.clear |  | This indicates that an abnormal condition occurred while trying to perform this request. This event will be sent as a result of a timeout of the request as well as due to problems with the request itself.
requestid | This is the ID associated with the request.
error | This is the type of error that occurred. The following are the possible values: unknown invalidstate.state (null, ringing, hold, transferring, treating, routed) remote
description | This is a more detailed description of the error.
interaction.singlesteptransfer.done |  | This event indicates the success of the request and that the interaction has been transferred to the specified resource.
requestid | This is the ID associated with the request.
interactionid | This is the interaction ID which is being transferred.
error.interaction.singlesteptransfer |  | This indicates that an abnormal condition occurred while trying to perform this request. This event will be sent as a result of a timeout of the request as well as due to problems with the request itself.
requestid | This is the ID associated with the request.
error | This is the type of error that occurred. The following are the possible values: unknown invalidstate.state (null, ringing, hold, transferring, treating, routed) remote
description | This is a more detailed description of the error.
interaction.singlestepconference.done |  | This event indicates the success of the request and that the specified resource has been conferenced into the interaction.
requestid | This is the ID associated with the request.
interactionid | This is the interaction ID which has been conferenced.
error.interaction.singlestepconference |  | This indicates that an abnormal condition occurred while trying to perform this request. This event will be sent as a result of a timeout of the request as well as due to problems with the request itself.
requestid | This is the ID associated with the request.
error | This is the type of error that occurred. The following are the possible values: unknown invalidstate.state (null, ringing, hold, transferring, treating, routed) remote
description | This is a more detailed description of the error.

The following are the Interaction asynchronous events:

Event | Attributes | Description
--- | --- | ---
interaction.added |  | This event indicates that a new interaction is associated with the session (it has been added to the _genesys.ixn.interactions[] array).Reasons for this event can vary — starting of session because of this interaction, some session activity resulted in the creation of new interaction, `<associate>` action and the target session, or `<createmessage>` action, and so on.
interactionid | This is the interaction ID of the interaction that was added. Starting from that moment, the corresponding interaction object can be accessed, for example as _genesys.ixn.interactions[_event.data.interactionid]
interaction.deleted |  | This event indicates that the interaction is not associated any more with this session (it has been removed from the _genesys.ixn.interactions[] array). Reasons for this event can vary — interaction is finished or abandoned, `<associate>` action and the source session, and so on.Every time when interaction.deleted is going to be published, the platform will also publish an interaction.notcontrolled (see below) event if the last interaction.present event (see below) was not "notcontrolled" yet.
interactionid | This is the interaction ID of the deleted interaction.Any attempt to access the _genesys.ixn.interactions[] array with the interaction ID of this interaction will result in a runtime error.
interaction.present |  | This event indicates that the interaction is under session control and the session is allowed to perform actions on the interaction, such as routing, redirecting, releasing, and so on.In the case of multi-media interactions, action or function invocations taken before getting the interaction.present event can result in runtime errors.In the case of voice interactions, action or function invocations can be taken after the interaction.added event, but they to have common processing for all interaction types. You should use the interaction.present event for this. [?]
interactionid | This is the interaction ID of the interaction that is available to the session for processing.
interaction.notcontrolled |  | This event accompanies interaction.present and means the session, although still owning the interaction, is no longer allowed to control it. Attempts to do so after this event will result in runtime errors.For voice interactions, this event will be published immediately before the interaction.deleted event.For multimedia interactions this event will be published when the Interaction Server moves (for any reason) the interaction from the platform back into the interaction queue.
interactionid | This is the interaction ID of the interaction that is unavailable to the session for processing.
interaction.partyadded |  | This event indicates that a new party has been created in an interaction. The interaction.partyadded event means adding a new party to the interaction.parties[] array. The event is published only if the platform detects that the party is being added to some interaction and that interaction is already associated with a session. So parties acquired by the interaction before the interaction.added event will not be reported through the interaction.partyadded event (added interactions will have them from the beginning). In the case of multimedia interactions, parties are agents only. Interaction queues, workbins, or the interaction itself are not considered as parties and therefore the interaction.partyadded will not be generated when they are added to the interaction.
interactionid | This is the interaction ID
focusresource | This is the device ID of the party
partyid | This is the party ID
partystate | This is the state of the party
interaction.partydeleted |  | This event indicates that a party has been deleted from an interaction. Just like interaction.deleted means removing an interaction from the _genesys.ixn.interactions[] array, interaction.paprtydeleted event means removing some party from the interaction.parties[] array.
interactionid | This is the interaction ID
focusresource | This is the device ID of the party
partyid | This is the party ID
partystate | This is the state of the party
interaction.partystatechanged |  | This event indicates that state of the party in an interaction has been changed. The event is published only when the interaction is associated with a session and the platform detects a party state change for a party associated with the interaction.
interactionid | This is the interaction ID that is being made available to the session.
focusresource | This is the device ID of the party that the interaction is being presented to.
partyid | This is the party ID
partystate | This is the state of the party
hints | This is functional module implementation–specific data that is associated with this event.
interaction.udata.changed |  | This event indicates that the user data associated with the interaction has been changed asynchronously (that is, changed by an outside source). Updated user data is available for the application in the data model, in the corresponding interaction object.
interactionid | This is the ID of the interaction which has had the udata changed.
interaction.ondivert |  | This event indicates that interaction has been diverted. Note that after this event is signaled, events about new parties (new destinations) will also be sent to the SCXML application.
interactionid | This is the ID of the interaction that is being made available to the session.
divertingpartyid | This is the ID of the party that diverted the interaction.
divertingresource | This is the device ID of the party that diverted the interaction.
divertingpartystate | This is the state of the party that diverted the interaction.
newdestination | This is the destination that the interaction has been diverted to.
hints | This is functional module implementation–specific data that is associated with this event.
interaction.onsinglesteptransfer |  | This event indicates that a single step transfer has been performed in the interaction
interactionid | This is the interaction ID that is being made available to the session.
transferringpartyid | This is the ID of the party that transferred the interaction.
transferringresource | This is the device ID of the party that transferred the interaction.
transferringpartystate | This is the state of the party that transferred the interaction.
newdestination | This is the transfer destination.
hints | This is functional module implementation–specific data that is associated with this event.
interaction.onsinglestepconference |  | This event indicates that a single step conference has been performed in the interaction.
interactionid | This is the interaction ID that is being made available to the session.
conferencingpartyid | This is the ID of the party that initiated the conference.
conferencingresource | This is the device ID of the party that initiated the conference.
conferencingpartystate | This is the state of the party that transferred the interaction.
addedpartyid | This is the ID of the party that has been added to the interaction.
addedresource | This is the ID of the device that has been added to the interaction.
addedpartystate | This is the state of the party that has been added to the interaction.
hints | This is functional module implementation–specific data that is associated with this event.
interaction.onmerge |  | This event indicates that two interactions were merged (indicating consult call completion). There are two types of merge possible: transfer completion or conference completion. The type of merge is provided in the hints in the Call Control Event.
frominteractionid | This is the interaction ID that is being merged (consult).
tointeractionid | This is the interaction ID that is the merge destination (primary).
activeresource | This is the ID of the active device in the primary or consult call pair.
activepartyid | This is the ID of the active party in the primary or consult call pair.
activepartystate | This is the state of the active party in the primary or consult call pair.
heldresource | This is the ID of the held device in the primary or consult call pair.
heldpartyid | This is the ID of the held party in the primary or consult call pair.
heldpartystate | This is the state of the held party in the primary or consult call pair.
hints | This is functional module implementation–specific data that is associated with this event.
interaction.abandoned |  | This indicates that the customer has left the interaction unexpectedly. This maps to the following media channel–specific events: T-Server — This is the EventAbandoned Interaction Server — This is EventProcessingStopped with a reason.
interactionid | This is the interaction ID which is being abandoned.
focusresource | This is the device ID of the party that abandoned the interaction.
reason | This is the reason why the interaction was abandoned.
hints | This is functional module implementation–specific data that is associated with this event.
interaction.restored |  | This event indicates that the interaction was restored by a functional module.
interactionid | The interaction ID which has been restored.

hints Attribute Considerations

The hints property of the interaction events is populated as follows:

- hints.ccevent — Call Control Event — This gives detailed definition of the interaction events being raised. This property is an integer and may have one of the following values:

- 0 — CallControlEvent_Bridged
- 1 — CallControlEvent_ConnectionCleared
- 2 — CallControlEvent_Delivered
- 3 — CallControlEvent_Established
- 4 — CallControlEvent_Failed
- 5 — CallControlEvent_Held
- 6 — CallControlEvent_Offered
- 7 — CallControlEvent_Originated
- 8 — CallControlEvent_Queued
- 9 — CallControlEvent_Retrieved
- 10 — CallControlEvent_ServiceInitiated
- 11 — CallControlEvent_Transfered
- 12 — CallControlEvent_Conferenced
- 13 — CallControlEvent_Diverted

- hints.cause — Call Control Event Cause — This is a detailed definition of the cause of the interaction events being raised. This property is an integer and may have one of the following values:

- 0 — CCEventCause_unknown
- 1 — CCEventCause_busy
- 2 — CCEventCause_conference
- 3 — CCEventCause_distributed
- 4 — CCEventCause_distributionDelay
- 5 — CCEventCause_enteringDistribution
- 6 — CCEventCause_normal
- 7 — CCEventCause_redirected
- 8 — CCEventCause_singleStepConference
- 9 — CCEventCause_singleStepTransfer
- 10 — CCEventCause_transfer

Section II – Functional Modules > Interaction Interface > Events Top of Page
| Genesys 8.0 SCXML Technical Reference
< Action Elements