Z-API icon

Z-API

Send messages

Actions10

Overview

This node integrates with the Z-API service to send various types of WhatsApp messages programmatically. It supports sending text, media (images, videos, audio, documents, stickers, GIFs), location data, contacts, polls, and interactive option lists. The "Send Video" operation specifically allows sending a video message to a specified phone number, optionally including a caption and setting the message as view-once.

Common scenarios include automating customer notifications, marketing campaigns, or support messages via WhatsApp, where sending rich media like videos enhances engagement. For example, a business could automatically send product demo videos to customers after they inquire about a product.

Properties

Name Meaning
Instance ID Your Z-API Instance ID used for authenticating API requests.
Instance Token Your Z-API Instance Token (password type) for secure authentication.
Client Token Your Z-API Client Token (password type) for additional authentication.
Phone The recipient's phone number in international format (e.g., 5511999999999).
URL or Base64 The URL or base64 string of the video file to be sent.
View Once Boolean flag indicating if the video message should be view-once (disappears after viewing).
Caption Optional text caption accompanying the video message.
Additional Fields Collection of optional parameters:
- Delay Message: seconds to wait before sending message (1-15).
- Delay Typing: seconds to show "Typing..." status before sending (0-15).
- Message ID to Reply: ID of a message to reply to.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the response from the Z-API service after attempting to send the video message. This typically includes confirmation details such as message IDs or error information if the request failed.

No binary data is output by this node; all responses are JSON-formatted metadata about the sent message.

Dependencies

  • Requires access to the Z-API WhatsApp messaging service.
  • Needs three credentials for authentication: Instance ID, Instance Token, and Client Token.
  • No additional environment variables or external dependencies are required beyond these credentials.

Troubleshooting

  • Common Issues:

    • Invalid or missing credentials will cause authentication failures.
    • Incorrect phone number format may result in message delivery errors.
    • Providing an invalid or inaccessible media URL/base64 string will prevent the video from being sent.
    • Exceeding delay limits (more than 15 seconds) will likely cause validation errors.

  • Error Messages:

    • "The operation "send-video" is not known!" indicates a misconfiguration or unsupported operation.
    • "The resource "send-message" is not known!" suggests the resource parameter is incorrect.
    • Network or API errors returned from Z-API will be included in the output JSON under an error field if "Continue On Fail" is enabled.

To resolve issues:

  • Verify all credential values are correct and active.
  • Ensure phone numbers follow the expected international format without extra characters.
  • Confirm media URLs are publicly accessible or base64 strings are correctly encoded.
  • Use delays within allowed ranges.

Links and References

Discussion