Request Rich Menu by Name

Element name: Request Rich Menu by Name

Category: Variable manipulation

Description: Triggers a request to the user based on a List-type entity. The request form is enriched with additional values that improve its appearance. It pauses Lynn's control flow until the user enters the required value.

Functionality: Extension module that allows requesting a menu with rich multimedia content such as video, image, or document, specifically oriented for the WhatsApp channel.

The following parameters should be considered for its configuration:

Action Configuration

Name: String field to enter the unique identifier of the component within the flow.

Name of the List-type Entity: Select field to choose the List-type entity to be displayed to the client.

Menu text obtained from an expression (optional): String expression field used to define the text displayed as the menu header. If left empty, the default text from the entity will be used. This allows the creation of dynamic headers, concatenating with entities if needed.

Menu options obtained from an expression (optional): String expression field to dynamically define the menu options. The values must follow the structure ["val 1", "val 2"]. If left blank, the options defined in the selected entity will be used. You can also concatenate entities, for example: '["Custom Option 1","+ent2+"]', where the entity ent2 is appended.

Header type: Select field to define the menu's header type. Available options: text, image, video, document, or none.

Important

If you choose any option other than "none", the section Text-Video-Image-Document Header Settings will be enabled.

Allow null or empty value: Boolean field. "Yes" allows no selection by the user; "No" enforces a valid option.

Maximum failed attempts: Number field to define how many invalid responses the client can give. If the limit is reached, the configured error intent will be triggered.

Invalid value message (obtained from an expression): String expression that defines the error message shown to the client upon invalid input.

Intent to execute when the maximum number of failed attempts is reached: Select field to define which intent will be triggered after reaching the maximum attempt limit. The error will be passed to the variable Request_Rich_Menu_Error.

Override channel configuration to present the menu: Choose Yes to override the default channel configuration, or No to keep it.

Presentation format: Select field to choose how the menu will be displayed in WhatsApp. Options:

Text: plain text message.
Button: interactive buttons.
List: dropdown-style list.

Language for default interactive menu texts: Language options configured within the Lynn platform.

Expression to obtain footer text: String expression to define the footer content that accompanies the menu.

Text-Video-Image-Document Header Settings (Optional)

For Text headers:

Expression to obtain text header content: String expression to define the textual header content.

For Video headers:

Expression to obtain video header URL: String expression defining the video URL.
Expression to obtain video content type: String expression defining the content type of the video.
Expression to obtain video file name: String expression defining the name of the video file.

For Image headers:

Expression to obtain image header URL: String expression defining the image URL.

For Document headers:

Expression to obtain document header URL: String expression defining the document URL.
Expression to obtain document content type: String expression defining the document content type.

-- Requirements:

You must first create a menu-type entity: prueba_menu <--- Choose one of the options:

-- Input:

Name: PruebamenuRRMBN
List-type entity name: prueba_menu
Menu text: 'Seleccione la demo a mostrar'
Menu options: '["Demo E-Bank","Demo Proactive"]'
Header type: Image
Allow null or empty: No
Maximum failed attempts: 3
Invalid value message: 'Seleccione una opción válida'
Error handling intent: Error_Handler

Footer Configuration (Optional)

Footer expression: 'Descubre nuestros servicios'

Image Header Configuration (Optional)

Image URL expression: 'https://lynnlatamtestingbrstr.blob.core.windows.net/icons/EbankDise%C3%B1oImagen%20MEnu.png'

--- Result:

Below is an example showing the configured image as the Header and the menu linked to the “prueba_menu” entity.

Table of Contents