Instance

Connect an instance (get QR code)

Changed on

Initiates connection for an instance. Returns a base64-encoded QR code PNG if not yet connected, or a connected status message. While QR generation or a saved session reconnection is pending, returns 200 with connected=false and no base64. Saved sessions are preserved during reconnection.

post/v1/instance/{id}/connect

Request

  • Base URL
    http://localhost:8080
  • Auth
    API key in header apikey

Path parameters

idstring required

Instance ID

Response

OK

alwaysOnlineboolean
base64string
connectedboolean
groupsIgnoreboolean
idstring
messagestring
msgCallstring
pairingCodestring
pairingErrorstring
proxyHoststring
proxyPasswordstring
proxyPortstring
proxyProtocolstring
proxyUsernamestring
readMessagesboolean
rejectCallboolean
remoteJIDstring
saveMediaboolean
syncFullHistoryboolean

Changes