File

api docs

The sendFile function allows you to send various types of files to a WhatsApp number using a Blob (binary data).

async function sendFile({
  to,
  file,
  config,
}: {
  to: string;
  file: Blob;
  config?: WsConfig;
}): Promise<SendMessageResponse>;

Parameters:

• to: The WhatsApp phone number recipient, including country code.
• file: A Blob object representing the file to send (e.g., images, documents, audio, or video).
• config: Optional configuration settings.

Return

• Success: True for success, false for fail.
• Response: Information about the message sent, like the message ID, delivery status, and more.

IMPORTANT

You can see the supported files types in limitations section.

Example usage

import { sendFile } from "ws-cloud-api/messaging";
import fs from "fs";
import path from "path";

const file = new Blob([fs.readFileSync(path.join(__dirname, "/file.pdf"))], {
  type: "application/pdf",
});

sendFile({
  to: "573123456789",
  file: file,
})
  .then((response) => {
    if (response.success) {
      console.log("File sent");
    }
  })
  .catch(console.error);