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

    Interface InteractionSummary

    A read-only snapshot of an interaction, returned by InteractionView.getInteractions.

    Contains enough information to identify, inspect, and select an interaction.

    interface InteractionSummary {
        interactionId: string;
        currentStatus: InteractionStatus;
        communicationType: InteractionCommType;
        communicationSubType: InteractionCommSubType;
        startTime: string;
        isElite: boolean;
        queueDetails: { queueId: string; name: string };
        user: {
            id: string;
            firstName: string;
            lastName: string;
            fullName: string;
            email: string;
        };
        sourceDetails: { name: string; phoneNumber: string };
        subject: string;
        route: { name: string; phoneNumber: string };
        tags: string[];
        isAid: boolean;
        viewerCount: number;
    }
    Index

    Properties

    interactionId currentStatus communicationType communicationSubType startTime isElite queueDetails user sourceDetails subject route tags isAid viewerCount

    Properties

    interactionId: string

    The unique interaction identifier. Pass this to User.viewInteraction.

    currentStatus: InteractionStatus

    The current interaction status.

    communicationType: InteractionCommType

    The communication type.

    communicationSubType: InteractionCommSubType

    The sub-communication type (direction).

    startTime: string

    ISO 8601 timestamp when the interaction started (or createdOn if startTime is null).

    isElite: boolean

    Whether this is an elite (hybrid) interaction.

    queueDetails: { queueId: string; name: string }

    The queue this interaction is assigned to.

    user: {
        id: string;
        firstName: string;
        lastName: string;
        fullName: string;
        email: string;
    }

    The agent owning this interaction.

    sourceDetails: { name: string; phoneNumber: string }

    The customer's contact details. Empty strings when not available.

    subject: string

    The interaction subject (e.g. "New Phone Inbound"). Empty string when not set.

    route: { name: string; phoneNumber: string }

    The routing target used by the customer to reach the queue.

    tags: string[]

    Tag names attached to the interaction.

    isAid: boolean

    Whether this interaction has an Active Interaction Distribution (AID) signal from the platform.

    viewerCount: number

    The number of viewers currently on this interaction.

    Settings

    Member Visibility

    On This Page

    Properties