Skip to main content

Bot Register

The script name must match the pattern '%bot%register%'.

Input variables

Bot Session Create

The script name must match the pattern '%bot%session%create%'. Called when a new session starts on a channel with the bot activated.

Input values

Bot Session Change

The script name must match the pattern '%bot%session%change%'. This script is called when the session changes status (when pre-form is filled in by the customer).

Input values

Variables status.old and status.new contain old and new values for chat session status.

Chat session status values

Bot Message Receive

The script name must match the pattern '%bot%message%receive%'.

Input values

Bot Post Message

addChatMessage(Integer sessionId, String message, Integer type, String author, Integer specialType, String specialParams, DateTime whenPosted) Posting a message will set the chat session status to 6 (user last) since the bot was the last to speak.

Reset Chat

resetChat(Integer sessionId) This starts the session over (session status starts at the beginning again).

Change Status

setChatStatus(sessionId, Integer newStatus) This changes the session status. This may trigger the session changed event.

Chat message types

Chat message special types

17 means that the message has a list of clickable options. Options are as JSON array in specialParam.