Chats Client API

This page documents 15 schema-registry client methods in the chats namespace.

archiveChatCopy Anchor Link

Archive a chat

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

UsageCopy Anchor Link

const result = await client.archiveChat("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.

clearChatCopy Anchor Link

Clear chat history

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

UsageCopy Anchor Link

const result = await client.clearChat("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.

deleteChatCopy Anchor Link

Delete a chat

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

UsageCopy Anchor Link

const result = await client.deleteChat("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.

getAllChatsCopy Anchor Link

Returns serialized Chat objects from the current session, optionally limited to chats with unread messages.

Signature client.getAllChats(withNewMessagesOnly?: boolean): Promise<Chat[]>

UsageCopy Anchor Link

const result = await client.getAllChats();

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

In-process Client resolves to Promise<Chat[]>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property. Serialized chat returned by chat lookups and listings. Its id is an opaque ChatId; additional WhatsApp Web fields may be present.

getChatCopy Anchor Link

Get specific chat by ID

Signature client.getChat(chatId: string): Promise<Chat \| null \| undefined \| false>

UsageCopy Anchor Link

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

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

getChatWithNonContactsCopy Anchor Link

Get chats with non-contacts

Signature client.getChatWithNonContacts(): Promise<Contact[]>

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.getChatWithNonContacts();

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

Resolves to Contact[]. 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.

isChatOnlineCopy Anchor Link

Check if chat is online

Signature client.isChatOnline(chatId: string): Promise<boolean \| string>

UsageCopy Anchor Link

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to boolean \| string. 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.

markAsReadCopy Anchor Link

Mark chat as read

Signature client.markAsRead(chatId: 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.markAsRead({
  chatId: "447123456789@c.us",
});

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.

markAsUnreadCopy Anchor Link

Mark chat as unread

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

UsageCopy Anchor Link

const result = await client.markAsUnread("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.

muteChatCopy Anchor Link

Mute a chat

Signature client.muteChat(chatId: string, muteDuration: number \| string): Promise<string \| boolean \| number>

UsageCopy Anchor Link

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to string \| boolean \| number. 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.

pinChatCopy Anchor Link

Pin a chat

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

UsageCopy Anchor Link

const result = await client.pinChat("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.

setChatEphemeralCopy Anchor Link

Set ephemeral messages for chat

Signature client.setChatEphemeral(chatId: string, ephemeral: boolean \| number): 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.setChatEphemeral({
  chatId: "447123456789@c.us",
  ephemeral: 1,
});

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.

unarchiveChatCopy Anchor Link

Unarchive a chat

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

UsageCopy Anchor Link

const result = await client.unarchiveChat("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.

unmuteChatCopy Anchor Link

Unmute a chat

Signature client.unmuteChat(chatId: string): Promise<string \| boolean \| number>

UsageCopy Anchor Link

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to string \| boolean \| number. 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.

unpinChatCopy Anchor Link

Unpin a chat

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

UsageCopy Anchor Link

const result = await client.unpinChat("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.