Conectar instância

Amb. de Produção

https://api.way-api.io

POST

/instances/{instanceId}/connect

Última modificação:2026-09-17 22:00:23

Inicia a conexão da instância com o WhatsApp.

Escolha um método em connectionType:

qrcode: a resposta traz qrCode como uma imagem pronta em data URL. Use esse valor diretamente
no atributo src de uma imagem e escaneie pelo WhatsApp.

code: a resposta traz code, que deve ser digitado no WhatsApp para vincular o aparelho.

Envie phoneNumber nos dois métodos, com código do país e DDD, somente com dígitos.

Se a instância já estiver conectada ou conectando, desconecte-a antes. Use forceConnect: true somente
quando a própria resposta de erro orientar uma nova tentativa forçada.

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 'https://api.way-api.io/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-09-17 22:00:23

Página anterior

Listar chats da instância

Próxima página

Desconectar instância