Message#

Display a message to inform the user.

Name	Description	Mandatory	Type	Possible Values	Default Value
message	Message to show to the user	N	`String`	`Object[]`
messageKey	Key that points to the answers object containing the message to send to the GUI	N	`String`
messageType	Type of message provided. Necessary to explain the gui how to render it. `Error` renders the message with error styling in the chat UI.	N	`Enum`	`String` `Error` `Entities`	`String`

Warning

Either message or a messageKey must be provided. if both are present, only message will be used.

Multi-language messages

message can also be an object mapping language codes to strings (for example, {"en": "Hello", "pt": "Olá"}), instead of a plain string. It is resolved to the text matching the user's current language, falling back to the configured default language if there is no exact match.

Example snippets#

{
    "type": "Message",
    "settings": {
        "message": "Hello World"
    },
    "next": "NextStep"
}

{
    "type": "Message",
    "settings": {
        "messageType": "Entities",
        "message": [{
            "$type": "...",
            "id": "14876234821"
        }]
    },
    "next": "NextStep"
}