Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The node "Zappfy API" provides integration with the Zappfy messaging platform, allowing users to send text messages programmatically. Specifically, for the resource "Mensagem" and operation "Enviar Texto," it enables sending a plain text message to a specified recipient number (RemoteJid). This is useful in scenarios such as automated customer notifications, chatbots, or bulk messaging campaigns where sending customized text messages is required.

Practical examples include:

  • Sending order confirmation messages to customers.
  • Delivering alerts or reminders via WhatsApp-like messaging.
  • Responding automatically to user queries with predefined text.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message.
Numero Do Destinatario The recipient's RemoteJid (unique identifier for the destination contact). Required
Mensagem The text content of the message to be sent. Required
Opções Additional options to customize message sending:
- Delay Number of milliseconds to wait before sending the message (default 1200 ms).
- Responder Mensagem Option to reply to a specific message by providing its message ID.
- Menções Settings for mentions within the message:
- Mencionar Todos Boolean to mention all participants in a group.
- Números Para Mencionar Comma-separated list of numbers to mention individually (used if not mentioning all).
- Preview De Link Boolean to enable or disable link preview in the message (default enabled).

Output

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

If the node supports binary data output (not indicated here), it would represent media or attachments related to the message, but for this "Enviar Texto" operation, only JSON output is expected.

Dependencies

  • Requires an active connection to the Zappfy API service.
  • Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
  • Network access to https://docs.zappfy.io/api-reference base URL for API calls.

Troubleshooting

  • Common issues:

    • Missing or invalid recipient number (remoteJid) causing message delivery failure.
    • Incorrect or missing API credentials leading to authentication errors.
    • Network connectivity problems preventing API requests.
    • Invalid message format or unsupported characters causing API rejection.

  • Error messages:

    • "Operação não suportada." indicates the requested operation is not implemented; ensure correct Resource and Operation are selected.
    • Authentication errors suggest checking the API key credential setup.
    • Timeout or network errors require verifying internet connectivity and API endpoint availability.

Links and References

Discussion