Session Client API

This page documents 16 schema-registry client methods in the session namespace.

getBatteryLevelCopy Anchor Link

Get phone battery level

Signature client.getBatteryLevel(): Promise<number>

UsageCopy Anchor Link

const result = await client.getBatteryLevel();

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

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

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

getConnectionStateCopy Anchor Link

Get connection state

Signature client.getConnectionState(): Promise<string>

UsageCopy Anchor Link

const result = await client.getConnectionState();

ParametersCopy Anchor Link

This method does not define input parameters.

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.

getFeaturesCopy Anchor Link

Get enabled features

Signature client.getFeatures(): Promise<FeatureFlags>

UsageCopy Anchor Link

const result = await client.getFeatures();

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

WhatsApp feature flags keyed by name. Values are provider-defined and must be narrowed before use.

In-process Client resolves to Promise<Record<string, unknown>>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property. WhatsApp feature flags keyed by name. Values are provider-defined and must be narrowed before use.

getHostNumberCopy Anchor Link

Get host phone number

Signature client.getHostNumber(): Promise<string>

UsageCopy Anchor Link

const result = await client.getHostNumber();

ParametersCopy Anchor Link

This method does not define input parameters.

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.

getLicenseTypeCopy Anchor Link

Get license type

Signature client.getLicenseType(): Promise<LicenseType \| 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.getLicenseType();

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

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

getLoadedMessageCountCopy Anchor Link

Get loaded message count

Signature client.getLoadedMessageCount(): Promise<number>

UsageCopy Anchor Link

const result = await client.getAmountOfLoadedMessages();

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

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

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

getMeCopy Anchor Link

Get host account info

Signature client.getMe(): Promise<HostAccount>

UsageCopy Anchor Link

const result = await client.getMe();

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

Host account attributes plus the current account ID. Additional WhatsApp Web attributes vary by version.

In-process Client resolves to Promise<HostAccount>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property. Host account attributes plus the current account ID. Additional WhatsApp Web attributes vary by version.

getProcessStatsCopy Anchor Link

Get process statistics

Signature client.getProcessStats(): Promise<ProcessStats>

UsageCopy Anchor Link

const result = await client.getProcessStats();

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

Process diagnostics keyed by process ID. The provider controls each entry; no stable entry shape is guaranteed.

In-process Client resolves to Promise<Record<string, unknown>>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property. Process diagnostics keyed by process ID. The provider controls each entry; no stable entry shape is guaranteed.

getSnapshotCopy Anchor Link

Take screenshot

Signature client.getSnapshot(chatId?: string, width?: number, height?: number): Promise<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.getSnapshot();

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

getUserAgentCopy Anchor Link

Get user agent

Signature client.getUserAgent(userAgent?: string): Promise<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.getUserAgent();

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

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

getWAVersionCopy Anchor Link

Get WhatsApp Web version

Signature client.getWAVersion(): Promise<string>

UsageCopy Anchor Link

const result = await client.getWAVersion();

ParametersCopy Anchor Link

This method does not define input parameters.

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.

healthCheckCopy Anchor Link

Health check

Signature client.healthCheck(): Promise<HealthCheck>

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

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

Browser health diagnostics. This is not the Easy API /health HTTP envelope.

This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API. Browser health diagnostics. This is not the Easy API /health HTTP envelope.

isPluggedCopy Anchor Link

Check if phone is charging

Signature client.isPlugged(): Promise<boolean>

UsageCopy Anchor Link

const result = await client.getIsPlugged();

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.

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.

setMyNameCopy Anchor Link

Set host name

Signature client.setMyName(name: string): Promise<boolean>

UsageCopy Anchor Link

const result = await client.setMyName("OpenWA Bot");

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.

setMyStatusCopy Anchor Link

Set host status

Signature client.setMyStatus(statusText: string): Promise<boolean>

UsageCopy Anchor Link

const result = await client.setMyStatus("Available");

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.

import { SocketClient } from '@open-wa/socket-client';

const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.setProfilePicture({
  image: "data:image/png;base64,iVBORw0KGgo...",
});