EVevolution-foundation
Instance Controller

Instances Connect

Changed on

Generates and returns the QR code for WhatsApp connection

get/instance/connect/{instance}

Request

  • Base URL
    https://evolution-example
  • URL
    https://evolution-example/instance/connect/{instance}
  • Auth
    API key in header apikey

Path parameters

instancestring required

Name of the instance to connect

Query parameters

numberstring

Phone number (with country code) to be connected

Response

Ok

pairingCodestring

The unique code used for pairing a device or account.

codestring

A specific code associated with the pairing process. This may include tokens or other identifiers.

countinteger

The count or number of attempts or instances related to the pairing process.

Example response

{
  "pairingCode": "WZYEH1YY",
  "code": "2@y8eK+bjtEjUWy9/FOM...",
  "count": 1
}

Changes

  • v2c153448703e5Revision changes
    • info

      api operation id instanceConnect was added

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      api tag Instance Controller added

    • info

      api tag Instance removed

    • info

      added the new optional query request parameter number

    • info

      added the non-success response with the status

  • v20c4620ca5ed5Revision changes
    • warning

      deleted the query request parameter number

    • info

      api operation id instanceConnect removed and replaced with

    • info

      the endpoint scheme security ApiKeyAuth was removed from the API

    • info

      api tag Instance added

    • info

      api tag Instance Controller removed

    • info

      removed the non-success response with the status