PAPI WhatsApp icon

PAPI WhatsApp

Interaja com a PAPI WhatsApp API

Instância → Configurar WebSocket

AI-generated

Summary

Configure the WebSocket settings for a specified WhatsApp instance to enable real-time event notifications.

Inputs

  • ID da Instância (required) — The unique identifier of the WhatsApp instance to configure.
  • URL do WebSocket (required) — The WebSocket server URL where the instance will send event data (e.g., ws://seu-servidor.com/ws).
  • WebSocket Ativo — Boolean flag to enable or disable the WebSocket connection for the instance (default is true).
  • Eventos WebSocket — Array of event types to listen for on the WebSocket connection; options include messages, connection, and QR code events (default includes all three).

Output shape

a single JSON object representing the updated WebSocket configuration for the instance

The response includes the WebSocket configuration reflecting the URL, enabled state, and subscribed events. Errors such as unauthorized access or instance not found are returned as error messages.

Discussion