Full Page Message

When full page messages are received, they will take over the entire chatbot screen (depending on what is supported by each platform)

When to use full page messages

Rich and Form messages can also be presented as 'full page' messages. When full page messages are received, they will take over the entire chatbot screen (depending on what is supported by each platform). For webchat full page messages, the user input is also taken over.

Full page rich messages are defined in exactly the same way as standard rich messages.

Full Page Form messages are defined in exactly the same way as form messages, but with a different element name.

Optionally, the full page form message can contain a cancel button. This allows the user to tell the bot they do not want to submit the form. When clicked, the value of cancel_callback is sent.

How to create a full page message

Via the custom message in Message Editor - rich message

Navigate to the Message Editor and create a Custom Message. Select fp-rich-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.

Via the custom message in Message Editor - form message

Navigate to the Message Editor and create a Custom Message. Select fp-form-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.

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 here.

XML Snippet

Full page rich message

<fp-rich-message>

-- THIS MUST BE THE LAST MESSAGE IN THE LIST TO WORK AS EXPECTED -->
  <title>Rich Message</title>
  <subtitle>With a subtitle</subtitle>
  <text>Some engaging text</text>
  <image>
    <src>https://gblobscdn.gitbook.com/spaces%2F-MOzV9Wk3YsltjoDUyen%2Favatar-1608658264352.png?alt=media</src>
    <url new_tab="true">https://docs.opendialog.ai</url>
  </image>
</fp-rich-message>

Full page form message

<fp-form-message>

-- THIS MUST BE THE LAST MESSAGE IN THE LIST TO WORK AS EXPECTED -->
  <text>Text</text>
  <submit_text>Submit Text</submit_text>
  <callback>Callback</callback>
  <auto_submit>false</auto_submit>

  <element>
    <element_type>select</element_type>
    <name>title</name>
    <display>Title</display>
    <options>
      <option>
        <key>mr</key>
        <value>Mr.</value>
      </option>
      <option>
        <key>mrs</key>
        <value>Mrs.</value>
      </option>
      <option>
        <key>other</key>
        <value>Other</value>
      </option>
    </options>
  </element>

  <element>
    <element_type>text</element_type>
    <name>name</name>
    <display>Name</display>
  </element>

</fp-form-message>

The cancel button can be added to a form message with the following mark up:

    <fp-form-message>
       <text>Text</text>
       <submit_text>Submit Text</submit_text>
       <callback>Callback</callback>
       <auto_submit>true|false</auto_submit>
       <cancel_text>Text</cancel_text>
       <cancel_callback>Callback</cancel_callback>
    </fp-form-message>

Last updated