OpenDialog Docs
opendialog.aiStart BuildingTalk to an expert
  • GETTING STARTED
    • Introduction
    • Getting ready
    • Billing and plans
    • Quick Start AI Agents
      • Quick Start AI Agent
      • The "Start from Scratch" AI Agent
        • Chat Management Conversation
        • Welcome Conversation
        • Topic Conversation
        • Global No Match Conversation
        • Supporting LLM Actions
        • Semantic Classifier: Query Classifier
      • A Process Handling AI Agent
  • STEP BY STEP GUIDES
    • AI Agent Creation Overview
    • Add a new topic of discussion
    • Use knowledge sources via RAG
    • Adding a structured conversation
    • Add a 3rd party integration
    • Test and tweak your AI Agent
    • Publish your AI Agent
  • CORE CONCEPTS
    • OpenDialog Approach
      • Designing Conversational AI Agents
    • OpenDialog Platform
      • Scenarios
        • Conversations
        • Scenes
        • Turns and intents
      • Language Services
      • OpenDialog Account Management
        • Creating and managing users
        • Deleting OpenDialog account
        • Account Security
    • OpenDialog Conversation Engine
    • Contexts and attributes
      • Contexts
      • Attributes
      • Attribute Management
      • Conditions and operators
      • Composite Attributes
  • CREATE AI APPLICATIONS
    • Designing your application
      • Conversation Design
        • Conversational Patterns
          • Introduction to conversational patterns
          • Building robust assistants
            • Contextual help
            • Restart
            • End chat
            • Contextual and Global No Match
            • Contextual FAQ
          • Openings
            • Anatomy of an opening
            • Transactional openings
            • Additional information
          • Authentication
            • Components
            • Example dialog
            • Using in OpenDialog
          • Information collection
            • Components
            • Example dialog
            • Using in OpenDialog
            • Additional information
          • Recommendations
            • Components
            • Example dialog
            • Additional information
          • Extended telling
            • Components
            • Example dialog
            • Additional information
          • Repair
            • Types of repair
            • User request not understood
            • Example dialog
            • Additional information
          • Transfer
            • Components
            • Example dialog
            • Additional information
          • Closing
            • Components
            • Example dialog
            • Using in OpenDialog
            • Additional information
        • Best practices
          • Use Case
          • Subject Matter Expertise
          • Business Goals
          • User needs
            • Primary research
            • Secondary research
            • Outcome: user profile
          • Assistant personality
          • Sample dialogs
          • Conversation structure
          • API Integration Capabilities
          • NLU modeling
          • Testing strategy
          • The team
            • What does a conversation designer do
          • Select resources
      • Message Design
        • Message editor
        • Constructing Messages
        • Message Conditions
        • Messages best practices
        • Subsequent Messages - Virtual Intents
        • Using Attributes in Messages
        • Using Markdown in messages
        • Message Types
          • Text Message
          • Image Message
          • Button Message
          • Date Picker Message
          • Audio Message
          • Form Message
          • Full Page Message
          • Conversation Handover message
          • Autocomplete Message
          • Address Autocomplete Message
          • List Message
          • Rich Message
          • Location Message
          • E-Sign Message
          • File Upload Message
          • Meta Messages
            • Progress Bar Message
          • Attribute Message
      • Webchat Interface design
        • Webchat Interface Settings
        • Webchat Controls
      • Accessibility
      • Inclusive design
    • Leveraging Generative AI
      • Language Services
        • Semantic Intent Classifier
          • OpenAI
          • Azure
          • Google Gemini
          • Output attributes
        • Retrieval Augmented Generation
        • Example-based intent classification [Deprecated]
      • Interpreters
        • Available interpreters
          • OpenDialog interpreter
          • Amazon Lex interpreter
          • Google Dialogflow
            • Google Dialogflow interpreter
            • Google Dialogflow Knowledge Base
          • OpenAI interpreter
        • Using a language service interpreter
        • Interpreter Orchestration
        • Troubleshooting interpreters
      • LLM Actions
        • OpenAI
        • Azure OpenAI
        • Output attributes
        • Using conversation history (memory) in LLM actions
        • LLM Action Analytics
    • 3rd party Integrations in your application
      • Webhook actions
      • Actions from library
        • Freshdesk Action
        • Send to Email Action
        • Set Attributes Action
      • Conversation Hand-off
        • Chatwoot
    • Previewing your application
    • Launching your application
    • Monitoring your application
    • Debugging your application
    • Translating your application
    • FAQ
    • Troubleshooting and Common Problems
  • Developing With OpenDialog
    • Integrating with OpenDialog
    • Actions
      • Webhook actions
      • LLM actions
    • WebChat
      • Chat API
      • WebChat authentication
      • User Tracking
      • Load Webchat within page Element
      • How to enable JavaScript in your browser
      • SDK
        • Methods
        • Events
        • Custom Components
    • External APIs
  • Release Notes
    • Version 3 Upgrade Guide
    • Release Notes
Powered by GitBook
On this page
  • What is a text message?
  • When to use a text message?
  • How to create a text message
  • Via the no-code text message in Message Editor
  • Via the custom message in Message Editor
  • How to use a text message
  • Displaying large language model responses in a text message
  • How to construct a text message
  1. CREATE AI APPLICATIONS
  2. Designing your application
  3. Message Design
  4. Message Types

Text Message

This page describes where to use and find a text message type

PreviousMessage TypesNextImage Message

Last updated 11 months ago

What is a text message?

A text message is a plain message with only text and is the primary message block we use to communicate with the user. It conveys information plainly conversationally and can also be used as a preamble to user choices using buttons, forms, and other message types.

Certain best practices apply to text messages.

For example, we recommend limiting text messages to 240 characters so that the information is easy to scan and read.

It is also important to break certain chunks of information up into different text messages. This will make it easier for users to read and digest what they are reading.

For example, separating out informative messages from the actionable question in a separate text message.

For more information on best practices for constructing messages, you can check out the section of this documentation.

When to use a text message?

Text messages are a fundamental component of chatbot interactions, serving a wide array of purposes.

For example, to display welcomes and greetings, give instructions or guidance, and share basic information.

Text messages can display scripted information defined directly via the message editor or to display responses generated by a large language model.

How to create a text message

Via the no-code text message in Message Editor

If you would like to include a link in your text message, you can do this by pasting in the full URL in the message box. This will then be shown as a clickable link in OpenDialog's web chat Preview.

  • Open your OpenDialog application

  • Select the Scenario that you wish to edit

  • Select Design from the left hand panel and select Messages

  • Go into the message that you want to add a message block to

  • Add a 'Text' message block

  • Add in your own text to the fields you want to customise

  • To preview your message, go to the Preview section

Via the custom message in Message Editor

  • Open your OpenDialog application

  • Select the Scenario that you wish to edit

  • Select Design from the left hand panel and select Messages

  • Go into the message that you want to add a message block to

  • Add a 'Custom Message' block

  • Select 'Text message' from the drop down

  • Add in your own text to the fields you want to customise

  • To preview your message, go to the Preview section

XML Snippet

A plain message with only text. Specially formatted links can also be included in the text body

<message>
<text-message>{message-text}</text-message>
</message>

Properties

Example:

<message>
  <text-message> 
    Hello, this is a text message.
  </text-message>
</message>

Messages can also contain URLs in the text - that will be linkified. Links like opendialog.ai in the message text will be turned to links.

<message>
    <text-message> 
      You can have a link straing in text like this: hey go to opendialog.ai or you can do this:
  </text-message>
</message>

There is no support at the moment for any other formatting such as bold, italics etc

If you change your mind and select a different message type after generating the XML code, the new message code will be appended in the same window so make sure to delete the old message code.

How to use a text message

Saving a message: Always remember to hit 'Save Message' before closing or navigating away from the edit screen.

Displaying large language model responses in a text message

You can use a text message to display the responses from a large language model in your text message.

To do so, you can reference the attribute that contains the LLM response in the text message block as follows : {attribute_name}

For example, {llm_response}

How to construct a text message

Navigate to the and create a text block by clicking the Add text block icon in the Layout section. You can add as many text blocks to your message as required.

To use emojis in your text, you can copy and paste from a website such as . If you are on a Mac, you can bring up an emoji keyboard with control + command + space.

Navigate to the and create a Custom Message. Select text-message from the message type drop down menu and the field will automatically be populated with a code template.

Fill in the template with the of your particular message and when you are happy with it make sure to save your message and test it in the Test Preview chat window.

<text-message> Write the text you would like to display in your message here. Emojis can be inserted here too. For instructions see .

This requires you to configure the attribute the LLM response will get stored to. For more information on attributes, check out our section.

When structuring a message, you are able to use multiple different message blocks together to create the message that you are looking for. However, when it comes to ordering and structing these, there are some rules that need to be followed. To learn more about this, please head to the page for more information.

For all message types, a key element to take into consideration is Accessibility, especially for messages that include customisation with multimedia types such as buttons, images and links. For all information on accessibility within OpenDialog, please click .

Message Editor
https://emojihub.org/
Attribute Management
Constructing Messages
here
Message Editor
XML Snippet
properties
no-code text message
Constructing Messages
A video demonstration on how to use
Example of a text message in action
Where to find the text block button
Where to find the custom messages button and XML for text messages