Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The node "Zappfy API" enables interaction with the Zappfy service, specifically providing operations on various resources such as chat messages. For the Chat resource and the Delete Message operation, this node allows users to delete a specific message from a chat instance.

This is useful in scenarios where you want to programmatically remove messages sent or received by a particular WhatsApp instance managed via Zappfy. For example, automating message cleanup, retracting sent messages, or managing chat histories.

Properties

Name Meaning
Nome Da Instância The name of the WhatsApp instance from which the message will be deleted.
Contato The contact number (chat ID) associated with the message to delete.
ID Da Mensagem The unique identifier of the message that should be deleted.
Mensagem É Minha Boolean indicating if the message was sent by the instance itself (true) or received (false).
Número Do Participante The participant's number who sent the message; required only if the message was not sent by the instance (Mensagem É Minha is false).

Output

The node outputs a JSON array containing the result of the delete message operation. Typically, this would include confirmation of deletion or any relevant status information returned by the Zappfy API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Zappfy API.
  • Requires an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
  • The base URL for API requests is https://docs.zappfy.io/api-reference.

Troubleshooting

  • Operation Not Supported Error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "chat" and "delete-message" respectively.
  • Missing Required Parameters: Ensure all required properties (Nome Da Instância, Contato, ID Da Mensagem, Mensagem É Minha, and conditionally Número Do Participante) are provided. Missing these will cause the API call to fail.
  • Authentication Errors: Confirm that the API key credential is valid and has sufficient permissions to delete messages.
  • Message Not Found: If the message ID does not exist or is incorrect, the API may return an error indicating the message cannot be found or deleted.
  • Permission Issues: Deleting messages not sent by the instance might require additional permissions or specifying the participant number correctly.

Links and References

Discussion