Unblu Agent Embedded JS API
    Preparing search index...

    Interface StartConversationOptions

    Options to start a new conversation

    interface StartConversationOptions {
        contextPersonContactId?: string;
        contextPersonId?: string;
        externalMessengerChannelId?: string;
        initialEngagementType?: AgentInitialEngagementType;
        language?: string;
        scheduledTimestamp?: number;
        secondaryHiddenAgentPersonIds?: string[];
        secondaryVisibleAgentPersonIds?: string[];
        templateId?: string;
        topic?: string;
    }
    Index

    Properties

    contextPersonContactId? contextPersonId? externalMessengerChannelId? initialEngagementType? language? scheduledTimestamp? secondaryHiddenAgentPersonIds? secondaryVisibleAgentPersonIds? templateId? topic?

    Properties

    contextPersonContactId?: string

    The ID of the visitor contact to link the conversation to when creating a conversation for an external messenger channel. Has to be set when externalMessengerChannelId is set.

    contextPersonId?: string

    The ID of the visitor person who will be the context person. Will be ignored if externalMessengerChannelId is set.

    externalMessengerChannelId?: string

    The ID of the external messenger channel to link the conversation to

    initialEngagementType?: AgentInitialEngagementType

    The initial engagement type the conversation should have. If present, the template used is either the matching default template or the one specified in #templateId. If a #templateId is provided that doesn't match the initial engagement type, an error is raised.

    language?: string

    The language of the conversation as a BCP 47 language tag, including the region if available. Optional, if not provided, the account default locale will be used.

    scheduledTimestamp?: number

    The timestamp when a scheduled conversation should be created. Can only be set for conversations with the initial engagement type AgentInitialEngagementType.SCHEDULED_CONVERSATION. For other types it will be ignored.

    secondaryHiddenAgentPersonIds?: string[]

    The IDs of secondary agent persons to add to the conversation as hidden participants

    secondaryVisibleAgentPersonIds?: string[]

    The IDs of secondary agent persons to add to the conversation as visible participants

    templateId?: string

    The ID of the conversation template to use. If omitted the default template for #initialEngagementType instead.

    topic?: string

    The topic of the conversation

    Settings

    Member Visibility

    On This Page

    Properties