From Bright Pattern Documentation
< 5.19:AgentDesktop-client-side-javascript-api-specification
Revision as of 04:01, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 5.19


sendChatMessage

Sends a message on behalf of the agent during a chat interaction.

Request

Syntax

sendChatMessage(text: string, interactionId?: string): Promise<OperationResult<null>>

Parameters

Parameters Parameter Values Data Type Optional/Required Description
text String Required The message to be sent
interactionId String Optional The chat interaction in which the message will be sent. If the interactionId is omitted, the currently active interaction will be used.

Example Request

sendMessageButton.onclick = () => {

        const message = chatInput.value;

        const interactionId = interactionsList[0].interactionId;

        adApi.sendChatMessage(message, interactionId);

    };

Return Value

Null

< Previous | Next >