Send List

Learn how to use the Send List node in the OwnChat WhatsApp Chatbot Builder to create dynamic and static lists for interactive messaging

Overview

The Send List node allows you to present users with a selectable list of options via the WhatsApp Cloud API. This feature can be configured to send either static or dynamic lists, enhancing user interaction by enabling them to choose from predefined options or options that adapt based on prior interactions.


Step-by-Step Instructions

  1. Add Send List Node: Start by selecting the Send List node in your OwnChat WhatsApp Chatbot Builder.

  2. Configure Header Text (optional): Input a heading for the message (max 60 characters). You can use variables for personalization, e.g., Hello {{customer.name}}.

  3. Set Body Text: Enter the main message (max 4096 characters). Include formatting options such as bold, italic, and emojis.

  4. Add Footer Text (optional): Input a footer message (max 60 characters) if desired.

  5. Specify Button Text: Define the button text that will open the list (max 20 characters).

  6. Choose List Type: Select between Static or Dynamic lists:

    • Static: Fixed options that will not change.

    • Dynamic: Options that can change based on user interactions and bot variables.

  7. Configure Options for Static List:

    • List Title: Title for the list (e.g., “Menu”).

    • Options: Add individual options (max 24 characters each).

    • Descriptions (optional): Additional context for each option (max 24 characters).

    • IDs (optional): Unique IDs for each option (automatically generated).

  8. Configure Options for Dynamic List:

    • Variable Name: Specify the variable holding the array of lists.

    • Variable Path: Indicate the path to access the array.

    • Variable Key Title, Description, ID: Define keys for titles, descriptions, and IDs for each list item.

  9. Error Handling:

    • Define the number of allowed incorrect attempts and the error message to be displayed.

    • Set actions for invalid inputs, such as ending the flow or triggering a fallback flow.

  10. Save Changes: After configuring the node, save your changes.


Action on Invalid: When the error attempts exceed the limit, precautions must be taken to run the bot effectively. The following two options are available:

  • Action on Invalid - End the Flow: This stops the flow entirely, and the user won’t continue in this flow anymore.

  • Action on Invalid - Fall Back Flow: This option allows you to trigger another action to handle this situation by selecting an action from a dropdown.


Static vs. Dynamic Lists:

  • Static Lists: Items are predefined and fixed. The same items will always be sent to the customer whenever this action is called.

  • Dynamic Lists: Items can change based on user interactions and bot variables. For instance, you can send details from an API response by storing that response in a bot variable and mapping the details in a dynamic list.


Examples

  • Static List Example:

    • Title: Menu

    • Options: Pizza, Pasta, Salad

    • Descriptions: Delicious pizza, Fresh pasta, Healthy salad

    • ID: Automatically generated for each option.

  • Dynamic List Example:

    • Variable Name: productList

    • Variable Path: response.products

    • Variable Key Title: product.title

    • Variable Key Description: product.description

    • Variable Key ID: product.id


Handling List Responses

When a user selects an item from the list, the selected response will be stored in a defined variable, for example, user_selection. You can access the details of the selected item through this variable.

  • Accessing Selected Item Details:

    • To access the ID of the selected item, you can use {variable.user_selection.id} in subsequent nodes.

    • The variable part {variable.user_selection} allows you to choose the bot variable from the dropdown, and by specifying the key (e.g., .id), you can retrieve the specific details.


Example Usage with Send Text Node

After a user selects an item from the list, you might want to send them details about their selection using the Send Text node. Here’s how you can do it:

  1. Add Send Text Node: After the Send List node, add a Send Text node to your chatbot flow.

  2. Configure Body Text: You can personalize the message using the selected item details. For example

Thank you for selecting {{variable.user_selection.title}}!

Here are the details:

- ID: {variable.user_selection.id}
- Description: {variable.user_selection.description}

Utilize Variables: Ensure that the variables correspond to the keys defined in your list structure to fetch the right data.

Understanding WhatsApp Cloud API Capabilities

The Send List node utilizes the WhatsApp Cloud API to enable interactive messaging, allowing for a richer user experience. By leveraging lists, chatbots can guide users through options, gather selections, and facilitate actions based on those choices, all while maintaining user engagement.


FAQs

  1. What is the maximum character limit for list options? Each option can have a maximum of 24 characters.

  2. How do I implement dynamic lists? Use a variable that holds the product information and configure the variable keys accordingly.

  3. What happens if the user doesn’t select an option? You can set an error message and define actions to handle invalid attempts.


Troubleshooting Tips

  • Ensure that variable paths are correct for dynamic lists.

  • Check the character limits for each field to avoid errors during message sending.

  • Review error handling configurations if users encounter issues selecting options.

Last updated