Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

This node, named "Zappfy API," allows interaction with the Zappfy service through its API. Specifically for the Chat resource and the Procurar Mensagens (Find Messages) operation, it enables users to search and retrieve chat messages from a specified contact within a given instance of the Zappfy platform. This is useful in scenarios where you want to programmatically access message history for analysis, backup, or integration with other systems.

Practical examples include:

  • Retrieving recent messages from a customer support chat to analyze conversation trends.
  • Exporting chat logs for compliance or auditing purposes.
  • Integrating chat data into CRM or helpdesk tools.

Properties

Name Meaning
Nome Da Instância The name of the Zappfy instance to connect to.
Contato The phone number or identifier of the contact whose messages you want to find.
Página The page number of the results to retrieve (for pagination). Defaults to 1.
Quantidade Por Página The number of messages to return per page. Defaults to 10.

Output

The node outputs an array of JSON objects representing the retrieved chat messages. Each object corresponds to a single message found in the specified contact's chat history. The exact structure of each message object depends on the Zappfy API response but typically includes fields such as message content, timestamp, sender information, and message ID.

If the node supports binary data output (not evident from the provided code), it would represent media or attachments related to messages; however, this is not explicitly shown here.

Dependencies

  • Requires an active connection to the Zappfy API service.
  • Needs an API authentication credential configured in n8n to authorize requests.
  • The base URL for API requests is https://docs.zappfy.io/api-reference.
  • No additional external dependencies are indicated.

Troubleshooting

  • Operation Not Supported Error: If you select an unsupported operation or resource, the node throws an error stating the operation is not supported. Ensure that the resource is set to "chat-api" and the operation to "find-messages" for this functionality.
  • Invalid Instance or Contact: Providing incorrect instance names or contact numbers may result in empty results or API errors. Verify these inputs carefully.
  • Pagination Issues: Requesting pages beyond the available range may return empty arrays. Adjust the "Página" and "Quantidade Por Página" properties accordingly.
  • Authentication Failures: Make sure the API key or authentication token is valid and properly configured in n8n credentials.

Links and References

Discussion