Groups Client API

This page documents 22 schema-registry client methods in the groups namespace.

addParticipantCopy Anchor Link

Add participant to group

Signature client.addParticipant(groupId: string, contactId: string): Promise<boolean>

UsageCopy Anchor Link

const result = await client.addParticipant("447123456789-1445627445@g.us", "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.

approveGroupJoinRequestCopy Anchor Link

Approve group join request

Signature client.approveGroupJoinRequest(groupId: string, contactId: string): 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.approveGroupJoinRequest({
  groupId: "447123456789-1445627445@g.us",
  contactId: "447123456789@c.us",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to string \| 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.createGroup("name", ["447123456789@c.us"]);

demoteParticipantCopy Anchor Link

Demote participant from admin

Signature client.demoteParticipant(groupId: string, contactId: string): Promise<boolean \| string>

UsageCopy Anchor Link

const result = await client.demoteParticipant("447123456789-1445627445@g.us", "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.

getAllGroupsCopy Anchor Link

Get all groups

Signature client.getAllGroups(withNewMessagesOnly?: boolean): 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.getAllGroups();

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.

getGroupAdminsCopy Anchor Link

Get group admins

Signature client.getGroupAdmins(groupId: string): Promise<ContactId[]>

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.getGroupAdmins({
  groupId: "447123456789-1445627445@g.us",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to ContactId[]. 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. Opaque WhatsApp contact identifier. Preserve the exact value returned by the API.

getGroupInfoCopy Anchor Link

Get group metadata

Signature client.getGroupInfo(groupId: string): Promise<GroupMetadata \| null>

UsageCopy Anchor Link

const result = await client.getGroupInfo("447123456789-1445627445@g.us");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

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

getGroupInviteLinkCopy Anchor Link

Get group invite link

Signature client.getGroupInviteLink(groupId: string): Promise<string>

UsageCopy Anchor Link

const result = await client.getGroupInviteLink("447123456789-1445627445@g.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>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

getGroupMembersCopy Anchor Link

Retrieves members of a group

Signature client.getGroupMembers(groupId: string): Promise<Contact[]>

UsageCopy Anchor Link

const result = await client.getGroupMembers("447123456789-1445627445@g.us");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

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

getGroupMembersIdCopy Anchor Link

Get group member IDs

Signature client.getGroupMembersId(groupId: string): Promise<ContactId[]>

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.getGroupMembersId({
  groupId: "447123456789-1445627445@g.us",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to ContactId[]. 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. Opaque WhatsApp contact identifier. Preserve the exact value returned by the API.

getKickedGroupsCopy Anchor Link

Get groups where kicked

Signature client.getKickedGroups(): Promise<GroupChatId[]>

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

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

Resolves to GroupChatId[]. 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. Opaque group conversation identifier returned by a group lookup or join method.

const result = await client.joinGroupViaLink("link");

leaveGroupCopy Anchor Link

Leave a group

Signature client.leaveGroup(groupId: string): Promise<void>

UsageCopy Anchor Link

const result = await client.leaveGroup("447123456789-1445627445@g.us");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to void. 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.

promoteParticipantCopy Anchor Link

Promote participant to admin

Signature client.promoteParticipant(groupId: string, contactId: string): Promise<boolean \| string>

UsageCopy Anchor Link

const result = await client.promoteParticipant("447123456789-1445627445@g.us", "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.

rejectGroupJoinRequestCopy Anchor Link

Reject group join request

Signature client.rejectGroupJoinRequest(groupId: string, contactId: string): 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.rejectGroupJoinRequest({
  groupId: "447123456789-1445627445@g.us",
  contactId: "447123456789@c.us",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

removeParticipantCopy Anchor Link

Remove participant from group

Signature client.removeParticipant(groupId: string, contactId: string): Promise<boolean>

UsageCopy Anchor Link

const result = await client.removeParticipant("447123456789-1445627445@g.us", "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.

revokeGroupInviteLinkCopy Anchor Link

Revoke group invite link

Signature client.revokeGroupInviteLink(groupId: string): Promise<string \| boolean>

UsageCopy Anchor Link

const result = await client.revokeGroupInviteLink("447123456789-1445627445@g.us");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

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

setGroupDescriptionCopy Anchor Link

Set group description

Signature client.setGroupDescription(groupId: string, description: string): Promise<boolean>

UsageCopy Anchor Link

const result = await client.setGroupDescription("447123456789-1445627445@g.us", "description");

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.

setGroupEditToAdminsOnlyCopy Anchor Link

Restrict group editing to admins only

Signature client.setGroupEditToAdminsOnly(groupId: string, onlyAdmins: boolean): 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.setGroupEditToAdminsOnly({
  groupId: "447123456789-1445627445@g.us",
  onlyAdmins: true,
});

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.

setGroupIconCopy Anchor Link

Set group icon

Signature client.setGroupIcon(groupId: string, image: string): Promise<boolean>

UsageCopy Anchor Link

const result = await client.setGroupIcon("447123456789-1445627445@g.us", "image");

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.

setGroupTitleCopy Anchor Link

Set group title

Signature client.setGroupTitle(groupId: string, title: string): Promise<boolean>

UsageCopy Anchor Link

const result = await client.setGroupTitle("447123456789-1445627445@g.us", "title");

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.

setGroupToAdminsOnlyCopy Anchor Link

Restrict group to admins only

Signature client.setGroupToAdminsOnly(groupId: string, onlyAdmins: boolean): 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.setGroupToAdminsOnly({
  groupId: "447123456789-1445627445@g.us",
  onlyAdmins: true,
});

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.