Unblu Embedded App Component API
    Preparing search index...

    Interface StartConversationOptions

    Options for starting a new conversation.

    interface StartConversationOptions {
        languageTag?: string;
        recipient?: NewConversationRecipient;
        sourceId?: string;
        topic?: string;
        type: ConversationType;
        visitorData?: string;
        visitorName?: string;
    }
    Index

    Properties

    languageTag? recipient? sourceId? topic? type visitorData? visitorName?

    Properties

    languageTag?: string

    A BCP 47 compliant language tag defining the conversation language. Defaults to the browser's language if omitted.

    recipient?: NewConversationRecipient

    The team or agent recipient of the conversation. This will overwrite any named area that might be set for this web page.

    sourceId?: string

    An external identifier used to link this conversation to an entity in another system.

    topic?: string

    The initial topic of the conversation.

    type: ConversationType

    The type of conversation to start.

    visitorData?: string

    Custom visitor data that will be stored on the conversation and can be accessed through the Web API later on. This data won't be displayed anywhere and is for API usage only.

    visitorName?: string

    The name of the visitor. This is only respected for anonymous visitors

    Settings

    Member Visibility

    On This Page

    Properties