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 Status, it enables sending different types of status updates (text, image, video, or audio) from a specified instance to either all contacts or a selected list of contacts.

This node is useful in scenarios where automated or bulk status updates are needed on a messaging platform, such as broadcasting announcements, sharing multimedia content, or updating statuses programmatically without manual intervention.

Practical examples:

  • A marketing team automatically posting promotional images or videos as status updates.
  • Customer support sending text status updates to inform clients about service availability.
  • Sharing audio messages as status updates to a specific group of contacts.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the status update.
Tipo Do Status The type of status to post. Options: Status De Texto (text), Status De Imagem (image), Status De Video (video), Status De Audio (audio).
Conteudo Ou URL The content or URL of the image, video, or audio to be posted as status. Required for all types.
Texto Para Status De Imagem/Video Text caption to accompany image or video status updates. Optional.
Cor Do Background Background color for the status (hex color code).
Font Do Texto Font style for the text in the status. Options: SERIF, NORICAN REGULAR, BRYNDAN WRITE, BEBASNEUE REGULAR, OSWALD HEAVY.
Enviar Para Todos Boolean flag indicating whether to send the status to all contacts.
Lista De Contatos Comma-separated list of contacts who will receive the status if not sending to all contacts.

Output

The node outputs a JSON array containing the response from the Zappfy API after attempting to send the status update. The exact structure depends on the API response but generally includes confirmation of the sent status or error details.

If the status includes media (image, video, audio), the node handles URLs pointing to these resources; however, it does not output binary data directly.

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").
  • Network access to the base URL https://docs.zappfy.io/api-reference or the actual Zappfy API endpoint.

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-stories" respectively.
  • Missing Required Parameters: Ensure required fields like "Nome Da Instância", "Conteudo Ou URL", and "Lista De Contatos" (if not sending to all) are provided.
  • Invalid Media URLs: For image, video, or audio statuses, ensure the URLs are accessible and valid.
  • API Authentication Errors: Confirm that the API key credential is correctly configured and has necessary permissions.
  • Network Issues: Check network connectivity to the Zappfy API endpoint.

Links and References

Discussion