Communities Client API

This page documents 6 schema-registry client methods in the communities namespace.

getAllCommunitiesCopy Anchor Link

Get all communities

Signature client.getAllCommunities(): 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.getAllCommunities();

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.

getCommunityAdminIdsCopy Anchor Link

Get community admin IDs

Signature client.getCommunityAdminIds(communityId: string): Promise<CommunityAdminIds[]>

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

getCommunityAdminsCopy Anchor Link

Get community admins

Signature client.getCommunityAdmins(communityId: string): Promise<CommunityAdmins[]>

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

getCommunityInfoCopy Anchor Link

Get community metadata

Signature client.getCommunityInfo(communityId: string): Promise<CommunityMetadata>

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

getCommunityParticipantIdsCopy Anchor Link

Get community participant IDs

Signature client.getCommunityParticipantIds(communityId: string): Promise<CommunityParticipantIds[]>

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

getCommunityParticipantsCopy Anchor Link

Get community participants

Signature client.getCommunityParticipants(communityId: string): Promise<CommunityParticipants[]>

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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