POST/session/connect

Conecta aos servidores do WhatsApp

Descrição

Inicia a conexão com os servidores do WhatsApp com suporte a proxy e configuração de formato de webhook.

Modo QR Code: Se não existir uma sessão anterior, será gerado um QR Code que pode ser obtido pela rota qr.

Inscrição de Eventos: Se o parâmetro opcional Subscribe for informado, os webhooks ficam limitados aos tipos de evento especificados:

Message: Novas mensagens
ReadReceipt: Confirmações de leitura
Presence: Presença do usuário
HistorySync: Sincronização de histórico
ChatPresence: Presença no chat
Call: Eventos de chamada
Newsletter: Atualizações de newsletters
All: Inscreve em todos os eventos (padrão)

Modo Imediato:

Se Immediate for false: aguarda 10 segundos para obter o status real de conexão com o WhatsApp
Se Immediate for true: retorna imediatamente (consulte o status depois via status)

Formato do Webhook (NOVO):

legacy (padrão): envia eventos como parâmetros de query (compatível com versões anteriores)
json: envia eventos como payload JSON estruturado

Configuração de Proxy (NOVO): Configure proxy por instância para esta sessão:

Suporta: http://, https://, socks5://
Autenticação opcional por usuário/senha
Cada instância pode ter um proxy diferente
Deixe proxy_address vazio para remover o proxy

Modo Android: Use o parâmetro Phone para parear com número de telefone (modo Android).

Parâmetros

Corpo da requisição

Nome	Tipo	Localização	Obrigatório
`Subscribe` Event types to subscribe: Message, ReadReceipt, Presence, HistorySync, ChatPresence, Call, Newsletter, All	string[]	body	Não
`Immediate` If true, returns immediately. If false, waits 10 seconds for connection status	boolean	body	Não
`Phone` Phone number for Android mode pairing (optional, requires AndroidMode)	string	body	Não
`AndroidMode` Enable Android mode (phone pairing). If true, use 'Phone' parameter to receive pairing code	boolean	body	Não
`webhook_format` Webhook format: 'legacy' (query params) or 'json' (structured payload). Default: 'legacy'	string	body	Não
`proxy_address` Proxy URL (http://, https://, or socks5://). Optional for per-instance proxy	string	body	Não
`proxy_username` Proxy authentication username (optional)	string	body	Não
`proxy_password` Proxy authentication password (optional)	string	body	Não

Exemplo de requisição

curl -X POST 'https://api-server.dichat.com.br/session/connect' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "Subscribe": [
      "All"
    ],
    "Immediate": false
  }'

Respostas

200Response

application/json

{
  "code": 200,
  "data": {
    "details": "Connected!",
    "events": "Message",
    "jid": "12345@s.whatsapp.net",
    "webhook": "https://some.site/webhook?request=parameter"
  },
  "success": true
}