N8N Tools - Uazapi icon

N8N Tools - Uazapi

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

Actions37

Overview

This node integrates with the Uazapi WhatsApp API to manage WhatsApp messages and related operations. Specifically, the Message - Mark as Read operation allows users to mark a particular WhatsApp message as read programmatically. This is useful in automation workflows where you want to update message status after processing or responding to messages, ensuring that the message state is synchronized between your system and WhatsApp.

Practical examples include:

  • Automatically marking incoming messages as read after extracting their content.
  • Updating message status in customer support workflows to reflect handled conversations.
  • Synchronizing read receipts in multi-agent environments.

Properties

Name Meaning
Additional Fields Optional extra parameters for the message operation:
- Reply to Message ID: ID of the message to reply to
- Delay (seconds): Delay before sending the message
- Disable Link Preview: Option to disable link previews in messages
- Mention Users: Comma-separated phone numbers to mention in the message
Phone Number The WhatsApp number (with country code) associated with the message to mark as read
Message ID The unique identifier of the message to mark as read

Note: For the "Mark as Read" operation, the key required properties are phoneNumber and messageId. The additional fields can be used if needed but are optional.

Output

The node outputs a JSON object representing the response from the Uazapi API after attempting to mark the message as read. The structure typically includes confirmation of the action or error details if the operation failed.

Example output JSON structure:

{
  "status": "success",
  "message": "Message marked as read",
  "data": {
    "instance": "instance_id",
    "number": "5511999999999",
    "messageId": "unique_message_id"
  }
}

If an error occurs, the output will contain an error field with the error message.

The node does not output binary data for this operation.

Dependencies

  • Requires an active Uazapi WhatsApp API account.
  • Needs an API authentication token and instance ID configured in the node credentials.
  • The node sends requests through a proxy endpoint (https://n8ntools.io/api/v1/proxy/uazapi) using an API key credential for authentication.
  • Proper configuration of the API URL, token, and instance ID is necessary for successful operation.

Troubleshooting

  • Common Issues:

    • Invalid or missing messageId: The API requires a valid message ID to mark it as read.
    • Incorrect phoneNumber format: Must include country code without symbols or spaces.
    • Authentication errors due to invalid API token or instance ID.
    • Network or proxy issues preventing communication with the Uazapi service.

  • Error Messages:

    • "Unauthorized" or "Invalid token": Check API token and credentials.
    • "Message not found": Verify the message ID exists and belongs to the specified phone number.
    • "Instance not found": Confirm the instance ID is correct and active.

  • Resolutions:

    • Double-check all input parameters for correctness.
    • Ensure credentials are up to date and have proper permissions.
    • Test connectivity to the Uazapi API outside n8n to isolate network issues.
    • Use the node's "Continue on Fail" option to handle errors gracefully in workflows.

Links and References

Discussion