OpenWA icon

OpenWA

Interact with OpenWA WhatsApp API Gateway

Actions138

Session → Create

AI-generated

Summary

Create a named OpenWA session, optionally applying JSON configuration and an egress proxy URL. The session name is required; proxy and configuration are sent only when provided.

Inputs

  • sessionName (required) — Unique session name; the UI documents 3–50 characters using letters, numbers, and hyphens. The handler trims the value before sending it.
  • sessionConfig — Optional JSON object. The server reads autoRejectCalls (Baileys only), maxReconnectAttempts, and reconnectBaseDelay; other keys are ignored. The reconnect settings bound the gateway's reconnect attempts and delay.
  • proxyUrl — Optional full proxy URL using http, https, socks4, or socks5, up to 255 characters. It is supplied at creation so the session uses it when started; proxy authentication support depends on the engine and scheme.

Output shape

A single item containing the API response for the created session.

The operation creates the session through the session request handler. It does not start the session; use the session Start operation separately.

Links

Discussion