Messages Client API

This page documents 39 schema-registry client methods in the messages namespace.

deleteMessageCopy Anchor Link

Deletes a message

Signature client.deleteMessage(chatId: string, messageId: string[] \| string, onlyLocal?: boolean): Promise<boolean>

UsageCopy Anchor Link

const result = await client.deleteMessage("447123456789@c.us", ["false_447123456789@c.us_ABC123","false_447123456789@c.us_DEF456"]);

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to boolean: true means the runtime accepted the operation and false means it did not complete. Provider-side revoke can still be rejected, so the value is not proof that every recipient removed the message. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<boolean>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

forwardMessagesCopy Anchor Link

Forwards messages to a chat

Signature client.forwardMessages(to: string, messages: string[] \| string, skipMyMessages?: boolean): Promise<MessageIdReturn[] \| boolean>

UsageCopy Anchor Link

const result = await client.forwardMessages("447123456789@c.us", ["false_447123456789@c.us_ABC123","false_447123456789@c.us_DEF456"]);

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn[] \| boolean. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<MessageIdReturn[] \| boolean>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

getAllMessagesCopy Anchor Link

Retrieves all messages in the session

Signature client.getAllMessages(chatId?: string, includeMe?: boolean, includeNotifications?: boolean): Promise<Message[]>

UsageCopy Anchor Link

const result = await client.getAllMessages();

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to Message[]. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<Message[]>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

getMessageByIdCopy Anchor Link

Retrieves a specific message by ID

Signature client.getMessageById(messageId: string): Promise<Message \| null \| false>

UsageCopy Anchor Link

const result = await client.getMessageById("false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to Message \| null \| false. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<Message \| false \| null>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

getMessageInfoCopy Anchor Link

Get message delivery info

Signature client.getMessageInfo(messageId: string): Promise<MessageInfo>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.getMessageInfo({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageInfo. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

getMessagesForLLMCopy Anchor Link

Get messages formatted for LLMs

Signature client.getMessagesForLLM(chatId: string, last?: number): Promise<LLMMessage[]>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.getMessagesForLLM({
  chatId: "447123456789@c.us",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to LLMMessage[]. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

getMyLastMessageCopy Anchor Link

Get last message sent by host

Signature client.getMyLastMessage(chatId?: string): Promise<Message \| undefined>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.getMyLastMessage();

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to Message \| undefined. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.getStarredMessages();

getUnsentMessagesCopy Anchor Link

Get unsent/pending messages

Signature client.getUnsentMessages(): Promise<Message[]>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.getUnsentMessages();

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

Resolves to Message[]. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

getVCardsCopy Anchor Link

Extract vCards from message

Signature client.getVCards(messageId: string): Promise<string[]>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.getVCards({
  messageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to string[]. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

loadEarlierMessagesCopy Anchor Link

Loads earlier messages from a chat

Signature client.loadEarlierMessages(chatId: string, count?: number, includeMe?: boolean): Promise<Message[]>

UsageCopy Anchor Link

const result = await client.loadEarlierMessages("447123456789@c.us");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to Message[]. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<Message[]>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

reactCopy Anchor Link

React to message with emoji

Signature client.react(messageId: string, emoji: string): Promise<boolean>

UsageCopy Anchor Link

const result = await client.react("false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB", "emoji");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to boolean. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<boolean>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendAdvancedButtons({
  to: "447123456789@c.us",
  buttons: [],
  text: "text",
  footer: "footer",
  filename: "filename",
});

sendAudioCopy Anchor Link

Sends an audio file to a chat

Signature client.sendAudio(to: string, file: string, filename?: string, quotedMsgId?: string): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendAudio({
  to: "447123456789@c.us",
  file: "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA...",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

sendBannerCopy Anchor Link

Sends a banner image

Signature client.sendBanner(to: string, base64: string): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendBanner({
  to: "447123456789@c.us",
  base64: "base64",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendButtons({
  to: "447123456789@c.us",
  buttons: [],
});

sendContactCopy Anchor Link

Sends a single contact

Signature client.sendContact(to: string, contactId: string \| string[]): Promise<MessageIdReturn \| boolean \| void>

UsageCopy Anchor Link

const result = await client.sendContact("447123456789@c.us", "447123456789@c.us");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean \| void. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<void>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

sendFileCopy Anchor Link

Sends a file or document to a chat

Signature client.sendFile(to: string, file: string, filename?: string, caption?: string): Promise<MessageIdReturn \| string>

UsageCopy Anchor Link

const result = await client.sendFile("447123456789@c.us", "data:application/pdf;base64,JVBERi0xLjQK...");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<MessageId>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

sendFileFromUrlCopy Anchor Link

Downloads a file from a URL and sends it to a chat

Signature client.sendFileFromUrl(to: string, url: string, filename: string, caption?: string, headers?: object): Promise<string \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendFileFromUrl({
  to: "447123456789@c.us",
  url: "url",
  filename: "filename",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Message ID or success status

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API. Message ID or success status

sendImageCopy Anchor Link

Sends an image to a chat

Signature client.sendImage(to: string, imgData: string, filename?: string, caption?: string, id?: string, waitForId?: boolean): Promise<MessageIdReturn \| boolean \| string>

UsageCopy Anchor Link

const result = await client.sendImage("447123456789@c.us", "data:image/png;base64,iVBORw0KGgo...");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean \| string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<MessageId \| false>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

const result = await client.sendInteractive("447123456789@c.us", {});

sendLinkWithAutoPreviewCopy Anchor Link

Sends a link with auto-generated preview

Signature client.sendLinkWithAutoPreview(to: string, url: string, text?: string, thumbnail?: string, quotedMsgId?: string, customSize?: { height: number; width: number }): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendLinkWithAutoPreview({
  to: "447123456789@c.us",
  url: "url",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendListMessage({
  to: "447123456789@c.us",
  sections: [],
  title: "title",
  description: "description",
  actionText: "actionText",
});

sendLocationCopy Anchor Link

Sends a location to a chat

Signature client.sendLocation(to: string, lat: number \| string, lng: number \| string, loc?: string, address?: string, url?: string): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

const result = await client.sendLocation("447123456789@c.us", 51.5074, -0.1278);

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<MessageId \| false>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

sendMessageWithThumbCopy Anchor Link

Sends a link preview message with custom thumbnail

Signature client.sendMessageWithThumb(thumb: string, url: string, title: string, description: string, content: string, to: string, quotedMsgId?: string, customSize?: { height: number; width: number }): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendMessageWithThumb({
  thumb: "thumb",
  url: "url",
  title: "title",
  description: "description",
  content: "Hello, world!",
  to: "447123456789@c.us",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

sendMultipleContactsCopy Anchor Link

Sends multiple contacts

Signature client.sendMultipleContacts(to: string, contactIds: string[]): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendMultipleContacts({
  to: "447123456789@c.us",
  contactIds: ["447123456789@c.us"],
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

sendPaymentRequestCopy Anchor Link

Sends a payment request message

Signature client.sendPaymentRequest(to: string, amount: number, currency: string, message?: string): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendPaymentRequest({
  to: "447123456789@c.us",
  amount: 1,
  currency: "currency",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

sendPollCopy Anchor Link

Sends a poll message

Signature client.sendPoll(to: string, name: string, options: string[], selectableCount?: number): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendPoll({
  to: "447123456789@c.us",
  name: "name",
  options: ["Yes", "No"],
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

sendPttCopy Anchor Link

Sends a voice note (push-to-talk) to a chat

Signature client.sendPtt(to: string, file: string, quotedMsgId?: string): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendPtt({
  to: "447123456789@c.us",
  file: "data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAA...",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

const result = await client.sendRawMessage("447123456789@c.us", {});

sendReplyWithMentionsCopy Anchor Link

Sends a reply to a message that includes @mentions

Signature client.sendReplyWithMentions(to: string, content: string, replyMessageId: string, hideTags?: boolean, mentions?: string[]): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendReplyWithMentions({
  to: "447123456789@c.us",
  content: "Hello, world!",
  replyMessageId: "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

sendSeenCopy Anchor Link

Mark message as seen

Signature client.sendSeen(chatId: string): Promise<boolean>

UsageCopy Anchor Link

const result = await client.sendSeen("447123456789@c.us");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to boolean. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<boolean>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

sendTextCopy Anchor Link

Sends a text message to a chat

Signature client.sendText(to: string, content: string, options?: unknown): Promise<MessageIdReturn \| boolean \| string>

Start with await client.sendText(to, content). The registry still accepts an optional options value for compatibility, but the current Client implementation ignores it. Use reply(to, content, messageId) for quoted replies and sendTextWithMentions(to, content, hideTags, mentions) for mentions.

UsageCopy Anchor Link

const result = await client.sendText('447123456789@c.us', 'Hello from open-wa');
const messageId = typeof result === 'string' && /^(true|false)_.+_.+$/.test(result) ? result : null;
if (!messageId) throw new Error(`Message was not sent: ${String(result)}`);
console.log('Message ID:', messageId);

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

A successful send returns a message ID as a string; some Easy API responses may serialize it as an object with _serialized. A boolean or a non-ID status string is not a message ID: the current WAPI can return values such as Not a contact or Not able to send message to broadcast. The in-process Client converts Not a contact into a rejected Promise because sending to an unknown number requires a Restricted or Premium license; the method is not otherwise license-gated. The in-process Client is declared as Promise<string | false>. Check returned values before passing them to another method, and handle rejected Promises for input, dispatch, license, or provider errors.

In-process Client resolves to Promise<string \| false>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

sendTextWithMentionsCopy Anchor Link

Sends a text message that includes @mentions

Signature client.sendTextWithMentions(to: string, content: string, hideTags?: boolean, mentions?: string[]): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendTextWithMentions({
  to: "447123456789@c.us",
  content: "Hello, world!",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to MessageIdReturn \| boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

sendVCardCopy Anchor Link

Sends a contact card (vCard)

Signature client.sendVCard(to: string, vcard: string, contactName?: string, contactNumber?: string): Promise<boolean>

UsageCopy Anchor Link

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.sendVCard({
  to: "447123456789@c.us",
  vcard: "vcard",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to boolean. A rejected Promise indicates input validation or dispatch failure.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.

sendVideoAsGifCopy Anchor Link

Sends a video as an animated GIF

Signature client.sendVideoAsGif(to: string, file: string, filename?: string, caption?: string, quotedMsgId?: string): Promise<MessageIdReturn \| boolean>

UsageCopy Anchor Link