Interface StartChatOptions

interface StartChatOptions {
    agentAvailabilityEnabled?: boolean;
    botName?: string;
    multilineResponseOptionsEnabled?: boolean;
    offlineFormsEnabled?: boolean;
    preChatFormEnabled?: boolean;
    preChatFormFieldsStatus?: PreChatFormFieldsStatus;
    transcriptEnabled?: boolean;
}

Properties

agentAvailabilityEnabled? botName? multilineResponseOptionsEnabled? offlineFormsEnabled? preChatFormEnabled? preChatFormFieldsStatus? transcriptEnabled?

Properties

Optional agentAvailabilityEnabled

agentAvailabilityEnabled?: boolean

If true, and no agents are available to serve the visitor, they will be presented with a message letting them know that no agents are available. If it's disabled, visitors will remain in a queue waiting for an agent. Defaults to true. Only checks the availability of the account, not specific departments. If availability information is needed on the department level.

Optional botName

botName?: string

Agent name used for messages from bots. If not specified, the default answer bot name will be used.

Optional multilineResponseOptionsEnabled

multilineResponseOptionsEnabled?: boolean

There might be situations where the number of quick reply options cause the user to scroll horizontally through the options (Selecting a department in chat). Enabling multilineResponseOptionsEnabled causes the options to be laid out in a Flexbox-style layout instead.

Optional offlineFormsEnabled

offlineFormsEnabled?: boolean

If this flag is enabled (as well as agentAvailabilityEnabled) then visitors will be presented with a form allowing them to leave a message if no agents are available. This will create a support ticket. Defaults to true.

Optional preChatFormEnabled

preChatFormEnabled?: boolean

If true, visitors are prompted for information in a conversational manner prior to starting the chat. Defaults to true.

Optional preChatFormFieldsStatus

preChatFormFieldsStatus?: PreChatFormFieldsStatus

These flags allow you to configure how a pre-chat form will appear to your visitors.

Optional transcriptEnabled

transcriptEnabled?: boolean

If true, visitors will be prompted at the end of the chat if they wish to receive a chat transcript or not. Defaults to true.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc