Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The node "Zappfy API" allows users to interact with the Zappfy messaging platform via its API. Specifically, for the resource Mensagem and operation Enviar Imagem, it enables sending an image message to a specified recipient through a given instance of the Zappfy service.

This node is useful in scenarios where automated or programmatic sending of images is required, such as:

  • Sending product photos or promotional images to customers.
  • Sharing screenshots or visual information in customer support workflows.
  • Broadcasting event images or updates to groups or individuals.

For example, a marketing automation workflow could use this node to send personalized image messages to a list of contacts.

Properties

Name Meaning
Nome Da Instancia The name of the Zappfy instance that will send the message.
Número Do Destinatário The recipient's phone number or identifier to whom the image will be sent.
Imagem The image to send, provided as a URL or base64 encoded string.
Caption Optional text caption to accompany the image.
Opções (Options) Additional message options:
- Delay Time delay in milliseconds before sending the message (default 1200 ms).
- Responder Mensagem Option to reply to a specific message by providing its message ID.
- Menções Mention settings:
- Mencionar Todos Boolean flag to mention all participants in a group.
- Números Para Mencionar Comma-separated list of phone numbers to mention individually (used if not mentioning everyone).

Output

The node outputs a JSON array containing the response from the Zappfy API after attempting to send the image message. The exact structure depends on the API response but typically includes confirmation details such as message ID, status, timestamps, or error information.

There is no indication that the node outputs binary data; it primarily handles JSON responses.

Dependencies

  • Requires an active Zappfy API credential configured in n8n to authenticate requests.
  • Depends on network access to the Zappfy API endpoint (https://docs.zappfy.io/api-reference as base URL).
  • No other external dependencies are indicated.

Troubleshooting

  • Operation Not Supported Error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "messages-api" and "send-image" respectively.
  • Missing Required Parameters: Ensure all required fields like instance name, recipient number, and image are provided; missing these will cause errors.
  • Invalid Image Format: Providing an invalid URL or malformed base64 string for the image may result in API errors.
  • API Authentication Errors: Confirm that the API key or authentication token is valid and has necessary permissions.
  • Delay Misconfiguration: Setting an excessively high or negative delay might cause unexpected behavior or timeouts.

Links and References

Discussion