@avaya/infinity-agent-sdk - v1.0.0
    Preparing search index...

    Enumeration InteractionEventType

    The set of events that an Interaction can emit.

    Use these with Interaction.subscribe() to react to call state changes, transfer operations, conference actions, and viewer activity throughout the interaction lifecycle.

    Event lookup table

    Event type constant Event interface
    INTERACTION_ACCEPTED InteractionAcceptedEvent
    INTERACTION_REJECTED InteractionRejectedEvent
    INTERACTION_CALL_DISCONNECTED InteractionCallDisconnectedEvent
    INTERACTION_WRAP_UP InteractionWrapUpEvent
    INTERACTION_WRAP_UP_EXTENDED InteractionWrapUpExtendedEvent
    INTERACTION_COMPLETED InteractionCompletedEvent
    INTERACTION_NOTES_UPDATED InteractionNotesUpdatedEvent
    INTERACTION_SUBJECT_UPDATED InteractionSubjectUpdatedEvent
    INTERACTION_CUSTOM_FIELDS_UPDATED InteractionCustomFieldsUpdatedEvent
    INTERACTION_CALL_MUTED InteractionCallMutedEvent
    INTERACTION_CALL_UNMUTED InteractionCallUnmutedEvent
    INTERACTION_CALL_HELD InteractionCallHeldEvent
    INTERACTION_CALL_RESUMED InteractionCallResumedEvent
    INTERACTION_BLIND_TRANSFERRED InteractionBlindTransferredEvent
    INTERACTION_TRANSFER InteractionTransferEvent
    INTERACTION_TRANSFER_ANSWER InteractionTransferAnswerEvent
    INTERACTION_TRANSFER_CANCEL InteractionTransferCancelEvent
    INTERACTION_TRANSFER_FAILED InteractionTransferFailedEvent
    INTERACTION_TRANSFER_COMPLETE InteractionTransferCompleteEvent
    INTERACTION_CALL_ESTABLISHED InteractionCallEstablishedEvent
    INTERACTION_CONFERENCE InteractionConferenceEvent
    INTERACTION_CONFERENCE_COMPLETE InteractionConferenceCompleteEvent
    INTERACTION_VIEWER_ADDED InteractionViewerAddedEvent
    INTERACTION_VIEWER_JOINED_CALL InteractionViewerJoinedCallEvent
    INTERACTION_VIEWER_REMOVED InteractionViewerRemovedEvent
    INTERACTION_VIEWER_LEFT_CALL InteractionViewerLeftCallEvent
    INTERACTION_VIEWER_BARGE_STARTED InteractionViewerBargeStartedEvent
    INTERACTION_VIEWER_BARGE_ENDED InteractionViewerBargeEndedEvent
    INTERACTION_VIEWER_COACH_STARTED InteractionViewerCoachStartedEvent
    INTERACTION_VIEWER_COACH_ENDED InteractionViewerCoachEndedEvent
    INTERACTION_CLASSIFICATION_UPDATED InteractionClassificationUpdatedEvent
    INTERACTION_CUSTOMER_INFO_UPDATED InteractionCustomerInfoUpdatedEvent
    INTERACTION_CALL_FAILED InteractionCallFailedEvent
    INTERACTION_OWNERSHIP_CHANGED InteractionOwnershipChangedEvent
    INTERACTION_MESSAGE_RECEIVED InteractionMessageReceivedEvent
    INTERACTION_MESSAGE_SENT InteractionMessageSentEvent 
    const handlerId = interaction.subscribe(
        InteractionEventType.INTERACTION_CALL_MUTED,
        (event) => {
            console.log("Call muted for interaction:", event.payload.interactionId);
        }
    );
    Index

    Enumeration Members

    INTERACTION_ACCEPTED INTERACTION_REJECTED INTERACTION_CALL_DISCONNECTED INTERACTION_WRAP_UP INTERACTION_WRAP_UP_EXTENDED INTERACTION_COMPLETED INTERACTION_NOTES_UPDATED INTERACTION_SUBJECT_UPDATED INTERACTION_CUSTOM_FIELDS_UPDATED INTERACTION_CALL_MUTED INTERACTION_CALL_UNMUTED INTERACTION_CALL_HELD INTERACTION_CALL_RESUMED INTERACTION_BLIND_TRANSFERRED INTERACTION_TRANSFER INTERACTION_TRANSFER_ANSWER INTERACTION_TRANSFER_CANCEL INTERACTION_TRANSFER_FAILED INTERACTION_TRANSFER_COMPLETE INTERACTION_CALL_ESTABLISHED INTERACTION_CONFERENCE INTERACTION_CONFERENCE_COMPLETE INTERACTION_VIEWER_ADDED INTERACTION_VIEWER_JOINED_CALL INTERACTION_VIEWER_REMOVED INTERACTION_VIEWER_LEFT_CALL INTERACTION_CLASSIFICATION_UPDATED INTERACTION_CUSTOMER_INFO_UPDATED INTERACTION_CALL_FAILED INTERACTION_OWNERSHIP_CHANGED INTERACTION_MESSAGE_RECEIVED INTERACTION_MESSAGE_SENT INTERACTION_VIEWER_BARGE_STARTED INTERACTION_VIEWER_BARGE_ENDED INTERACTION_VIEWER_COACH_STARTED INTERACTION_VIEWER_COACH_ENDED

    Enumeration Members

    INTERACTION_ACCEPTED: "interactionAccepted"

    Fired when the agent accepts an incoming interaction.

    Payload: InteractionAcceptedPayload

    INTERACTION_REJECTED: "interactionRejected"

    Fired when the agent rejects an incoming interaction.

    Payload: InteractionRejectedPayload

    INTERACTION_CALL_DISCONNECTED: "interactionCallDisconnected"

    Fired when the voice call associated with an interaction is disconnected, typically preceding a transition to wrap-up state.

    Payload: InteractionCallDisconnectedPayload

    INTERACTION_WRAP_UP: "interactionWrapUp"

    Fired when an interaction enters the wrap-up phase after the call ends. The agent can now record notes, set classification codes, and close the interaction.

    Payload: InteractionWrapUpPayload

    INTERACTION_WRAP_UP_EXTENDED: "interactionWrapUpExtended"

    Fired when the wrap-up timer is extended. Contains the new deadline and extension details. Only fires on extensions, not on initial wrap-up entry.

    Payload: InteractionWrapUpExtendedPayload

    INTERACTION_COMPLETED: "interactionCompleted"

    Fired when an interaction is completed and closed. The interaction will no longer emit events after this point.

    Payload: InteractionCompletedPayload

    INTERACTION_NOTES_UPDATED: "interactionNotesUpdated"

    Fired when the free-text notes on an interaction are updated via Interaction.setNotes.

    Payload: InteractionNotesUpdatedPayload

    INTERACTION_SUBJECT_UPDATED: "interactionSubjectUpdated"

    Fired when the subject (short title) of an interaction is updated via Interaction.setSubject.

    Payload: InteractionSubjectUpdatedPayload

    INTERACTION_CUSTOM_FIELDS_UPDATED: "interactionCustomFieldsUpdated"

    Fired when the interaction's custom fields are updated - either by the local agent via Interaction.mergeCustomFields or by a server-side change.

    Payload: InteractionCustomFieldsUpdatedPayload

    INTERACTION_CALL_MUTED: "interactionCallMuted"

    Fired when any participant's microphone is muted on this interaction (owner, attended-transfer consult agent, or viewer). Broadcast to all agents; see InteractionCallMuteStateChangedPayload.userId for who was muted.

    Payload: InteractionCallMuteStateChangedPayload

    INTERACTION_CALL_UNMUTED: "interactionCallUnmuted"

    Fired when any participant's microphone is unmuted on this interaction (owner, attended-transfer consult agent, or viewer). Broadcast to all agents; see InteractionCallMuteStateChangedPayload.userId for who was unmuted.

    Payload: InteractionCallMuteStateChangedPayload

    INTERACTION_CALL_HELD: "interactionCallHeld"

    Fired when the customer call is placed on hold.

    Payload: InteractionCallStateChangedPayload

    INTERACTION_CALL_RESUMED: "interactionCallResumed"

    Fired when a held customer call is resumed and the agent is reconnected to the customer.

    Payload: InteractionCallStateChangedPayload

    INTERACTION_BLIND_TRANSFERRED: "interactionBlindTransferred"

    Fired when a blind (immediate, no-consultation) transfer is completed and the interaction has been routed away from this agent.

    Payload: InteractionBlindTransferredPayload

    INTERACTION_TRANSFER: "interactionTransfer"

    Fired when an attended (consultative) transfer is initiated and the consult call leg is being established.

    Payload: InteractionTransferPayload

    INTERACTION_TRANSFER_ANSWER: "interactionTransferAnswer"

    Fired when the consulted agent answers the consult call during an attended transfer.

    Payload: InteractionTransferAnswerPayload

    INTERACTION_TRANSFER_CANCEL: "interactionTransferCancel"

    Fired when an in-progress attended transfer is cancelled and the originating agent is reconnected to the customer.

    Payload: InteractionTransferCancelPayload

    INTERACTION_TRANSFER_FAILED: "interactionTransferFailed"

    Fired when an attended transfer fails due to an external cause (busy, no answer, rejected, etc.) rather than being cancelled by the agent. The interaction returns to CONNECTED status and the agent can retry the transfer.

    Payload: InteractionTransferFailedPayload

    INTERACTION_TRANSFER_COMPLETE: "interactionTransferComplete"

    Fired when an attended transfer is completed and the customer is handed off to the consulted agent. Both the originating and consulted agents receive this event.

    Payload: InteractionTransferCompletePayload

    INTERACTION_CALL_ESTABLISHED: "interactionCallEstablished"

    Fired when the voice call for this interaction is established and audio is active.

    Payload: InteractionMediaEventPayload

    INTERACTION_CONFERENCE: "interactionConference"

    Fired when a conference is initiated on this interaction, connecting the customer, the originating agent, and the consulted agent into a three-way call.

    Payload: InteractionConferencePayload

    INTERACTION_CONFERENCE_COMPLETE: "interactionConferenceComplete"

    Fired when the conference phase completes. The consulted agent transitions to a viewer role and the customer call continues between the owner and the viewer.

    Payload: InteractionConferenceCompletePayload

    INTERACTION_VIEWER_ADDED: "interactionViewerAdded"

    Fired when a new viewer joins this interaction.

    Payload: InteractionViewerAddedPayload

    INTERACTION_VIEWER_JOINED_CALL: "interactionViewerJoinedCall"

    Fired when a viewer joins the audio call on this interaction.

    Payload: InteractionViewerJoinedCallPayload

    INTERACTION_VIEWER_REMOVED: "interactionViewerRemoved"

    Fired when a viewer is removed from this interaction and fully exits the session.

    Payload: InteractionViewerRemovedPayload

    INTERACTION_VIEWER_LEFT_CALL: "interactionViewerLeftCall"

    Fired when a viewer temporarily leaves the audio call while remaining in the viewer role.

    Payload: InteractionViewerLeftCallPayload

    INTERACTION_CLASSIFICATION_UPDATED: "interactionClassificationUpdated"

    Fired when the classification type or result for an interaction is updated via Interaction.setClassificationType or Interaction.setClassificationResult.

    Payload: InteractionClassificationUpdatedPayload

    INTERACTION_CUSTOMER_INFO_UPDATED: "interactionCustomerInfoUpdated"

    Fired when the customer's contact information (name, phone, email, or language code) is updated via Customer.setName, Customer.setPhone, Customer.setEmail, or Customer.setLanguageCode.

    Payload: InteractionCustomerInfoUpdatedPayload

    INTERACTION_CALL_FAILED: "interactionCallFailed"

    Fired when a voice call fails at the SIP/telephony layer (busy, not found, restricted, resource reset, etc.). The payload includes the failure reason, a user-friendly message, and whether the SDK is attempting automatic reconnection.

    Payload: InteractionCallFailedPayload

    INTERACTION_OWNERSHIP_CHANGED: "interactionOwnershipChanged"

    Fired when the ownership of an interaction changes.

    Payload: InteractionOwnershipChangedPayload

    INTERACTION_MESSAGE_RECEIVED: "interactionMessageReceived"

    Fired when a message is received on this interaction - either authored by another viewer/owner, or generated by the server as a system notification. Use event.payload.message.isPrivate to distinguish private (viewer-only) messages from customer-visible messages.

    Payload: InteractionMessageReceivedPayload

    INTERACTION_MESSAGE_SENT: "interactionMessageSent"

    Fired when the agent's own message has been accepted by the server. Use event.payload.message.isPrivate to distinguish private (viewer-only) messages from customer-visible messages. Useful for confirming local sends and reconciling optimistic UI state.

    Payload: InteractionMessageSentPayload

    INTERACTION_VIEWER_BARGE_STARTED: "interactionViewerBargeStarted"

    Fired when the current Elite supervisor viewer transitions into listen-talk mode (barge active). The supervisor's voice is now audible to both the agent and the customer.

    Payload: InteractionViewerBargeStartedPayload

    INTERACTION_VIEWER_BARGE_ENDED: "interactionViewerBargeEnded"

    Fired when the current Elite supervisor viewer transitions out of listen-talk mode back to listen-only (barge ended). The supervisor's mic is silenced again.

    Payload: InteractionViewerBargeEndedPayload

    INTERACTION_VIEWER_COACH_STARTED: "interactionViewerCoachStarted"

    Fired when the current Elite supervisor viewer transitions into coach mode (whisper coaching active). The supervisor's voice is audible only to the agent; the customer cannot hear the supervisor.

    Payload: InteractionViewerCoachStartedPayload

    INTERACTION_VIEWER_COACH_ENDED: "interactionViewerCoachEnded"

    Fired when the current Elite supervisor viewer transitions out of coach mode back to listen-only. The supervisor's mic is silenced again.

    Payload: InteractionViewerCoachEndedPayload

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    INTERACTION_ACCEPTEDINTERACTION_REJECTEDINTERACTION_CALL_DISCONNECTEDINTERACTION_WRAP_UPINTERACTION_WRAP_UP_EXTENDEDINTERACTION_COMPLETEDINTERACTION_NOTES_UPDATEDINTERACTION_SUBJECT_UPDATEDINTERACTION_CUSTOM_FIELDS_UPDATEDINTERACTION_CALL_MUTEDINTERACTION_CALL_UNMUTEDINTERACTION_CALL_HELDINTERACTION_CALL_RESUMEDINTERACTION_BLIND_TRANSFERREDINTERACTION_TRANSFERINTERACTION_TRANSFER_ANSWERINTERACTION_TRANSFER_CANCELINTERACTION_TRANSFER_FAILEDINTERACTION_TRANSFER_COMPLETEINTERACTION_CALL_ESTABLISHEDINTERACTION_CONFERENCEINTERACTION_CONFERENCE_COMPLETEINTERACTION_VIEWER_ADDEDINTERACTION_VIEWER_JOINED_CALLINTERACTION_VIEWER_REMOVEDINTERACTION_VIEWER_LEFT_CALLINTERACTION_CLASSIFICATION_UPDATEDINTERACTION_CUSTOMER_INFO_UPDATEDINTERACTION_CALL_FAILEDINTERACTION_OWNERSHIP_CHANGEDINTERACTION_MESSAGE_RECEIVEDINTERACTION_MESSAGE_SENTINTERACTION_VIEWER_BARGE_STARTEDINTERACTION_VIEWER_BARGE_ENDEDINTERACTION_VIEWER_COACH_STARTEDINTERACTION_VIEWER_COACH_ENDED