Status Client API

deleteAllStatusCopy Anchor Link

Delete all statuses

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

ParametersCopy Anchor Link

This method does not define input parameters.

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.

deleteStatusCopy Anchor Link

Delete status

Signature client.deleteStatus(statusesToDelete: string \| 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.deleteStatus({
  statusesToDelete: [],
});

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.

getStoriesCopy Anchor Link

Get all stories

Signature client.getStories(): Promise<Story[]>

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

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

Resolves to Story[]. 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. Message-shaped status entry, based on the legacy story API. Chat and sender may be absent or null. The licensed getStories payload has not been verified against this model.

postImageStatusCopy Anchor Link

Post image status

Signature client.postImageStatus(image: string, caption?: string): Promise<MessageId \| 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.postImageStatus({
  image: "image",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

postTextStatusCopy Anchor Link

Post text status

Signature client.postTextStatus(text: string, backgroundColor?: string, font?: number): Promise<MessageId \| 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.postTextStatus({
  text: "text",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

postVideoStatusCopy Anchor Link

Post video status

Signature client.postVideoStatus(video: string, caption?: string): Promise<MessageId \| 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.postVideoStatus({
  video: "video",
});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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