Unblu Agent Embedded JS API
    Preparing search index...

    Interface ConversationInfo

    interface ConversationInfo {
        conversationVisibility: ConversationVisibility;
        creationTimestamp: number;
        id: string;
        initialEngagementUrl?: string;
        lastChatMessage?: LastChatMessage;
        myParticipationType: ConversationParticipationType;
        notificationCount: number;
        otherParticipants: [ConversationParticipant];
        recipient: ConversationRecipient;
        state: ConversationState;
        topic?: string;
        visitorData?: string;
    }
    Index

    Properties

    conversationVisibility creationTimestamp id initialEngagementUrl? lastChatMessage? myParticipationType notificationCount otherParticipants recipient state topic? visitorData?

    Properties

    conversationVisibility: ConversationVisibility

    The visibility of the conversation, determining who is allowed to see it.

    creationTimestamp: number

    Conversation creation timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.

    id: string

    The ID of the conversation.

    initialEngagementUrl?: string

    The URL where the conversation originated. The following conversations always have an initial engagement URL:

    • Conversations initiated by a visitor on a customer's website where Unblu is integrated
    • PIN-based conversations, provided a visitor redeems the PIN on a customer's website where Unblu is integrated
    • Conversations created using the Web API, provided an initial engagement URL was included when the conversation was created
    Conversations initiated from the mobile SDK don't have an initial engagement URL.
    lastChatMessage?: LastChatMessage

    The last relevant message in the conversation. The last relevant message depends on the user: it's the last message the user can see that isn't a system message.

    myParticipationType: ConversationParticipationType

    Participation type of the current person in this conversation

    notificationCount: number

    Notification count of this conversation.

    otherParticipants: [ConversationParticipant]

    All other participants of this conversation

    recipient: ConversationRecipient

    The current recipient of this conversation

    state: ConversationState

    Conversation state.

    topic?: string

    Topic of this conversation; null if not set

    visitorData?: string

    The custom visitor data of the conversation. Null if not set.

    Settings

    Member Visibility

    On This Page

    Properties