Referência da API

.md

Conversas

Uma conversa é um contato falando por um canal. É a unidade que a sua equipe atende e a que os webhooks referenciam.

Listar conversas

GET/api/v1/conversations

Lista as conversas, da que teve mensagem mais recente para a mais antiga.

Parâmetros da URL

  • statustexto

    Um de open, in_flow ou resolved. Qualquer outro valor responde 422.

  • channelIdtexto

    Filtra por número. Uma chave de canal que pedir outro recebe 403.

  • contactIdtexto

    Todas as conversas de um contato (uma por canal por onde ele falou).

  • pageinteiro

    A partir de 1.

  • limitinteiro

    De 1 a 200. Padrão 50.

Pedidocurl
curl "https://linkzap.orion.moe/api/v1/conversations?status=open&limit=20" \
  -H "Authorization: Bearer lz_SUA_CHAVE"
RespostaJSON
{
  "data": [
    {
      "id": "cnv_5ad2...",
      "status": "open",
      "channel": { "id": "chn_9f2a...", "label": "Recepção", "provider": "web" },
      "contact": { "id": "ctt_3c81...", "phone": "5592999990000", "name": "Maria Souza" },
      "assignedTo": "usr_44e1...",
      "participants": ["usr_7b20..."],
      "unread": 2,
      "lastMessageAt": "2026-09-21T14:02:59.000Z",
      "lastMessagePreview": "Pode ser quinta de manhã?",
      "automationPausedUntil": null,
      "createdAt": "2026-09-19T08:30:00.000Z"
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 37
}

Os três estados

  • open — está na fila humana, esperando alguém (ou já com responsável).
  • in_flow — um fluxo está conduzindo a conversa. Ela não aparece na aba “Abertos” do painel, porque não está esperando ninguém.
  • resolved — o atendimento foi encerrado. Uma mensagem nova do contato reabre.

automationPausedUntil diz até quando a automação está calada nessa conversa — é o que acontece automaticamente depois que uma pessoa responde, para a Aura não falar por cima. unread é a contagem que a equipe vê no painel, não um estado do WhatsApp.

O que esta rota ainda não faz

Ela lê. Resolver, reabrir, atribuir a alguém, encaminhar para um setor ou pausar a automação continuam sendo ações do painel — não existem por API hoje, e preferimos dizer isso a documentar um endpoint que não há. Se a sua integração precisa de alguma delas, fale com o suporte: saber qual é a que falta é o que decide a ordem em que elas entram.