Webhook Pós-Chamada

{
  "id": 12345,
  "customer_phone": "+1234567890",
  "assistant_phone": "+1987654321",
  "duration": 125,
  "status": "completed",
  "extracted_variables": {
    "status": true,
    "summary": "Cliente interessado na demonstração do produto",
    "lead_quality": "alta",
    "next_action": "agendar_demonstração"
  },
  "input_variables": {
    "customer_name": "John Doe",
    "product_interest": "Pro Plan"
  },
  "transcript": [
    {
      "text": "Olá! Aqui é a Sarah da Sua SofIA. Como você está hoje?",
      "type": "transcript",
      "sender": "bot",
      "timestamp": 1756812511.315143
    },
    {
      "text": "Oi, estou bem, obrigado por ligar.",
      "type": "transcript",
      "sender": "human",
      "timestamp": 1756812514.104436
    },
    {
      "text": "Estou ligando para te contar sobre nossas novas funcionalidades do produto.",
      "type": "transcript",
      "sender": "bot",
      "timestamp": 1756812522.918859
    },
    {
      "text": "Isso parece interessante, me conte mais.",
      "type": "transcript",
      "sender": "human",
      "timestamp": 1756812525.234567
    }
  ],
  "formatted_transcript": "IA: Olá! Aqui é a Sarah da Sua SofIA. Como você está hoje?\nCliente: Oi, estou bem, obrigado por ligar.\nIA: Estou ligando para te contar sobre nossas novas funcionalidades do produto.\nCliente: Isso parece interessante, me conte mais.",
  "recording_url": "https://suasofia.online/storage/recordings/call-12345.mp4",
  "created_at": "2025-01-15T10:30:00.000000Z",
  "finished_at": "2025-01-15T10:32:05.000000Z",
  "transfers": [
    {
      "id": 12346,
      "status": "completed",
      "transfer_to": "+1555123456",
      "duration": 85,
      "carrier_cost": 0.0156,
      "transcript": null,
      "formatted_transcript": "",
      "created_at": "2025-01-15T10:31:00.000000Z",
      "finished_at": "2025-01-15T10:32:25.000000Z"
    }
  ],
  "lead": {
    "id": 789,
    "phone_number": "+1234567890",
    "variables": {
      "source": "website",
      "interest_level": "high"
    },
    "status": "contacted",
    "call_tries": 2,
    "created_at": "2025-01-15T09:00:00.000000Z",
    "updated_at": "2025-01-15T10:32:05.000000Z",
    "campaign": {
      "id": 456,
      "name": "Campanha de Demonstração do Produto",
      "status": "active",
      "allowed_hours_start_time": "09:00",
      "allowed_hours_end_time": "17:00",
      "allowed_days": ["segunda", "terça", "quarta", "quinta", "sexta"],
      "max_calls_in_parallel": 5,
      "max_retries": 3,
      "retry_interval": 60,
      "created_at": "2025-01-15T08:00:00.000000Z",
      "updated_at": "2025-01-15T08:00:00.000000Z"
    }
  }
}

{
  "id": 12345,
  "customer_phone": "+1234567890",
  "assistant_phone": "+1987654321",
  "duration": 125,
  "status": "completed",
  "extracted_variables": {
    "status": true,
    "summary": "Cliente interessado na demonstração do produto",
    "lead_quality": "alta",
    "next_action": "agendar_demonstração"
  },
  "input_variables": {
    "customer_name": "John Doe",
    "product_interest": "Pro Plan"
  },
  "transcript": [
    {
      "text": "Olá! Aqui é a Sarah da Sua SofIA. Como você está hoje?",
      "type": "transcript",
      "sender": "bot",
      "timestamp": 1756812511.315143
    },
    {
      "text": "Oi, estou bem, obrigado por ligar.",
      "type": "transcript",
      "sender": "human",
      "timestamp": 1756812514.104436
    },
    {
      "text": "Estou ligando para te contar sobre nossas novas funcionalidades do produto.",
      "type": "transcript",
      "sender": "bot",
      "timestamp": 1756812522.918859
    },
    {
      "text": "Isso parece interessante, me conte mais.",
      "type": "transcript",
      "sender": "human",
      "timestamp": 1756812525.234567
    }
  ],
  "formatted_transcript": "IA: Olá! Aqui é a Sarah da Sua SofIA. Como você está hoje?\nCliente: Oi, estou bem, obrigado por ligar.\nIA: Estou ligando para te contar sobre nossas novas funcionalidades do produto.\nCliente: Isso parece interessante, me conte mais.",
  "recording_url": "https://suasofia.online/storage/recordings/call-12345.mp4",
  "created_at": "2025-01-15T10:30:00.000000Z",
  "finished_at": "2025-01-15T10:32:05.000000Z",
  "transfers": [
    {
      "id": 12346,
      "status": "completed",
      "transfer_to": "+1555123456",
      "duration": 85,
      "carrier_cost": 0.0156,
      "transcript": null,
      "formatted_transcript": "",
      "created_at": "2025-01-15T10:31:00.000000Z",
      "finished_at": "2025-01-15T10:32:25.000000Z"
    }
  ],
  "lead": {
    "id": 789,
    "phone_number": "+1234567890",
    "variables": {
      "source": "website",
      "interest_level": "high"
    },
    "status": "contacted",
    "call_tries": 2,
    "created_at": "2025-01-15T09:00:00.000000Z",
    "updated_at": "2025-01-15T10:32:05.000000Z",
    "campaign": {
      "id": 456,
      "name": "Campanha de Demonstração do Produto",
      "status": "active",
      "allowed_hours_start_time": "09:00",
      "allowed_hours_end_time": "17:00",
      "allowed_days": ["segunda", "terça", "quarta", "quinta", "sexta"],
      "max_calls_in_parallel": 5,
      "max_retries": 3,
      "retry_interval": 60,
      "created_at": "2025-01-15T08:00:00.000000Z",
      "updated_at": "2025-01-15T08:00:00.000000Z"
    }
  }
}

O Webhook Pós-Chamada é enviado automaticamente para a URL do webhook especificada por você após a conclusão de cada chamada. Este webhook contém detalhes da chamada, variáveis extraídas, transcrição e, opcionalmente, a URL da gravação.

Configuração do Webhook

Para habilitar webhooks pós-chamada:

Configure a URL do webhook do seu assistente nas configurações do assistente
Habilite “Webhook pós-chamada” na configuração do assistente
Defina as variáveis pós-chamada que a IA deve extrair

Formato da Solicitação

O webhook é enviado como uma solicitação POST para a sua URL configurada com o seguinte payload JSON:

Estrutura do Payload

integer

Identificador único da chamada

string

Número de telefone do cliente no formato E.164 (ex: “+1234567890”) ou null se não estiver disponível

string

Número de telefone usado pelo assistente no formato E.164 ou null se não estiver disponível

integer

Duração da chamada em segundos

string

Status final da chamada (ex: “concluída”, “ocupada”, “falhou”)

object

Variáveis extraídas pela IA com base na configuração do seu esquema pós-chamada

Show Exemplo de variáveis extraídas

boolean

Se o objetivo da chamada foi alcançado

string

Resumo da chamada em poucas palavras

string|number|boolean

Quaisquer variáveis personalizadas que você definiu na configuração do assistente

object

Variáveis que foram passadas para o assistente antes do início da chamada

string

Transcrição completa da conversa

string

URL para baixar a gravação da chamada (incluída apenas se “Incluir gravação no webhook” estiver habilitado nas configurações do assistente)

string

Timestamp ISO 8601 quando a chamada foi iniciada

string

Timestamp ISO 8601 quando a chamada foi concluída (usa updated_at do registro da chamada)

object

Informações do lead (incluídas apenas para chamadas de campanha)

Show Propriedades do Lead

integer

Identificador único do lead

string

Número de telefone do lead

object

Variáveis associadas ao lead

string

Status atual do lead

integer

O número de tentativas de chamada feitas para este lead

string

Quando o lead foi criado

string

Quando o lead foi atualizado pela última vez

object

Informações da campanha (se disponível)

Show Propriedades da Campanha

integer

ID da campanha

string

Nome da campanha

string

Status da campanha

string

Horário de início permitido da campanha

string

Horário de término permitido da campanha

array

Dias permitidos da campanha

integer

Máximo de chamadas simultâneas para a campanha

integer

Máximo de tentativas de reenvio para leads

integer

Intervalo de reenvio em minutos

string

Quando a campanha foi criada

string

Quando a campanha foi atualizada pela última vez

array

Lista de chamadas de transferência feitas durante esta chamada (incluída apenas se a chamada tiver transferências)

Show Propriedades da Transferência

integer

Identificador único da chamada de transferência

string

Status final da chamada de transferência (ex: “concluída”, “ocupada”, “falhou”)

string

Número de telefone para o qual a chamada foi transferida no formato E.164

integer

Duração da chamada de transferência em segundos

number

Custo do transportador da chamada de transferência em USD

array

Transcrição bruta da chamada de transferência (null se não estiver disponível)

string

Transcrição formatada legível da chamada de transferência

string

URL para baixar a gravação da chamada de transferência (incluída apenas se “Incluir gravação no webhook” estiver habilitado e uma gravação existir)

string

Timestamp ISO 8601 quando a transferência foi iniciada

string

Timestamp ISO 8601 quando a transferência foi concluída

{
  "id": 12345,
  "customer_phone": "+1234567890",
  "assistant_phone": "+1987654321",
  "duration": 125,
  "status": "completed",
  "extracted_variables": {
    "status": true,
    "summary": "Cliente interessado na demonstração do produto",
    "lead_quality": "alta",
    "next_action": "agendar_demonstração"
  },
  "input_variables": {
    "customer_name": "John Doe",
    "product_interest": "Pro Plan"
  },
  "transcript": [
    {
      "text": "Olá! Aqui é a Sarah da Sua SofIA. Como você está hoje?",
      "type": "transcript",
      "sender": "bot",
      "timestamp": 1756812511.315143
    },
    {
      "text": "Oi, estou bem, obrigado por ligar.",
      "type": "transcript",
      "sender": "human",
      "timestamp": 1756812514.104436
    },
    {
      "text": "Estou ligando para te contar sobre nossas novas funcionalidades do produto.",
      "type": "transcript",
      "sender": "bot",
      "timestamp": 1756812522.918859
    },
    {
      "text": "Isso parece interessante, me conte mais.",
      "type": "transcript",
      "sender": "human",
      "timestamp": 1756812525.234567
    }
  ],
  "formatted_transcript": "IA: Olá! Aqui é a Sarah da Sua SofIA. Como você está hoje?\nCliente: Oi, estou bem, obrigado por ligar.\nIA: Estou ligando para te contar sobre nossas novas funcionalidades do produto.\nCliente: Isso parece interessante, me conte mais.",
  "recording_url": "https://suasofia.online/storage/recordings/call-12345.mp4",
  "created_at": "2025-01-15T10:30:00.000000Z",
  "finished_at": "2025-01-15T10:32:05.000000Z",
  "transfers": [
    {
      "id": 12346,
      "status": "completed",
      "transfer_to": "+1555123456",
      "duration": 85,
      "carrier_cost": 0.0156,
      "transcript": null,
      "formatted_transcript": "",
      "created_at": "2025-01-15T10:31:00.000000Z",
      "finished_at": "2025-01-15T10:32:25.000000Z"
    }
  ],
  "lead": {
    "id": 789,
    "phone_number": "+1234567890",
    "variables": {
      "source": "website",
      "interest_level": "high"
    },
    "status": "contacted",
    "call_tries": 2,
    "created_at": "2025-01-15T09:00:00.000000Z",
    "updated_at": "2025-01-15T10:32:05.000000Z",
    "campaign": {
      "id": 456,
      "name": "Campanha de Demonstração do Produto",
      "status": "active",
      "allowed_hours_start_time": "09:00",
      "allowed_hours_end_time": "17:00",
      "allowed_days": ["segunda", "terça", "quarta", "quinta", "sexta"],
      "max_calls_in_parallel": 5,
      "max_retries": 3,
      "retry_interval": 60,
      "created_at": "2025-01-15T08:00:00.000000Z",
      "updated_at": "2025-01-15T08:00:00.000000Z"
    }
  }
}

Configurações do Webhook

Você pode configurar as seguintes opções para o seu webhook pós-chamada:

Enviar webhook apenas em chamadas concluídas: Enviar o webhook apenas para chamadas concluídas com sucesso
Incluir gravação no webhook: Incluir o campo recording_url no payload
Variáveis personalizadas: Defina variáveis personalizadas que a IA deve extrair da conversa

Notas Importantes

Os campos customer_phone e assistant_phone podem ser null se as informações não estiverem disponíveis
O campo recording_url é incluído apenas se você habilitou “Incluir gravação no webhook” nas configurações do assistente
O objeto lead é incluído apenas para chamadas que fazem parte de uma campanha
O array transfers é incluído apenas para chamadas que têm chamadas de transferência associadas a elas
O objeto extracted_variables conterá as variáveis que você definiu na configuração do esquema pós-chamada do seu assistente

Referência da API

Assistentes

Folders

Labels

Chamadas

Conversas

AI

Mid Call Tools

Leads

Campaigns

Números de Telefone

SIP Trunks

Knowledgebases

SMS

WhatsApp

Webhooks

Chaves da API

Webhook Pós-Chamada

Configuração do Webhook

Formato da Solicitação

Estrutura do Payload

Configurações do Webhook

Notas Importantes

​Configuração do Webhook

​Formato da Solicitação

​Estrutura do Payload

​Configurações do Webhook

​Notas Importantes

Configuração do Webhook

Formato da Solicitação

Estrutura do Payload

Configurações do Webhook

Notas Importantes