Canais

Canais são as conexões de WhatsApp na sua conta. O ciclo de vida completo está em Conceitos → Canais; esta página cobre o formato na rede (wire shape).

Listar canais

Retorna todos os canais do cliente autenticado, os mais recentes primeiro. Canais com exclusão lógica (soft-delete) são excluídos.

curl -s "$WHATISUP_API/v1/channels" \
  -H "Authorization: Bearer $WHATISUP_API_KEY"

{
  "data": [
    {
      "id": "8d653c66-e4ff-43ee-97da-3de5ad5680d4",
      "customer_id": "cust_01J6...",
      "name": "primary",
      "phone_number": "5511999999999",
      "status": "connected",
      "last_seen_at": "2026-05-01T12:34:56.000Z",
      "metadata": {},
      "created_at": "2026-04-12T08:11:32.000Z",
      "updated_at": "2026-05-01T12:34:56.000Z"
    }
  ]
}

Criar canal

curl -sX POST "$WHATISUP_API/v1/channels" \
  -H "Authorization: Bearer $WHATISUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"support-line","metadata":{"team":"support"}}'

A resposta é um objeto Channel. O status começa em pending — a conexão de WhatsApp ainda não foi alocada. Busque o QR para iniciar uma.

Obter um canal

Retorna o canal único. Dá 404 para canais que pertencem a outro cliente (nunca vazamos um 403 de "tenant errado"; ambos parecem "not found").

Obter o QR atual

Inicia preguiçosamente a conexão de WhatsApp se não houver uma rodando, então aguarda até ~10s por um QR. Retorna data:image/png;base64,… mais a string crua em formato de rede (útil se você quiser renderizar com sua própria biblioteca de QR) e um expires_at.

{
  "qr": "data:image/png;base64,iVBORw0KGgo...",
  "raw": "2@dPBI4Tg9Mc...,vlD4Pmkr...",
  "expires_at": "2026-05-01T12:35:25.000Z"
}

O fluxo Pair do dashboard usa SSE no lugar — ele recebe o QR empurrado sem polling.

Exclusão lógica (soft-delete)

Para o socket, limpa o auth-state, marca a linha como excluída. Entregas de webhook que referenciaram este canal continuam consultáveis para forense.

curl -sX DELETE "$WHATISUP_API/v1/channels/8d653c66-e4ff-43ee-97da-3de5ad5680d4" \
  -H "Authorization: Bearer $WHATISUP_API_KEY"

Retorna 204 No Content.

Saúde do número

O quanto o WhatsApp tende a restringir o número: level (good, warning, danger, restricted), os reasons, os contatos novos e a taxa de resposta dos últimos 7 dias, e o que a auto-proteção está fazendo. Recalculado a cada 15 minutos; uma restrição do WhatsApp aparece na hora. O webhook channel.health dispara quando o nível muda. Veja Mantendo os números saudáveis.

Limites do WhatsApp

O que o próprio WhatsApp informa do número: new_chats (a cota pra começar conversas com quem nunca escreveu pra ele) e restriction (um bloqueio temporário de mandar mensagem pra gente nova, com ends_at). O webhook channel.limits dispara quando um dos dois muda. O gateway nunca recusa um envio por causa deles — um envio pra alguém novo enquanto valem traz um item em warnings.

Ritmo de envio

Uma pausa aleatória entre os envios deste número e "digitando…" antes de cada um, mais a chave da auto-proteção (desligada, a menos que você ligue). Enquanto o número tem ritmo, os envios entram na fila (202, status: "queued") e saem um de cada vez.

Proxy

Passa o tráfego de WhatsApp do número pelo seu proxy SOCKS5, SOCKS4 ou HTTP(S). O PUT testa o proxy antes (test: false pula o teste) e não salva nada se o teste falhar; POST …/test testa uma url sem salvar, ou o proxy salvo. Até 10 testes por minuto por conta (429 proxy_test_limit). A senha fica guardada criptografada e nunca volta na resposta.