UazAPI icon

UazAPI

Integração completa com UazAPI - 90+ endpoints para automação WhatsApp

Overview

The node integrates with the UazAPI service, which provides extensive WhatsApp automation capabilities through over 90 endpoints. Specifically, for the Campaign resource and the Control Campaign operation, this node allows users to manage ongoing WhatsApp mass messaging campaigns by performing control actions such as stopping, continuing, or deleting a campaign.

This functionality is useful in scenarios where you need to programmatically manage the lifecycle of marketing or notification campaigns sent via WhatsApp. For example, if a campaign needs to be paused due to an error or compliance reason, or resumed after a temporary halt, or completely deleted when no longer needed, this node operation facilitates those controls directly from an n8n workflow.

Practical examples:

  • Stop a running WhatsApp broadcast campaign when a critical issue is detected.
  • Resume a paused campaign after resolving issues.
  • Delete an outdated campaign to clean up resources.

Properties

Name Meaning
Folder ID The unique identifier of the campaign folder to control (i.e., the specific campaign).
Action The control action to perform on the campaign. Options: Stop, Continue, Delete.

Output

The output is a JSON object representing the response from the UazAPI endpoint that manages campaign control. This typically includes status information about the requested action (e.g., confirmation that the campaign was stopped, continued, or deleted).

No binary data output is involved in this operation.

Example output structure (simplified):

{
  "success": true,
  "message": "Campaign stopped successfully",
  "folder_id": "abc123"
}

Dependencies

  • Requires an active connection to the UazAPI service.
  • Requires valid API credentials configured in n8n for authentication with UazAPI.
  • The base URL for the API is taken from the credential configuration.
  • The node uses HTTP requests authenticated via these credentials to communicate with UazAPI.

Troubleshooting

  • Common issues:

    • Invalid or missing Folder ID: Ensure the Folder ID corresponds to an existing campaign.
    • Insufficient permissions or invalid API credentials: Verify that the API key/token used has rights to control campaigns.
    • Network or connectivity problems: Check that the base URL and network access to UazAPI are correct.
  • Error messages:

    • "error": "Invalid folder_id" — The provided Folder ID does not exist or is malformed.
    • "error": "Unauthorized" — Authentication failed; check API credentials.
    • "error": "Action not allowed" — The requested action may not be permitted in the current campaign state.
  • Resolution tips:

    • Double-check input parameters for correctness.
    • Confirm API credentials and their permissions.
    • Review UazAPI documentation or logs for more detailed error context.

Links and References

  • UazAPI Official Documentation (hypothetical link, replace with actual if available)
  • WhatsApp Business API concepts for campaign management
  • n8n HTTP Request node documentation for understanding request handling

This summary focuses solely on the static analysis of the execute() method related to the Campaign resource's Control Campaign operation, based on the provided source code and property definitions.

Discussion