VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Histórico e ligações

Ler, em modo somente consulta, as conversas e mensagens do WhatsApp Confluence, baixar mídias e CSV e ouvir as ligações atendidas.

Esta seção é a leitura do que aconteceu no número de WhatsApp da loja: a lista de conversas, as mensagens de cada uma, o arquivo de mídia de uma mensagem, a exportação em CSV e o registro das ligações de voz atendidas pelo atendente virtual. Nada aqui envia mensagem nem altera estado; responder, assumir ou cobrar são ações de outras seções.

Pontos-chave
  • Todas as rotas ficam em /api/v1/admin/whatsapp-confluence/... e exigem um token de administrador. Na API de administração a leitura cobre todas as contas e todos os sellers.
  • Uma conversa liga um telefone de cliente a um número da loja; as mensagens vêm da mais nova para a mais antiga e a paginação usa um cursor (before).
  • A lista de conversas não devolve total: peça páginas até vir uma lista vazia.
  • O CSV tem no máximo as 200 mensagens mais recentes da conversa.
  • Ligações e gravações são dados sensíveis (nome, endereço, às vezes CPF): o áudio só sai por rota autenticada.

Como funciona

  1. Liste as conversas
    Listar conversas com filtros como filter=unread e busca q. Cada item traz o id que as outras rotas pedem.
  2. Abra a conversa
    Mensagens e CSV devolve as mensagens paginadas e um resumo da conversa.
  3. Baixe a mídia
    Mensagens com foto, áudio ou documento têm media_url (link de 12 horas) ou podem ser baixadas por Mídia da mensagem.
  4. Consulte as ligações
    Ligações lista as chamadas de voz atendidas, com transcrição, nota e gravação.

Conceitos-chave

Conversa, mensagem e janela de 24 horas

Uma conversa (thread) é única por par número da loja e telefone do cliente. Depois que o cliente escreve, a loja tem 24 horas (csw_expires_at) para responder com texto livre; passado esse prazo só vale template aprovado pela Meta. Um anúncio que leva ao WhatsApp abre ainda um ponto de entrada gratuito de 72 horas (fep_expires_at).

Códigos de uma letra

CampoCódigoSignificado
directionI / ORecebida do cliente / enviada pela loja
originCCliente
originAAPI ou atendente pela caixa de entrada
originBAssistente automático
originEEco do aplicativo WhatsApp Business no celular
originHHistórico importado no cadastro do número
status (mensagem)Q S D R FNa fila, enviada, entregue, lida, falhou
bot_modeA P HAssistente, assistente pausado, pessoa

Duas famílias de rotas de WhatsApp

A plataforma tem duas caixas de entrada de WhatsApp na API de administração: esta, sob /api/v1/admin/whatsapp-confluence/..., e a da seção caixa de entrada, sob /api/v1/admin/whatsapp/.... São conjuntos de rotas separados, com formatos de resposta diferentes. Use ids de conversa e de mensagem sempre na família em que os obteve.

Datas

Datas de conversa e mensagem em RFC 3339 (UTC). started_at das ligações também vem em UTC, no formato 2026-10-10T14:32:10Z.

Endpoints

MétodoCaminhoPara que serve
GET/api/v1/admin/whatsapp-confluence/threadsLista as conversas, as mais recentes primeiro. Conversas
GET/api/v1/admin/whatsapp-confluence/threads/{id}Retorna uma conversa. Conversas
GET/api/v1/admin/whatsapp-confluence/threads/{id}/messagesPagina as mensagens de uma conversa. Mensagens e CSV
GET/api/v1/admin/whatsapp-confluence/threads/{id}/export.csvBaixa as mensagens da conversa em CSV. Mensagens e CSV
GET/api/v1/admin/whatsapp-confluence/media/{messageID}Devolve os bytes da mídia de uma mensagem. Mídia da mensagem
GET/api/v1/admin/whatsapp-confluence/callsLista as ligações atendidas. Ligações
GET/api/v1/admin/whatsapp-confluence/calls/{callID}Retorna uma ligação com a transcrição. Ligações
GET/api/v1/admin/whatsapp-confluence/calls/{callID}/audioEntrega a gravação de uma ligação. Ligações

Erros comuns

  • Esperar um total na lista de conversas. Não existe: continue pedindo page até vir threads vazio.
  • Paginar mensagens com page. Mensagens usam cursor: passe o next_before da resposta anterior como before.
  • Achar que ler marca como lido. Abrir a conversa não zera unread_count.
  • Tratar 200 com lista vazia como sucesso garantido. Um UUID bem formado que não existe devolve 200 com messages vazio (e CSV só com o cabeçalho); só GET /threads/{id} responde 404.
  • Passar um id que não é UUID para o CSV. A exportação responde 500 com uma mensagem de erro técnica, sem tratamento; valide o UUID antes.
  • Abrir o CSV direto no Excel sem cuidado. O corpo da mensagem é texto do cliente e não é protegido contra fórmulas.
  • Usar Authorization em <img> e <audio>. Tags não enviam o cabeçalho; use o media_url assinado.

Próximos passos

Conversas
Comece listando e abrindo conversas.
Ligações
Transcrição, nota e gravação.
Resultados e orçamento
Números agregados do canal.
Anterior
Responder ao cliente
Próxima
Conversas
Nesta página
  • Como funciona
  • Conceitos-chave
  • Conversa, mensagem e janela de 24 horas
  • Códigos de uma letra
  • Duas famílias de rotas de WhatsApp
  • Datas
  • Endpoints
  • Erros comuns
  • Próximos passos