Sign in
latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-15420246.8 KB

533b3360e2e4

Connections

Import an extracted WhatsApp Web session (no QR)

post/connections/{phoneNumber}/import-session

Path parameters

phoneNumberstring required
Example:+551234567890

Phone number for connection. Must have + prefix.

Request body

candidateIndexnumber

Index into session.noiseCandidates to try first (only one candidate is the real pair).

clientNamestring

Name of the client to be used on WhatsApp connection

webhookUrlstring uri required

URL for receiving updates

webhookVerifyTokenstring required

Token for verifying webhook

includeMediaboolean

Include media in messages.upsert event payload as base64 string

syncFullHistoryboolean

Sync full history of messages on connection.

groupsEnabledboolean

Enable full group message processing. When false, group messages are accumulated and sent as activity summaries.

autoPresenceSubscribeboolean

Automatically subscribe to presence updates when sending/receiving messages or typing status to/from a contact. Subscriptions are ephemeral and re-established automatically.

Example request

{
  "session": {
    "id": "551101234567:12@s.whatsapp.net"
  },
  "clientName": "My WhatsApp Client",
  "webhookUrl": "http://localhost:3026/whatsapp/+1234567890",
  "webhookVerifyToken": "a3f4b2"
}

Response

Session import accepted; connecting