Member Junction
    Preparing search index...

    Interface WidgetSessionResponse

    The successful response shape from POST /widget/session (see WidgetSessionService.MintGuestSession in MJServer). Mirrors MintGuestSessionResult.

    interface WidgetSessionResponse {
        applicationId?: string;
        enabledChannels?: string[];
        error?: string;
        errorCode?: string;
        expiresAt?: string;
        lastConversationId?: string;
        linkedEntityId?: string;
        linkedRecordId?: string;
        modality?: WidgetModality;
        pinnedAgentId?: string;
        rememberReturningVisitors?: boolean;
        sessionId?: string;
        success: boolean;
        token?: string;
        visitorKey?: string;
        voiceMaxSessionMinutes?: number;
        widgetId?: string;
    }
    Index

    Properties

    applicationId? enabledChannels? error? errorCode? expiresAt? lastConversationId? linkedEntityId? linkedRecordId? modality? pinnedAgentId? rememberReturningVisitors? sessionId? success token? visitorKey? voiceMaxSessionMinutes? widgetId?

    Properties

    applicationId?: string
    enabledChannels?: string[]

    MJ interactive channels (by name, e.g. ["Whiteboard"]) this widget may attach when voice is active (mirrors WidgetInstance.EnabledChannels). Empty/absent (the default) = no channels.

    error?: string
    errorCode?: string
    expiresAt?: string
    lastConversationId?: string

    The visitor's most-recent prior conversation for this VisitorKey within the widget's application (RV2 chain). Present only on a returning visit; the client stamps it on Conversation.LastConversationID.

    linkedEntityId?: string

    Resolved polymorphic identity (RV4), present only when a host-identity widget asserted a resolvable identity at mint. The client stamps (linkedEntityId, linkedRecordId) on the new conversation so memory injection keys off the resolved record rather than the cookie chain.

    linkedRecordId?: string

    Resolved polymorphic identity record id (RV4); paired with linkedEntityId.

    modality?: WidgetModality
    pinnedAgentId?: string

    The pinned support agent the widget passes as explicitAgentId for every turn (D5).

    rememberReturningVisitors?: boolean

    Returning-visitor memory toggle for this widget (RememberReturningVisitors). When false (default), the widget sets no durable visitor cookie and does no cross-session linking — fully off.

    sessionId?: string

    Opaque per-session id; stamped onto Conversation.ExternalID so the Widget Guest RLS filters isolate this guest.

    success: boolean
    token?: string
    visitorKey?: string

    The durable, opaque visitor anchor (RV3). Present only when rememberReturningVisitors is true: either echoed back from the cookie the client presented, or freshly minted on a first visit. The client persists it as a long-lived first-party cookie and stamps it on Conversation.VisitorKey.

    voiceMaxSessionMinutes?: number

    Optional hard ceiling (minutes) on a voice session for this widget (server default applies when absent).

    widgetId?: string

    Settings

    Member Visibility

    On This Page

    Properties