Unblu Agent Embedded JS API
    Preparing search index...

    Interface ConversationHistoryData

    History information about a conversation

    interface ConversationHistoryData {
        assigneeJoinTimestamp?: number;
        awaitedPersonType?: AwaitedPersonType;
        awaitedPersonTypeChangeTimestamp?: number;
        botParticipants: BotParticipantHistoryData[];
        conversationTemplateId: string;
        conversationVisibility: ConversationVisibility;
        createdTimestamp: number;
        dueDeletionTimestamp?: number;
        endComment?: string;
        endPerson?: PersonData;
        endReason?: ConversationEndReason;
        endTimestamp?: number;
        externalMessengerChannelIconUrl?: string;
        externalMessengerChannelName?: string;
        externalParticipants: ExternalParticipantHistoryData[];
        id: string;
        initialEngagementType: ConversationHistoryInitialEngagementType;
        initialEngagementUrl?: string;
        lastCompletedRecordingTimestamp?: number;
        lastMessageTimestamp?: number;
        locale: string;
        participants: ParticipantHistoryData[];
        recipient?: ConversationRecipientData;
        scheduledTimestamp?: number;
        sourceUrl?: string;
        state: ConversationHistoryState;
        stateChanges: ConversationStateChangeData[];
        topic?: string;
    }
    Index

    Properties

    assigneeJoinTimestamp? awaitedPersonType? awaitedPersonTypeChangeTimestamp? botParticipants conversationTemplateId conversationVisibility createdTimestamp dueDeletionTimestamp? endComment? endPerson? endReason? endTimestamp? externalMessengerChannelIconUrl? externalMessengerChannelName? externalParticipants id initialEngagementType initialEngagementUrl? lastCompletedRecordingTimestamp? lastMessageTimestamp? locale participants recipient? scheduledTimestamp? sourceUrl? state stateChanges topic?

    Properties

    assigneeJoinTimestamp?: number

    Unix timestamp (ms) when the assignee joined the conversation (timestamp when the state of the first agent participant was set to ParticipationState.ACTIVE).

    Value is null of no assignee has joined yet.

    awaitedPersonType?: AwaitedPersonType

    Awaited person type. Null if none is set.

    awaitedPersonTypeChangeTimestamp?: number

    Unix timestamp (ms) when the awaited person type last changed

    botParticipants: BotParticipantHistoryData[]

    The past and present bot participants in the conversation

    conversationTemplateId: string

    Template ID of the conversation

    conversationVisibility: ConversationVisibility

    Visibility of the conversation

    createdTimestamp: number

    Unix timestamp (ms) when the conversation was created

    dueDeletionTimestamp?: number

    Unix timestamp (ms) when the conversation will be deleted automatically. Calculated from #endTimestamp. Null if no record retention interval is configured.

    endComment?: string

    Comment provided when ending the conversation. null if it isn't ended yet or there wasn't one provided.

    endPerson?: PersonData

    The person who ended the conversation. null if it hasn't ended yet.

    endReason?: ConversationEndReason

    Reason for ending the conversation. null if it hasn't ended yet.

    endTimestamp?: number

    Unix timestamp (ms) when the conversation ended (all active participants have finished their offboarding; timestamp when the state was set to ConversationState.ENDED)

    Otherwise, the value is null.

    externalMessengerChannelIconUrl?: string

    URL of the external messenger channel icon

    externalMessengerChannelName?: string

    Name of the external messenger channel

    externalParticipants: ExternalParticipantHistoryData[]

    The past and present participants in the conversation connected through an external messenger

    id: string

    ID of the conversation

    initialEngagementType: ConversationHistoryInitialEngagementType

    Initial engagement type of the conversation

    initialEngagementUrl?: string

    The URL where the conversation originated

    lastCompletedRecordingTimestamp?: number

    Unix timestamp (ms) when the last recording was completed. Null if there hasn't been any yet.

    lastMessageTimestamp?: number

    Unix timestamp (ms) when the last message was sent to the conversation. Null if there hasn't been any yet.

    locale: string

    Locale of the conversation language formatted as BCP 47 language tag form including region if available

    participants: ParticipantHistoryData[]

    The conversation's participants, past and present

    recipient?: ConversationRecipientData

    Recipient of the conversation

    scheduledTimestamp?: number

    Unix timestamp (ms) when the conversation is scheduled for

    sourceUrl?: string

    Source URL of the conversation

    state: ConversationHistoryState

    Current state of the conversation

    stateChanges: ConversationStateChangeData[]

    List of conversation state changes with timestamps

    topic?: string

    Topic of the conversation

    Settings

    Member Visibility

    On This Page

    Properties