Z-API WhatsApp icon

Z-API WhatsApp

Integration with Z-API (WhatsApp) organized by resources (messages, groups, chats, contacts, products, queue, instance, status, etc.).

Message → Send Video

AI-generated

Summary

Send a video to a WhatsApp contact or group

Inputs

  • phone (required) — Recipient phone number (or group ID) in international format, digits only.
  • video (required) — Video link or Base64 data (attribute video) to send.
  • caption — Optional caption text displayed with the video.
  • viewOnce — If true, the video can only be viewed once.
  • async — If true, the send request is processed asynchronously.
  • videoMessageId — Optional ID of a message to reply to.
  • delayMessage — Delay in seconds before sending (1‑15).

Output shape

a single record representing the sent video message

Typically returns the API response object; errors are thrown and not handled.

Examples

Example 1: Send a video file with a caption and view‑once flag

phone: 5511999999999, video: https://example.com/video.mp4, caption: Promo, viewOnce: true

Example 2: Send a Base64 video asynchronously

phone: 5511999999999, video: data:video/mp4;base64,..., async: true

Example 3: Reply to an existing message with a video

phone: 5511999999999, video: https://example.com/video.mp4, videoMessageId: D241XXXX732339502B68

Links

Discussion