N8N Tools - Uazapi icon

N8N Tools - Uazapi

Complete Uazapi integration - Premium WhatsApp API with advanced messaging and automation

Actions37

Overview

This node enables sending interactive WhatsApp list messages via the Uazapi WhatsApp API integration. It is designed to send a message containing a header text and a selectable list of items to a specified WhatsApp phone number. This functionality is useful for scenarios where you want to present users with multiple options in a structured format, such as menus, product catalogs, or service selections.

Practical examples:

  • Sending a restaurant menu with categories and dishes as list items.
  • Providing a customer support menu with different topics to choose from.
  • Offering a selection of available appointments or services.

Properties

Name Meaning
Phone Number The recipient's WhatsApp number including country code (e.g., 5511999999999).
Message Text The header text displayed at the top of the interactive list message.
List Items A collection of list entries, each with:
- Title: The title of the list item.
- Description: Additional descriptive text for the item.
- ID: A unique identifier for the item, used to track user selection.
Additional Fields Optional extra settings:
- Reply to Message ID: ID of a message to reply to.
- Delay (seconds): Time delay before sending the message.
- Disable Link Preview: Option to disable link previews in the message.
- Mention Users: Comma-separated phone numbers to mention in the message.

Output

The node outputs a JSON object representing the response from the Uazapi WhatsApp API after attempting to send the list message. This typically includes status information about the sent message, any message IDs generated, and error details if the request failed.

If the operation succeeds, the output JSON confirms the message was sent and may include metadata such as message identifiers.

No binary data output is produced by this operation.

Dependencies

  • Requires an active Uazapi WhatsApp API account with valid credentials:
    • An API key credential.
    • API token.
    • Instance ID.
    • API base URL.
  • The node uses these credentials to authenticate and communicate with the Uazapi REST API endpoints.
  • Proper configuration of these credentials within n8n is necessary for successful operation.

Troubleshooting

  • Common issues:

    • Invalid or missing phone number format (must include country code).
    • Empty or improperly formatted list items (each item requires a title and unique ID).
    • Authentication errors due to incorrect API token or instance ID.
    • Network connectivity problems preventing access to the Uazapi API endpoint.

  • Error messages:

    • Errors returned from the API will be included in the output JSON under an error field if the node is set to continue on failure.
    • Common error messages might indicate invalid parameters, unauthorized access, or rate limiting.

  • Resolutions:

    • Verify phone number formatting and ensure all required fields are provided.
    • Check that the API credentials are correctly configured and have not expired.
    • Ensure the Uazapi service is reachable from your network environment.
    • Use the "Reply to Message ID" field only with valid existing message IDs.

Links and References

Discussion