open-wa v5 is alpha. Use v4.76.0 for mature production systems unless you are validating v5.
The Client APIAPI ExplorerLicensing

@open-wa/client

User-facing API client for open-wa WhatsApp automation

Package Client Box Wally

Generated from packages/client/README.md by apps/docs/scripts/gen-workspace-readme-docs.js. Do not edit this page directly.

@open-wa/client

User-facing API client for Open-WA WhatsApp automation.

Part of the @open-wa v5 monorepo.

Features

  • Type-Safe: Full TypeScript support with Zod-based schemas.
  • Async/Await: Clean, modern API for sending messages, media, and more.
  • Easy Integration: Connects seamlessly to @open-wa/wa-automate servers.

Install

pnpm add @open-wa/client

Example

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

const client = await create({
  sessionId: 'main-session'
});

await client.sendText('1234567890@c.us', 'Hello from v5!');

Documentation

See the Developer Guide on our docs site.

License

H-DNH V1.0 — Hippocratic + Do Not Harm

Wally the Walrus typing

Was this helpful?

Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!

On this page