Contacts Client API

This page documents 10 schema-registry client methods in the contacts namespace.

blockContactCopy Anchor Link

Block a contact

Signature client.blockContact(contactId: string): Promise<boolean>

UsageCopy Anchor Link

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

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

checkReadReceiptsCopy Anchor Link

Check read receipts setting

Signature client.checkReadReceipts(contactId: string): Promise<boolean \| 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.checkReadReceipts({
  contactId: "447123456789@c.us",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

getAllContactsCopy Anchor Link

Retrieves all contacts

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

UsageCopy Anchor Link

const result = await client.getAllContacts();

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.

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

getBlockedIdsCopy Anchor Link

Get blocked contact IDs

Signature client.getBlockedIds(): Promise<ContactId[] \| false>

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

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

Resolves to ContactId[] \| false. 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.

getCommonGroupsCopy Anchor Link

Get common groups with contact

Signature client.getCommonGroups(contactId: string): Promise<CommonGroup[] \| false>

UsageCopy Anchor Link

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

In-process Client resolves to Promise<Array<{ id: GroupId; title: string }>>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

getContactCopy Anchor Link

Get specific contact

Signature client.getContact(contactId: string): Promise<Contact \| null>

UsageCopy Anchor Link

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

In-process Client resolves to Promise<Contact \| null>. 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.getNumberProfile({
  contactId: "447123456789@c.us",
});

getProfilePictureCopy Anchor Link

Get profile picture from server

Signature client.getProfilePicture(chatId: string): Promise<string>

UsageCopy Anchor Link

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

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

unblockContactCopy Anchor Link

Unblock a contact

Signature client.unblockContact(contactId: string): Promise<boolean>

UsageCopy Anchor Link

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