Labels Client API

This page documents 4 schema-registry client methods in the labels namespace.

addLabelCopy Anchor Link

Add label to chat

Signature client.addLabel(label: string, 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.addLabel({
  label: "label",
  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.

getAllLabelsCopy Anchor Link

Get all labels

Signature client.getAllLabels(): Promise<Label[]>

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

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

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

getChatsByLabelCopy Anchor Link

Get chats by label

Signature client.getChatsByLabel(label: string): Promise<Chat[]>

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.getChatsByLabel({
  label: "label",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to Chat[]. 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. Serialized chat returned by chat lookups and listings. Its id is an opaque ChatId; additional WhatsApp Web fields may be present.

removeLabelCopy Anchor Link

Remove label from chat

Signature client.removeLabel(label: string, 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.removeLabel({
  label: "label",
  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.