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

    Interface SystemMessage

    A system-generated notification message - either pure (server-generated, no actor) or user-triggered (an agent action narrated as a system event, e.g. "User muted the interaction"). Distinguish via author.type: SYSTEM (no actor) vs AGENT (actor present in author.details).

    interface SystemMessage {
        messageId: string;
        createdAt: Date;
        interactionId: string;
        author: MessageAuthor;
        direction: MessageDirection;
        isPrivate: boolean;
        type: SYSTEM;
        body: SystemMessageBody;
    }

    Hierarchy (View Summary)

    Index

    Properties

    messageId createdAt interactionId author direction isPrivate type body

    Properties

    messageId: string

    Server-assigned message identifier.

    createdAt: Date

    When the server recorded the message.

    interactionId: string

    Identifier of the interaction this message belongs to.

    author: MessageAuthor

    Union of all supported author types. narrow on author.type.

    direction: MessageDirection

    Whether the message was inbound or outbound relative to the contact center.

    isPrivate: boolean

    Whether the message is private (visible to viewers only, not the customer).

    type: SYSTEM

    Type of this message

    body

    body: SystemMessageBody

    Settings

    Member Visibility

    On This Page

    Properties