Pular para o conteúdo
Contatos

Gerar o Resumo (IA) do contato

v1.0.0
POSThttps://api.growthaisystem.com/api/v1/contacts/{id}/ai-summary
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposcontacts.writeconversations.readcontacts.ai_summary

A nota Resumo (IA) do contato: UMA por contato, com cinco seções fixas — quem é e o que quer; os pontos importantes, cada um com a data e a origem ("ligação de 15/10", "WhatsApp de 12/10"); as objeções; o que foi combinado e o próximo passo; o que ficou sem resposta — e o rodapé "Gerado por IA em DD/MM HH:MM; cobre até <data do último item>". O que não está no histórico sai como "não consta".

Fontes, numa linha do tempo só: as mensagens de todas as conversas do contato (todos os canais), as transcrições de ligação, as reuniões (agendadas e gravadas), as notas e tarefas do contato e dos negócios dele, os negócios (funil, etapa, valor, histórico de etapa), as respostas de formulário e os campos do cadastro.

Recorte de quem GERA: com um token OAuth, o resumo é gerado só com o que a PESSOA vê na tela (papel, "Só os meus", funis, Telefonia em "faz tudo" para as transcrições); com uma chave gos_, o escopo decide (opportunities.read, calendars.read e forms.read acrescentam negócios, reuniões e formulários). A leitura devolve a nota como ela foi gerada — o texto reflete o recorte de quem a gerou, como qualquer nota do contato. Contato fora do recorte responde 404, como o inexistente.

Gera com IA e consome créditos de IA do workspace. Gerar de novo REESCREVE a mesma nota (nunca cria outra); uma nota escrita por pessoa nunca é tocada — se alguém editou o resumo, ele vira nota dessa pessoa e nasce um resumo novo. includeCalls: false deixa as transcrições de ligação de fora (nenhuma chega ao modelo). Falha da IA responde erro com o motivo e não grava nada pela metade.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho mín. 1

Corpo da requisição

application/jsonobrigatório
  • includeCallsbooleanopcional

    Incluir as transcrições das ligações do contato. false: nenhuma transcrição de ligação chega ao modelo.

    • padrão true

Respostas

12 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

O resumo recém-gerado (a nota foi criada ou reescrita).

V1ContactAiSummary

  • contactIdstring

  • null = o contato ainda não tem resumo.

    • noteIdstring
    • titlestring
    • bodystring

      As cinco seções fixas (quem é, pontos importantes com data e origem, objeções, combinado e próximo passo, sem resposta) e o rodapé.

    • generatedAtstring

      ISO-8601: quando foi gerado pela última vez.

    • coversUntilstring | null

      ISO-8601 do último item do histórico que o resumo cobre.

    • includesCallsboolean

      Se as transcrições de ligação entraram nesta geração.

    • generatedByUserIdstring | null

      Quem pediu (a autora da nota); null = uma chave de integração.

  • transcribedCallsinteger

    Ligações transcritas do contato que esta credencial alcança (0 = includeCalls não muda nada).

    • faixa 0–1000