Zappfy API icon

Zappfy API

Interact with Zappfy API

Overview

This node integrates with the Zappfy API to send interactive button messages via a messaging platform. Specifically, for the "Mensagem" resource and the "Enviar Botões" operation, it allows users to send messages containing up to three customizable buttons to a specified recipient number. This is useful in scenarios such as customer support, marketing campaigns, or automated notifications where interactive responses are needed.

For example, a business can send a message with buttons like "Reply", "Copy Code", "Visit URL", or "Call Number" to engage customers directly from the chat interface.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the buttons message.
Número Do Destinatário The recipient's phone number to which the button message will be sent.
Título The title text of the button message.
Descrição The description text of the button message.
Rodapé Optional footer text displayed at the bottom of the message.
Botões Up to 3 buttons to include in the message. Each button has:
- Tipo (Type): One of Reply, Copy, URL, or Call.
- Texto Do Botão (Display Text): The label shown on the button.
- ID: Required if type is Reply; an identifier for the reply button.
- Código Para Copiar (Copy Code): Required if type is Copy; the text/code to copy when pressed.
- URL: Required if type is URL; the link to open when pressed.
- Número De Telefone (Phone Number): Required if type is Call; the phone number to call.

Output

The node outputs a JSON array containing the response from the Zappfy API after sending the button message. The exact structure depends on the API response but typically includes confirmation details such as message status, IDs, or error information.

No binary data output is indicated by the source code.

Dependencies

  • Requires an active connection to the Zappfy API.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • Network access to https://docs.zappfy.io/api-reference or the actual Zappfy API endpoint.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error indicating the function is not supported. Ensure you use valid combinations of resource and operation.
  • Missing required properties: The node requires certain fields like instance name, recipient number, title, description, and button details. Omitting these will cause errors.
  • API authentication issues: Invalid or missing API credentials will prevent successful requests.
  • Button configuration errors: Each button must have the correct fields filled based on its type (e.g., URL for URL buttons). Incorrect configurations may cause the API to reject the request.

Links and References

Discussion