Zappfy APIInstall

Overview

The node "Zappfy API" enables interaction with the Zappfy messaging platform via its API. Specifically, for the resource "Mensagem" and operation "Enviar Audio," it allows sending audio messages to a specified recipient through a given instance of the Zappfy service. This is useful in scenarios where automated or programmatic audio message delivery is needed, such as customer support voice notifications, marketing campaigns, or alert systems.

For example, you can configure this node to send an audio clip (provided as a URL or base64 string) to a user's phone number after a certain delay, automating voice communication workflows.

Properties

Output

The node outputs a JSON array containing the response from the Zappfy API after attempting to send the audio message. The exact structure depends on the API response but typically includes status information about the message delivery.

If the node supports binary data output (not explicitly shown here), it would represent media content or related binary attachments; however, in this case, the focus is on JSON responses confirming the message sending status.

Dependencies

• Requires an active connection to the Zappfy API.
• Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
• Internet access to reach https://docs.zappfy.io/api-reference (the base URL for the API).
• Proper configuration of the instance name and recipient number according to Zappfy's requirements.

Troubleshooting

• Common Issues:

  • Invalid or missing instance name may cause the API call to fail.
  • Incorrect recipient number format could lead to message delivery errors.
  • Providing an invalid or inaccessible audio URL/base64 string will prevent the audio from being sent.
  • Network connectivity issues might block access to the Zappfy API endpoint.

• Error Messages:

  • "Operação não suportada." indicates that the selected operation is not implemented or recognized by the node. Ensure the resource and operation names are correct.
  • API errors returned from Zappfy (e.g., authentication failures, invalid parameters) will be passed through and should be checked against Zappfy's documentation.

• Resolutions:

  • Verify all required properties are correctly filled.
  • Confirm the API key credential is valid and has necessary permissions.
  • Check the audio input format and accessibility.
  • Review network settings and firewall rules if connectivity issues arise.

Links and References

• Zappfy API Documentation – Official API reference for detailed endpoint and parameter information.