Skip to content

Novidades ​

Registro das mudanças na API, da mais recente para a mais antiga. A regra é compatibilidade: campos existentes mantêm nome e significado; mudanças entram como campos novos. Quando algo deixa de ser aceito, está dito explicitamente.

Outubro de 2026 — logs das chamadas ​

  • Novo cabeçalho X-Request-Id em toda resposta, sucesso ou erro. Guarde-o no seu log.
  • Nova tela Logs da API no OuvixPRO: cada chamada feita com as suas chaves, com status, código do erro, parâmetros, duração, tamanho e IP de origem; filtros por período, status, endpoint e chave; detalhe com a URL e um curl para reproduzir. O X-Request-Id localiza a linha. Veja Limites e erros.
  • A autenticação passou a rodar antes da validação dos parâmetros: sem chave válida a resposta é sempre 401, mesmo que falte de/ate.

Outubro de 2026 — a tela pronta ​

Para quem quer reproduzir o painel OuvixPRO no próprio sistema sem reescrever regra nenhuma. Tudo é calculado pelo mesmo código que desenha a interface.

  • Novo bloco painel.tela em GET /v1/painel: as nove telas (resumo, fluxo, qualidade, acesso, comercial, horarios, venda, renovacao, insights) já montadas — cards com texto pronto (valor), cor (tone), legenda (hint) e a lista de conversas que abre ao clicar — mais tela.listas, com os ids, selos e notas de cada lista de evidência.
  • Novo endpoint GET /v1/tela: só as telas, as listas e os atendimentos referenciados. Aceita tela=venda (ou qualquer uma das nove) para vir uma por vez, com apenas os atendimentos que ela usa.
  • Novo endpoint GET /v1/catalogo: rótulos, cores, metas, catálogo de planos, motivos e regras de tom. Não depende de unidade nem período; cache de 1 hora.
  • Novo bloco rotulos em todo atendimento: quando, momento, perfil, tipo (com label e cor), chips de contexto, tags de planos e o desfecho pronto para aluno novo (novo), venda (venda) e renovação (renovacao).
  • Correção: o mesmo atendimento recebia ids diferentes conforme a lista (atend_6, atend_6:2, atend_6:3). Agora é um só id por conversa em todas as listas; o sufixo :n só aparece quando duas conversas distintas dividem o mesmo atendimento_id.
  • Novo guia Montando a tela.

Outubro de 2026 — áudio pelo id do atendimento ​

  • Novo endpoint GET /v1/atendimentos/{id}/audio: entrega só o trecho da conversa, igual ao play do painel, sempre em WAV, com documento e nome completo em silêncio. Conversas que atravessam a troca de arquivo vêm coladas em um único áudio. Detalhes em Áudio.
  • Novo bloco audio em todo atendimento (também nos itens de insights e nas listas de protocolo): url, duracao_s, partes. null quando não há gravação.
  • Removidos da resposta os campos internos de arquivo: id_upload, nome_arquivo, inicio_hms, fim_hms, arquivos, pii_mutes, id_cliente. A API não expõe mais referência a arquivos de gravação.
  • Descontinuado GET /v1/audio (parâmetros id_upload, inicio_hms, fim_hms). Responde 410 endpoint_removido.
  • Nova página Começando e reorganização desta documentação sob a marca OuvixPRO.

Outubro de 2026 — desfecho da venda ​

A conta de venda passou a ter três estados em vez de dois. Antes, uma conversa de plano era "fechou" ou "não fechou"; agora o áudio cortado é separado.

Em painel.protocolo

CampoO que é
fechadasConversas que fecharam um plano (fechou=true ou protocolo.plano_fechado).
abertasSaíram sem fechar e isso aparece no áudio (fechou=false).
semDesfechoO áudio corta antes do fim (fechou=null). Não conta nem como fechada nem como aberta.
vendasNAgora é fechadas + abertas + semDesfecho.

Em cada atendimento

CampoO que é
desfecho_vendaLeitura dedicada do desfecho: eh_venda, fechou, plano_fechado, evidencia (fala literal que prova) e proximo_passo. Presente em toda conversa de plano.
fechouPassa a seguir a mesma regra em todas as visões: true fechou plano, false saiu sem fechar, null sem desfecho no áudio.
protocolo.plano_fechadoSempre preenchido quando fechou=true; sempre null quando fechou=false.
motivo_nao_fechouDois valores novos: volta_depois (volta outro dia para fechar) e diaria (pagou só a diária avulsa, R$ 49,90 — não é plano).
idAgora vem também nos itens de protocolo.vendas, fechadas, abertas, semDesfecho, renovacoes, passosVenda[].fez/faltou e em insights[].itens[]. É o mesmo id de painel.atendimentos.

Regras que a leitura aplica

  • Fechou só com sinal forte na fala (link do contrato, cadastro do cartão, "fechou", liberação do acesso).
  • Diária avulsa não é plano: fechou=false, motivo_nao_fechou="diaria".
  • Cadastro digital ou ativação de quem já pagou não é venda: desfecho_venda.eh_venda=false, fora de protocolo.vendas.
  • Quem entra por Gympass/Wellhub ou TotalPass fica fora de protocolo.vendas (agregador preenchido).
  • Ex-aluno que volta e pede plano é venda.

Ordem das listas

Toda lista de atendimentos (atendimentos, novosAlunos, protocolo.vendas, evidencias, insights[].itens…) vem em ordem de data_ref e horario, do mais cedo para o mais tarde. Antes, algumas listas vinham com "fechadas primeiro".

Alunos novos

novosFechados e funilNovos.fechados contam aluno novo com cadastro (nome, documento ou ficha). Plano fechado é protocolo.fechouN. As duas contas são diferentes de propósito: um visitante pode ter cadastro e ainda não ter plano.

Insights

painel.insights é uma lista de grupos: chave, tipo (pendencia, decisao, risco), tema, assunto, acao, qtd, dias e itens[] (um por conversa, com id, quem, titulo, fato, aberto, acao). O formato antigo (assunto, qtd, aproveitou) não existe mais.

Outubro de 2026 — Id_unidade ​

  • Id_unidade substituiu unidade em toda chamada. Boituva é 375. O parâmetro antigo não é mais aceito.
  • visao=professor reservada; responde visao_indisponivel até o painel do tablet existir.

Documentação da API OuvixPRO.