WSAPI Message

Send and manage WhatsApp messages via WSAPI

Actions16

Overview

This node enables sending and managing WhatsApp messages via a WebSocket API (WSAPI). Specifically, the Send Video operation allows users to send video messages to individual contacts or groups on WhatsApp. It supports sending videos either by providing a direct URL or by supplying Base64-encoded video data. Additional options include setting the MIME type of the video, adding an optional caption, mentioning other users, replying to specific messages, marking the message as forwarded, and sending disappearing media (view once).

Common scenarios:

  • Sharing promotional or informational videos with customers or group chats.
  • Sending tutorial or demonstration videos in customer support workflows.
  • Broadcasting event highlights or announcements via WhatsApp groups.

Practical example:

  • A marketing automation workflow sends a product demo video hosted on a CDN URL to a list of customers.
  • A support bot replies with a short troubleshooting video encoded in Base64 directly embedded in the message.
  • Sending a video with a caption and tagging specific users in a group chat.

Properties

Name Meaning
Recipient WhatsApp ID of the recipient. This can be a phone number with @s.whatsapp.net for individual contacts or a group ID with @g.us for groups.
Video Source Source of the video content. Options: URL (provide a direct link to the video file) or Base64 (provide the video data encoded in Base64).
Video URL The URL of the video to send. Required if Video Source is URL.
Video Base64 Base64 encoded video data. Required if Video Source is Base64.
MIME Type MIME type of the video file. Options: video/mp4, video/avi, video/mov. Default is video/mp4.
Video Caption Optional text caption to accompany the video message.
Advanced Options Collection of additional settings:
• Mentions: Comma-separated WhatsApp IDs to mention in the message.
• Reply To Message ID: ID of the message this video replies to.
• Is Forwarded: Mark message as forwarded.
• View Once: Send as disappearing media (view once).

Output

The node outputs the JSON response returned by the WSAPI after sending the video message. This typically includes details about the sent message such as message ID, status, timestamps, and any metadata provided by the API.

If the operation fails, the output will contain an error object with the error message.

No binary data is output by this node; it only sends video content to WhatsApp.

Dependencies

  • Requires connection to a WSAPI service that manages WhatsApp messaging.
  • Needs an API key credential and instance identifier configured in n8n credentials for authentication.
  • The WSAPI base URL and authentication headers are used internally to make HTTP POST requests to send messages.

Troubleshooting

  • Invalid Recipient ID: Ensure the recipient WhatsApp ID is correctly formatted with @s.whatsapp.net for contacts or @g.us for groups.
  • Video Source Mismatch: If you select URL as the video source, provide a valid accessible URL. For Base64, ensure the data is properly encoded.
  • Unsupported MIME Type: Use one of the supported MIME types (video/mp4, video/avi, video/mov). Using unsupported types may cause message rejection.
  • API Authentication Errors: Verify that the API key and instance ID credentials are correctly set up and have sufficient permissions.
  • Network Issues: Check connectivity to the WSAPI endpoint and ensure no firewall or proxy blocks the requests.
  • View Once Option: When enabled, the video will disappear after being viewed once. Confirm this behavior is intended as recipients cannot re-watch the video.

Error messages from the WSAPI will be passed through in the output. Review these messages for specific issues related to message sending.

Links and References

If you need summaries for other operations or resources, feel free to ask!

Discussion