Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The "Enviar Lista" operation of the "Mensagem" resource in this node allows users to send a structured list message via the Zappfy API. This type of message is commonly used in chatbots or messaging automation scenarios where you want to present multiple selectable options to the recipient in an organized way.

Typical use cases include:

  • Customer support bots offering categorized help topics.
  • Marketing campaigns presenting product categories or service options.
  • Interactive menus for user navigation within messaging platforms.

For example, a business could send a list with sections like "Products," "Services," and "Support," each containing several selectable items, allowing the user to quickly choose what they are interested in.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the list message. This identifies which account or connection is used.
Número Do Destinatário The recipient's phone number or identifier to whom the list message will be sent.
Título Da Lista The main title of the list message, displayed prominently at the top.
Descrição A description text providing additional context or information about the list.
Texto Do Botão The label text shown on the button that opens the list options (e.g., "Ver Opções").
Texto Do Rodapé Footer text displayed at the bottom of the list message.
Seções One or more sections in the list, each with:
- Título Da Seção: Section title.
- Linhas: Multiple rows/items, each having:
- Título: Title of the row (required).
- Descrição: Optional description.
- ID Da Linha: Unique ID for the option.
Opções (Delay) Delay in milliseconds before sending the message (default 1200 ms).
Opções (Responder Mensagem) Optionally specify a message ID to reply to, making this list message a response to another message.
Opções (Menções) Mention settings:
- Mencionar Todos: Boolean to mention all participants in a group.
- Números Para Mencionar: Comma-separated list of numbers to mention individually if not mentioning all.

Output

The node outputs a JSON array where each item corresponds to the result of sending the list message. The exact structure depends on the Zappfy API response but typically includes confirmation details such as message IDs, status, timestamps, or error information if sending failed.

If the API supports binary data (e.g., media attachments), it would be included accordingly, but for this list message operation, the output primarily consists of JSON metadata about the sent message.

Dependencies

  • Requires an active connection to the Zappfy API, authenticated via an API key credential configured in n8n.
  • The node expects the base URL https://docs.zappfy.io/api-reference for API requests.
  • Proper configuration of the instance name and recipient number is necessary to route messages correctly.

Troubleshooting

  • Operation Not Supported Error: If the selected operation or resource is not supported, the node throws an error indicating the function is unavailable. Ensure you select the correct resource ("messages-api") and operation ("send-list").
  • Invalid Recipient Number: Sending may fail if the recipient number format is incorrect or not registered on the messaging platform.
  • Missing Required Fields: The node requires fields like instance name, recipient number, title, description, button text, footer text, and at least one section with rows. Omitting these will cause errors.
  • API Authentication Errors: If the API key or credentials are invalid or missing, the request will fail. Verify your API credentials in n8n settings.
  • Delay Misconfiguration: Setting an excessively high delay might cause unexpected behavior or timeouts; use reasonable values.

Links and References

Discussion