WhatsApp Gateway icon

WhatsApp Gateway

Envia mensagens e gerencia sessões/contatos no WhatsApp Gateway

Actions27

Session → Start

AI-generated

Summary

Start a WhatsApp session by sending a POST request to the specified session's start endpoint on the WhatsApp Gateway API.

Inputs

  • Session (Name or ID) (required) — The name or ID of the WhatsApp session to start, e.g., 'campanha1'. This identifies which session to activate.
  • Request Options — Optional HTTP request configuration including batching (items per batch and interval), SSL certificate acceptance, proxy settings, and request timeout.

Output shape

a single JSON object or array reflecting the session start response from the WhatsApp Gateway API

The output is directly from the API call to POST /api/sessions/{session}/start. If the session is quarantined and the 'Continue on Quarantine' setting is enabled in related message operations, responses may include a blocked status instead of erroring, but this does not apply here explicitly. There is no pagination or special error envelope described for this call.

Examples

Example 1: Activate a WhatsApp session named 'campanha1' to begin messaging via that session.

Set resource to 'Session', operation to 'Start', and provide the session name/id. Optionally configure request options for proxy or timeout.

Links

Discussion