MegaAPI icon

MegaAPI

Interact with MegaAPI WhatsApp service

Actions35

Message → Send List Message

AI-generated

Overview

This node operation sends an interactive list message to a specified WhatsApp contact using the MegaAPI WhatsApp service. It allows users to present a list of selectable options organized into sections, which the recipient can interact with directly within WhatsApp. This is useful for scenarios such as payment method selection, menu choices, or any situation where you want to provide multiple options for the user to choose from in a structured format.

Use Case Examples

  1. Sending a payment options list to a customer where they can select between PIX or credit card payment methods.
  2. Providing a menu list in a customer support chat to let users select the type of assistance they need.

Properties

Name Meaning
To (Contact) The WhatsApp contact to send the list message to, formatted as phone_number@s.whatsapp.net.
Button Text The text displayed on the list button that the user clicks to open the list options.
Text The main text content of the list message that provides context or instructions.
Title The title of the list message, shown prominently at the top of the message.
Description The description text that appears below the title, providing additional details or instructions.
Sections (JSON) A JSON array defining the sections and rows of the list. Each section can have multiple rows with titles, descriptions, and row IDs.
List Type Defines whether the user can select a single option (Single Select) or multiple options (Multi Select) from the list.

Output

JSON

  • messageId - The unique identifier of the sent list message.
  • status - The status of the message sending operation (e.g., success or failure).
  • to - The WhatsApp contact to whom the list message was sent.

Dependencies

  • MegaAPI WhatsApp service with appropriate API credentials

Troubleshooting

  • Ensure the 'To (Contact)' field is correctly formatted as phone_number@s.whatsapp.net, otherwise the message will not be delivered.
  • Verify that the JSON in the 'Sections' field is valid and correctly structured to avoid errors in message sending.
  • Check API credentials and network connectivity if the message sending fails with authorization or connection errors.

Discussion