Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

This node, named "Zappfy API," allows interaction with the Zappfy API to perform various operations related to messaging and media handling. Specifically, for the resource Chat and operation Obter Mídia Em Base64 ("Get Media in Base64"), it retrieves media content from a chat message by its ID and returns the media encoded as a Base64 string. It also optionally converts video media to MP4 format.

Common scenarios where this node is useful include:

  • Downloading media files (images, videos, audio) sent in chat messages for further processing or storage.
  • Converting video formats automatically to MP4 for compatibility or standardization.
  • Integrating chat media retrieval into automated workflows, such as archiving or analysis pipelines.

Example use case: Automatically fetch an image or video sent in a chat conversation, convert it if needed, and upload it to a cloud storage service or process it with an AI model.

Properties

Name Meaning
Nome Da Instância The name of the instance to connect to.
ID Da Mensagem The unique identifier of the chat message that contains the media to retrieve.
Converter Para MP4 Boolean flag indicating whether to convert the retrieved video media to MP4 format.

Output

The node outputs a JSON array where each item corresponds to the result of the media retrieval operation. The key output field is:

  • json: Contains the media data encoded as a Base64 string. This allows easy transfer and storage of binary media content within JSON-based workflows.

If the media is a video and the "Converter Para MP4" option is enabled, the output Base64 string will represent the video converted to MP4 format.

No explicit binary output is indicated in the code; all media data is returned as Base64 within JSON.

Dependencies

  • Requires access to the Zappfy API endpoint at https://docs.zappfy.io/api-reference.
  • Needs an API authentication credential configured in n8n to authorize requests to the Zappfy API.
  • The node depends on internal helper functions mapped in resourceOperationsFunctions to handle specific resource-operation logic.

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 the resource is set to "chat-api" and operation to "get-media-base64".
  • Missing Required Parameters: The node requires the instance name and message ID. Omitting these will cause errors or failed API calls.
  • API Authentication Issues: Invalid or missing API credentials will prevent successful communication with the Zappfy API.
  • Media Conversion Failures: If converting to MP4 fails, verify the input media type is a video and the conversion option is correctly set.

Links and References

Discussion