Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The node "Zappfy API" allows interaction with the Zappfy service, specifically providing operations related to chat management. The "Chat" resource with the "Procurar Status" (Find Status) operation enables users to search for status messages associated with a specific contact and message ID within a given instance of the Zappfy platform.

This node is useful in scenarios where you need to programmatically retrieve the status of messages (such as delivery or read receipts) for a particular contact in a WhatsApp-like environment managed by Zappfy. For example, it can be used to monitor message statuses for customer support chats or marketing campaigns.

Properties

Name Meaning
Nome Da Instância The name of the Zappfy instance where the chat data resides.
Contato The contact number (remote JID) whose message status you want to find.
ID Da Mensagem The unique identifier of the message for which the status is being queried.
Página The page number of the results to retrieve (for pagination).
Quantidade Por Página The number of status messages to return per page (pagination size).

Output

The node outputs a JSON array containing the status messages found based on the input parameters. Each item in the output array represents a status message related to the specified contact and message ID, including details such as delivery or read status.

No binary data output is indicated by the source code or properties.

Dependencies

  • Requires an active connection to the Zappfy API service.
  • Needs an API authentication credential configured in n8n to authorize requests to Zappfy.
  • 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" parameters are correctly set to "chat-api" and "find-status-messages" respectively.
  • Missing Required Parameters: Ensure all required fields ("Nome Da Instância", "Contato", "ID Da Mensagem") are provided; missing these will likely cause request failures.
  • API Authentication Issues: Confirm that the API key or authentication token is valid and properly configured in n8n credentials.
  • Pagination Errors: If no results are returned, check if the page number and offset values are within valid ranges.

Links and References

Discussion