CodeChat - WhatsApp Free Api icon

CodeChat - WhatsApp Free Api

Rest api for communication with WhatsApp
Join our community

Actions6

Overview

This node enables sending WhatsApp list messages via a REST API. It is designed to send interactive list messages where the recipient can select from multiple sections and rows, making it useful for scenarios like customer support menus, product catalogs, or service options.

Typical use cases include:

  • Sending a menu of options to customers for self-service.
  • Presenting a list of products or services with descriptions.
  • Interactive communication where users choose from predefined choices.

For example, a business could send a list message with sections such as "Products" and "Support", each containing selectable rows that trigger further actions based on user selection.

Properties

Name Meaning
Recipient The phone number of the message recipient including country code (e.g., 5531900000000).
Delay Optional delay in milliseconds before sending the message (e.g., 1200 ms).
Presence Status to inform while sending the message. Options: Available, Composing, Empty, Paused, Recording, Unavailable.
Title Title of the list message shown at the top of the list.
Description Description text providing context or details about the list message.
Button Text Text displayed on the button that triggers the list message.
Footer Text Optional footer text shown at the bottom of the list message.
Sections JSON array defining sections of the list. Each section has a title and an array of rows. Rows contain title, description, and rowId.

Example of Sections property JSON structure:

[
  {
    "title": "Section Title",
    "rows": [
      {
        "title": "Row Title",
        "description": "Description",
        "rowId": "rowId01"
      }
    ]
  }
]

Output

The node outputs JSON data representing the response from the WhatsApp API after sending the list message. This typically includes confirmation of message delivery status and any metadata returned by the API.

If binary data were involved (not indicated here), it would represent media content sent or received, but this node focuses on JSON message payloads only.

Dependencies

  • Requires an API key credential for authenticating with the WhatsApp REST API.
  • Needs the base URL of the WhatsApp API instance configured in credentials.
  • Relies on the external WhatsApp API service to send messages.

Troubleshooting

  • Invalid phone number format: Ensure the recipient number includes the correct country code without extra characters.
  • Missing required fields: Title, Description, Button Text, and Sections are mandatory for list messages; omitting them will cause errors.
  • API authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
  • Delay not working: Confirm the delay value is a valid number in milliseconds.
  • Malformed JSON in Sections: The Sections property must be valid JSON; syntax errors will prevent message sending.

Common error messages may relate to invalid parameters or authentication failures. Checking the API response details helps identify specific issues.

Links and References

  • WhatsApp List Messages Documentation (official WhatsApp Business API docs)
  • n8n Custom Node Development Guide
  • JSON Schema Reference for List Message Sections

(Note: Replace above links with actual URLs relevant to your environment or documentation.)

Discussion