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 various types of messages programmatically. Specifically, for the resource Mensagem and operation Enviar Video, this node enables sending a video message to a specified recipient via the Zappfy API.

This is useful in scenarios such as:

  • Automating customer support by sending video tutorials or responses.
  • Broadcasting promotional videos to clients.
  • Sending personalized video messages in workflows triggered by events.

For example, a business could automatically send a welcome video to new customers after signup, or a support team could send troubleshooting videos based on user queries.

Properties

Name Meaning
Nome Da Instância The name of the Zappfy instance that will send the video message.
Número Do Destinatário The phone number of the recipient who will receive the video message.
Video The video content to send, provided as a URL or base64 encoded string.
Caption Optional text caption to accompany the video message.
Opções Additional options for sending the message:
- Delay Time delay in milliseconds before the message is sent (default 1200 ms).
- Responder Mensagem Option to reply to a specific message by providing its ID.
- Menções Settings to mention participants in group chats:
-- Mencionar Todos Boolean flag to mention all participants in the group.
-- Números Para Mencionar Comma-separated list of phone numbers to mention individually (used if not mentioning everyone).

Output

The node outputs an array of JSON objects representing the response from the Zappfy API after attempting to send the video message. The exact structure depends on the API but typically includes confirmation details such as message ID, status, timestamps, and any error information.

No binary data output is indicated for this operation.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing instance name or recipient number can cause message sending failures.
    • Incorrect video URL or malformed base64 data may result in upload errors.
    • Insufficient permissions or expired API tokens will lead to authentication errors.
    • Delay option set too low might cause rate limiting or message ordering issues.

  • Error messages:

    • "Operação não suportada." indicates the requested operation is not implemented; verify resource and operation names.
    • API errors returned from Zappfy will be passed through; check the error message for details like invalid media format or quota exceeded.

  • Resolutions:

    • Double-check all required fields are correctly filled.
    • Validate video URLs or base64 strings before sending.
    • Ensure API credentials are valid and have necessary permissions.
    • Adjust delay settings if encountering rate limits.

Links and References

Discussion