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 via its API. Specifically for the Chat resource and the Ler Mensagens (Read Messages) operation, it enables users to retrieve a specific message from a chat instance by providing identifying details such as the instance name, contact number, and message ID. This is useful in scenarios where you want to programmatically access historical or specific chat messages for processing, logging, or automation workflows.

Practical examples include:

  • Fetching a particular message to analyze its content or metadata.
  • Integrating chat message retrieval into customer support automation.
  • Archiving or monitoring chat conversations based on message IDs.

Properties

Name Meaning
Nome Da Instância The name of the chat instance from which to read the message.
Contato The contact's phone number associated with the chat conversation.
ID Da Mensagem The unique identifier of the message to be retrieved.
Mensagem É Minha Boolean flag indicating if the message was sent by the instance itself (true) or not (false).

Output

The node outputs an array of JSON objects representing the retrieved message(s). Each object contains the data of the requested message, including its content and metadata as returned by the Zappfy API.

If the node supports binary data output (not explicitly shown in the provided code), it would typically represent media attachments or files related to the message.

Dependencies

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

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 "read-messages" for this functionality.
  • Missing Required Parameters: All properties (Nome Da Instância, Contato, ID Da Mensagem, and Mensagem É Minha) are required. Omitting any will likely cause errors or failed API calls.
  • API Connectivity Issues: Network problems or invalid API credentials can cause failures. Verify your API key/token and network connectivity.
  • Invalid Message ID or Contact: Providing incorrect identifiers may result in no data returned or API errors. Double-check these values.

Links and References

Discussion