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 functionalities. The "Enviar Presença" (Send Presence) operation under the "Chat" resource enables sending presence status updates such as "typing" or "recording" to a specified contact. This is useful in messaging scenarios where you want to indicate to the recipient that you are actively composing or recording a message, enhancing real-time communication feedback.

Practical examples include:

  • Indicating to a chat contact that you are typing a reply.
  • Showing that you are recording a voice message.
  • Automatically managing presence states during automated chat workflows.

Properties

Name Meaning
Nome Da Instância The name of the instance to identify which Zappfy environment or account to use.
Contato The contact number (remote JID) to whom the presence status will be sent.
Presença The type of presence to send; options are: "Escrevendo..." (composing) or "Gravando..." (recording).
Delay Duration in milliseconds for how long the presence status remains active before clearing.

Output

The node outputs a JSON array containing the response from the Zappfy API after attempting to send the presence update. The exact structure depends on the API response but generally confirms success or failure of the presence update action.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authenticating with the Zappfy API.
  • The base URL for API requests is https://docs.zappfy.io/api-reference.
  • Proper configuration of the API credential within n8n is necessary.
  • Network access to the Zappfy API endpoint must be available.

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 "send-presence" respectively.
  • Authentication errors: Ensure the API key credential is valid and has the required permissions.
  • Invalid contact number: The "Contato" property must be a valid identifier recognized by the Zappfy API; incorrect formatting may cause failures.
  • Timeouts or delays: The "Delay" property controls how long the presence is active; setting it too low might not give enough time for the presence to be noticed, while too high could cause unexpected behavior.
  • Network issues: Confirm network connectivity to the Zappfy API endpoint.

Links and References

Discussion