Changelog da API
Versão atual: 1.4.0 (cada resposta de /api/v1 traz o cabeçalho X-NexaChat-API-Version).
Política de versões
- Dentro da v1, só acréscimos: novos campos, rotas, eventos de webhook e parâmetros opcionais. Nada é removido nem muda de significado. O seu código deve ignorar campos que não conhece.
- Qualquer quebra vai para a v2 (
/api/v2), com aviso de, no mínimo, 90 dias e as duas versões no ar juntas por, no mínimo, 90 dias. - O widget segue a mesma regra:
/embed/v1.jsé estável (o/embed.jsé a própria v1). Uma mudança incompatível só sai em/embed/v2.js, com a v1 mantida por, no mínimo, 90 dias. - Avisos: mudanças programadas e manutenções chegam pelo evento de webhook
platform.noticee por e-mail aos contatos técnicos cadastrados no painel. O estado atual e os incidentes ficam em /status. - Rotas e campos descontinuados continuam funcionando durante todo o prazo e passam a responder com o cabeçalho
Deprecatione a data emSunset.
Histórico
Versão 1.4.0 · 2026-10-02
- Todas as respostas de
/api/v1trazem o cabeçalhoX-NexaChat-API-Version(ex.:1.4.0). - Evento de webhook
platform.notice(mudanças programadas, manutenções e incidentes) e contatos técnicos por empresa para avisos por e-mail. - Política de versões publicada: dentro da v1 só acréscimos; quebras só na v2, com aviso e convivência de no mínimo 90 dias.
- Webhooks:
Enviar testecom o corpo real de qualquer evento e troca de segredo com período de convivência (cabeçalhoX-NexaChat-Signature-Previous). - Widget:
/embed/v1.jsestável (o/embed.jsé a mesma v1), identidade do cliente assinada pelo seu servidor e API em JavaScript. Não altera a API REST.
Versão 1.3.0 · 2026-10-02
- Eventos de webhook
area.activatedearea.ended(áreas de aviso do mapa; sem coordenadas). GET /telephony/identifydevolveaffected_area(idename, ounull): o cliente mora numa área de aviso ativa. Só acréscimo.- Painel ao vivo, Metas e SLA, Pausas, Reincidências, Mapa e Sugestão de resposta por IA são recursos do painel e não alteram a API além dos itens acima.
Versão 1.2.0 · 2026-10-02
- Atendimento: novo campo
close_reason(motivo do encerramento, observação e quem encerrou: pessoa, robô ou API);POST /conversations/{id}/closeaceitaclose_reasonenote. - Webhook
conversation.closedagora trazclose_reason,close_noteeclosed_by. - Eventos novos:
sla.breached,agent.paused,agent.resumed,agent.pause_exceededecustomer.recurrent(cliente reincidente). - Atendimento: novo campo
recurrence(regras de reincidência em que se enquadrou).
Versão 1.1.0 · 2026-10-02
- Webhooks documentados na especificação (seção
webhooks): cabeçalhos, assinatura HMAC-SHA256, política de reenvio e o campotest. - Eventos novos:
quality.generated,lead.created,lead.stage_changed,invoice.paid,call.received,call.missed. - Mensagem: novos campos
channeletranscript(texto do áudio) e valores documentados dedelivery_status(sent, delivered, read, failed). - Atendimento: novos campos
tags,departmentequality(Nota de Qualidade, somente leitura). - Evento
message.receivedde áudio passa a trazertranscript.
Versão 1.0.0 · 2026-09-30
- Primeira versão pública: contatos, atendimentos, mensagens, agentes, filas e canais; tokens com escopo; paginação por cursor; Idempotency-Key; limite de 300 requisições por minuto.