Skip to content
OpenDialogOpenDialog Docs
opendialog.aiTalk to an expert

Image Message

This page describes where to use and find an image message type

What is an image message?

Section titled “What is an image message?”

With image messages we can display an image in the chat window with an optional embedded clickable link. An image message involves sending an image to the user as part of the interaction. An image message consists of a visual element—such as a photograph, illustration, graphic, or screenshot—delivered within a chatbot conversation. Images can convey information quickly and effectively, often more so than text alone.

Example of an image block message

When to use an image message?

Section titled “When to use an image message?”

We can use image messages in any part of the conversation we would like to lend visual expression. If we would like to help users to identify important documents that they need to complete their task, or to punctuate certain milestones during their interaction, we can do so with images.

How to create an image message

Section titled “How to create an image message”

To add an image you will need to first host the image somewhere external from OpenDialog; either on your website or in an Amazon S3 bucket, then paste in the URL to the Image Source field. See the example below.

Optionally, you can add a link in the URL field. This will allow users to be redirected to the referenced website if they click the image directly within the chat window. If you would like the website to open in a new tab, be sure to tick the Link opens in a new tab box at the bottom of the message block.

Via the no-code image message in Message Editor

Section titled “Via the no-code image message in Message Editor”

Navigate to the Message Editor and create an image block by clicking the Add image block icon in the Layout section.

How to create an image message in the no-code image message block

Via the custom message in Message Editor

Section titled “Via the custom message in Message Editor”

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

Fill in the template with the properties 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.

How to create an image message in the custom message block

XML Snippet

Section titled “XML Snippet”

Displays an image message. Optionally, the image can also be a link that can optionally open in a new tab if the url property is included.

<message>
    <image-message>
        <src>{img_src}</src>
        <url new_tab="{true|false}">{url}</url>
    </image-message>
</message>

Properties

Section titled “Properties”

<src> a url link to the website where your audio file is being hosted.
<url> is the link that you would like to embed in the image as a clickable link.
<url new_tab a boolean that, if set to true, opens the linked website in a new tab.

Example

<message>
    <image-message>
      <src>https://docs.opendialog.ai/img/od-logo-with-credit.jpg</src>
      <url new_tab="true">https://docs.opendialog.ai</url>
    </image-message>
</message

How to use an image message

Section titled “How to use an image message”

How to construct an image message

Section titled “How to construct an image message”

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 Constructing Messages page for more information.