PluginClient Reference

The PluginClient is the WhatsApp-method interface provided in PluginInput. It is a host-managed proxy backed by the connected runtime page. PluginInput does not include a browser or CDP handle, and the proxy does not create an isolation boundary around trusted plugin code.

What PluginClient IsCopy Anchor Link

• A proxy that forwards method calls to window.WAPI in the connected runtime
• Available through client in your plugin's PluginInput
• Uses the host's runtime transport without exposing that transport to plugin code
• Forwards method names through ask() without an SDK method allowlist

What PluginClient Is NotCopy Anchor Link

• A browser or CDP interface. The client proxy does not expose CDP commands, DOM access, cookies, or page injection.
• Filesystem isolation. PluginClient has no filesystem methods; trusted in-process plugin code still has the OS permissions of its host process.
• A raw WebSocket. It is a managed proxy whose methods are forwarded by the host transport.

Generic Method DispatcherCopy Anchor Link

ask(method, args?)Copy Anchor Link

Call a method by name on the connected runtime's window.WAPI object. This is the most flexible way to interact with the runtime; ask() does not check the requested name against a safe-method list.

// Send a text message
const messageId = await client.ask<string>('sendText', ['1234567890@c.us', 'Hello']);

// Get host number
const number = await client.ask<string>('getHostNumber');

// Get a contact
const contact = await client.ask('getContact', ['1234567890@c.us']);

Parameters:

• method, Method name (e.g., 'sendText', 'sendImage', 'getHostNumber')
• args, Arguments to pass. Can be an array ['arg1', 'arg2'] or a record { key: 'value' }

Returns: Promise<T>, The method's return value, typed via the generic parameter.

Event ListenerCopy Anchor Link

listen(listener, callback)Copy Anchor Link

The SDK keeps this method for interface compatibility, but the current host does not support direct client listeners. Calling it logs a warning, does not register the callback, and resolves to the placeholder string 'noop'. Return event hooks from init() instead.

const result = await client.listen('onMessage', (data) => {
  console.log('Message received:', data);
});
// Current host result: 'noop'; the callback is not registered.

Parameters:

• listener, Listener name (e.g., 'onMessage', 'onAnyMessage')
• callback, Callback function receiving the event data

Returns: Promise<string>, currently 'noop'. There is no client-level unsubscribe flow; use events or named hooks from PluginInput for subscriptions.

Convenience MethodsCopy Anchor Link

These typed methods are provided for common operations. They all delegate to ask() under the hood.

sendText(to, content)Copy Anchor Link

Send a text message.

const messageId = await client.sendText('1234567890@c.us', 'Hello!');

Returns: Promise<string>, The message ID.

sendImage(to, url, filename, caption?)Copy Anchor Link

Send an image from a URL.

const messageId = await client.sendImage(
  '1234567890@c.us',
  'https://example.com/image.jpg',
  'image.jpg',
  'Check this out!'
);

sendFile(to, base64, filename, caption?)Copy Anchor Link

Send a file from base64 data.

const messageId = await client.sendFile(
  '1234567890@c.us',
  'data:application/pdf;base64,JVBERi0...',
  'document.pdf',
  'Here is the document'
);

sendLocation(to, lat, lng, text?)Copy Anchor Link

Send a location.

await client.sendLocation('1234567890@c.us', '51.5074', '-0.1278', 'London');

sendLinkWithAutoPreview(to, url, text)Copy Anchor Link

Send a link with an automatic preview.

await client.sendLinkWithAutoPreview(
  '1234567890@c.us',
  'https://example.com',
  'Check out this site'
);

reply(to, content, quotedMsgId)Copy Anchor Link

Reply to a specific message.

await client.reply('1234567890@c.us', 'Got it!', originalMessageId);

decryptMedia(message)Copy Anchor Link

Decrypt media from a message object.

const mediaDataUrl = await client.decryptMedia(message);
// mediaDataUrl is a data URL, such as 'data:image/png;base64,...'

Use this for images, voice notes, videos, and documents received in messages.

getHostNumber()Copy Anchor Link

Get the phone number of the connected WhatsApp account.

const number = await client.getHostNumber();
// Returns something like '447700900000'

getContact(contactId)Copy Anchor Link

Get information about a contact.

const contact = await client.getContact('1234567890@c.us');

getAllContacts()Copy Anchor Link

Get all contacts.

const contacts = await client.getAllContacts();

getAllChats()Copy Anchor Link

Get all chats.

const chats = await client.getAllChats();

sendSeen(chatId)Copy Anchor Link

Mark a chat as seen (blue ticks).

const success = await client.sendSeen('1234567890@c.us');

Returns: Promise<boolean>

Proxy FallbackCopy Anchor Link

Any method name not listed above can be called on the client object. The proxy forwards it to the runtime; availability depends on the connected runtime exposing that method through window.WAPI.

// These all work via the proxy:
await client.sendText('123@c.us', 'Hello');
await client.getHostNumber();
await client.someOtherMethod('args');

RelatedCopy Anchor Link

• Hooks reference, All available hooks
• PluginInput breakdown, What your plugin receives
• Plugin getting started, Build your first plugin