Unblu Agent Embedded JS API
    Preparing search index...

    Interface ExternalParticipantHistoryData

    Information about an external participant in a conversation (with historical information). External participants are connected through an external messenger.

    interface ExternalParticipantHistoryData {
        activationTimestamp?: number;
        createdTimestamp: number;
        externalMessengerContactId: string;
        joinedTimestamp?: number;
        leftComment?: string;
        leftReason?: string;
        leftTimestamp?: number;
        name?: string;
        offboardingTimestamp?: number;
        state: ParticipationState;
    }
    Index

    Properties

    activationTimestamp? createdTimestamp externalMessengerContactId joinedTimestamp? leftComment? leftReason? leftTimestamp? name? offboardingTimestamp? state

    Properties

    activationTimestamp?: number

    Unix timestamp (ms) when the participation was activated, that is, when their participation state was set to ParticipationState.ACTIVE. null if the participation was never activated.

    createdTimestamp: number

    Unix timestamp (ms) when the person participation was created and their participation state was set to ParticipationState.CREATED

    externalMessengerContactId: string

    The external messenger contact's ID

    joinedTimestamp?: number

    Unix timestamp (ms) when the person joined, that is, when their participation state was set to ParticipationState.ONBOARDING. null if the participation never joined.

    leftComment?: string

    The comment on why the participant left the conversation. Set when offboarding starts, null if the participant is still part of the conversation.

    leftReason?: string

    The reason the participant left the conversation. Set when offboarding starts, null if the participant is still part of the conversation.

    leftTimestamp?: number

    Unix timestamp (ms) when the person left, that is, when their participation state was set to ParticipationState.ENDED). null if the participation didn't finish its offboarding.

    name?: string

    The external messenger contact's name

    offboardingTimestamp?: number

    Unix timestamp (ms) when the person started offboarding, that is, when their participation state was set to ParticipationState.OFFBOARDING. null if the participation never started its offboarding.

    state: ParticipationState

    Last participation state

    Settings

    Member Visibility

    On This Page

    Properties