@open-wa/socket-client

Source: packages/socket-client/README.md

Use @open-wa/socket-client from a Node.js application to call a running @open-wa/wa-automate API server and receive its runtime events. Commands use the server's HTTP API, and event subscriptions use Server-Sent Events (SSE).

Start the API serverCopy Anchor Link

npx @open-wa/wa-automate@5.1.0 --session-id main --host 127.0.0.1 --port 8002 --api-key replace-this-key

Keep the server on loopback or a private network unless you have configured an appropriate access boundary. The API key is sent by the client in the X-API-Key header for commands and as an api_key query parameter for the SSE connection.

Connect and send a messageCopy Anchor Link

npm install @open-wa/socket-client@5.1.0

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

const client = await SocketClient.connect('http://127.0.0.1:8002', 'replace-this-key');

client.onAnyMessage((message) => {
  console.log(message.id, message.body);
});

await client.sendText('447700900123@c.us', 'Hello from a remote client');

client.close();

SocketClient.connect waits for the event stream to connect before returning. The client provides typed convenience methods for the API, along with ask for calling a method by name.

DocumentationCopy Anchor Link

See the socket client guide for setup and available methods.

LicenseCopy Anchor Link

H-DNH 1.1 - Hippocratic + Do Not Harm