z-api by @jaimeflneto icon

z-api by @jaimeflneto

Interact with Z-API to send WhatsApp messages
Join our community

Actions50

Overview

This node operation sends a WhatsApp list message to a specified phone number using the Z-API service. It allows users to create interactive list messages with multiple sections and rows, each containing options that recipients can select. This is useful for scenarios like sending menus, surveys, or categorized options to WhatsApp users, enhancing engagement and interaction.

Use Case Examples

  1. Sending a restaurant menu with different food categories as list sections.
  2. Sending a survey with multiple choice questions grouped by topics.
  3. Providing a list of service options for customer support.

Properties

Name Meaning
Phone Number The recipient's phone number including country code, formatted as digits only without any special characters or spaces.
List Title The title of the list message that will be displayed to the recipient.
List Description An optional description providing additional context or information about the list.
Button Text The text displayed on the button that the recipient clicks to open the list options.
List Sections A JSON array defining the sections of the list, where each section has a title and rows. Each row must include an 'id', 'title', and optionally a 'description' to represent selectable options.
Options Additional optional settings such as delay for typing indicator, delay before sending the message, and the ID of a message to reply to.

Output

JSON

  • json - The JSON response from the Z-API service after sending the list message, typically including message status and metadata.

Dependencies

  • Requires Z-API credentials for authentication to send WhatsApp messages.

Troubleshooting

  • Ensure the phone number is correctly formatted with country code and contains only digits; otherwise, the message may fail to send.
  • Verify that the JSON structure for 'List Sections' is correctly formatted as an array of objects with required fields ('id', 'title') to avoid errors.
  • Delays for typing and message sending must be within the allowed range (0-15 seconds); values outside this range may cause errors.
  • If replying to a message, ensure the 'Reply Message ID' is valid and corresponds to an existing message to avoid failures.

Discussion