Conectar instância

Amb. de Desenv.

http://localhost:3000

POST

/instances/{instanceId}/connect

Inicia o pareamento da instância.

O campo connectionType define o método de pareamento:

qrcode: retorna qrCode com conteúudo a ser escaneado. É necessário copiar o conteúdo e gerar um QRCode com ele para que seja possível escanear.

code: retorna code para conexão através do WhatsApp.

A instância precisa estar disconnected no banco. Se o status persistido for connected ou connecting,
a API retorna 422 com a orientação de chamar disconnect antes de tentar conectar novamente.

Se a instância estiver com status_reason = forbidden (sessão WhatsApp bloqueada), o connect manual é
rejeitado com 422 a menos que forceConnect = true seja enviado no body.

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200OK

application/json

The request has succeeded.

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠422Erro de Parâmetro

Request Example

Shell

JavaScript

Java

Swift

curl --location 'http://localhost:3000/instances//connect' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "connectionType": "qrcode",
    "phoneNumber": "5511999999999",
    "forceConnect": true
}'

Response Example

200 - Sessão já autenticada

{
    "status": "connected"
}

Modificado em 2026-06-12 15:08:32

Página anterior

Listar chats da instância

Próxima página

Desconectar instância