Versions Compared

Old Version 8

changes.mady.by.user Gabriele Verde

Saved on

compared with

New Version Current

changes.mady.by.user Gabriele Verde

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • TEXT

  • IMAGE

  • DOCUMENT

  • MENU

  • QUICK_REPLY

  • FORM

Text message

To define a text response, simply select "Text Response" from the possible response options and type one or more messages.

...

The title of the card is used as the header of the menu, also the subtitle can be configured, while for each single option the relative label and its value are configured, which can be a link to open a new page or a phrase which, if chosen as an answer, will be sent back to the bot.

...

Property

Required

Description

target

Status
colourRed
titleYES

The target attribute specifies where to open the link.

Possible values:

  • _blank

  • _self

  • _parent

  • _top

Example

Menu with 3 options: a link, a query for the bot and another link, in this order.

...

To be able to insert more than 3 menu items, since the card allows you to insert a maximum of 3 options, it is necessary to follow the procedure below:

  • Add another "card" type response

  • Fill in the "title" field with the SAME title inserted in the original card (this is to link the options of the two menus together in a single menu)

  • As for the options, the same general rules of the menu apply, so, for example, in the case of url, a parameter called "target _ <# num>" must be added, with the number <#num> corresponding to the menu item that represents the url (with numbering starting from 1) and whose value corresponds to the location where you want to open the url.

Example

Menu with 7 options, including 4 url ​​in positions 2,3,4,7 and 3 queries to the bot.

...

Quick reply (Whatsapp interactive button)

To configure a quick reply, select a channel that supports this type of response (eg. Telegram), then select the "Quick Replies" type response and configure it with the title and the text options. A maximum of 3 options are allowed. In addition, it’s possible to add header and footer to the response using the following parameters:

Property

Required

Description

header

Status
titleno

Header of the quick reply

footer

Status
titleno

Footer of the quick reply

Example

Quick reply configured with header, footer, title and three options:

...

Image Added

Form

To return a form as a response, we use “Custom Payload” to configure the object structure sent.

So, remove the text response and click on the button “Add Responses” and select the option “Custom Paylod” to define the object structure.

Image AddedImage Added

The object must have all the following parameters (all required):

Property

Type

Description

response_to_bot

Status
titlestring

Query sent back to the bot after the form is submitted by the customer

title

Status
titlestring

title of the form to be displayed

type

Status
titlestring

must be equal to “form”

formData

Status
titlearray

array of objects representing the inputs of the form. See table below for details

formData Object

Property

Type

Description

customMandatoryErrorMessage

Status
titlestring

label to be displayed in case a mandatory input is not submitted by the customer

isVisibleAgent

Status
titleboolean

indicates if the content is intended or not to be shown to agent for privacy reason

mode

Status
titlestring

it describes how to use the value field. “manual” the value is used as default value, “auto” it's evaluated as a JS function

name

Status
titlestring

key name of the input field (must be unique)

isEditable

Status
titleboolean

False if user is not allowed to change default value, true otherwise

isMandatory

Status
titleboolean

true if the field is required, false otherwise

dc_type

Status
titlestring

Type of field.

Supported values are:

  • text

  • email

value

Status
titlestring

if mode is manual it has to be set with an empty string (then it will contain the customer response), if auto it's evaluted as a JS function returning a value

custom_regexp

Status
titlestring

Regular expression for validating input

isVisibleCustomer

Status
titleboolean

indicates if the field is intended or not to be shown to the customer. (eg: a field with mode “auto” could be hidden)

label

Status
titlestring

field label to be displayed

customValidationErrorMessage

Status
titlestring

label to be displayed in case an input is not valid according to the custom_regexp configured

Example

Example of custom payload:

Code Block
languagejson
{
  "response_to_bot": "operatore",
  "title": "Titolo Form",
  "type": "form",
  "formData": [
    {
      "customMandatoryErrorMessage": "Nome obbligatorio",
      "isVisibleAgent": true,
      "mode": "manual",
      "name": "name",
      "isEditable": true,
      "isMandatory": true,
      "dc_type": "text",
      "value": "",
      "custom_regexp": "",
      "isVisibleCustomer": true,
      "label": "Nome",
      "customValidationErrorMessage": ""
    },
    {
      "isEditable": true,
      "isVisibleAgent": true,
      "custom_regexp": "",
      "value": "",
      "mode": "manual",
      "name": "surname",
      "isMandatory": true,
      "customValidationErrorMessage": "",
      "customMandatoryErrorMessage": "Cognome obbligatorio",
      "isVisibleCustomer": true,
      "dc_type": "text",
      "label": "Cognome"
    },
    {
      "isVisibleCustomer": true,
      "dc_type": "email",
      "value": "",
      "isMandatory": true,
      "customValidationErrorMessage": "Email non valida",
      "mode": "manual",
      "isEditable": true,
      "label": "Email",
      "customMandatoryErrorMessage": "Email obbligatoria",
      "isVisibleAgent": true,
      "name": "email2",
      "custom_regexp": ".*@.*"
    }
  ]
}