- Endpoints de webhook recebem
telephony.complete(chamadas telefônicas) ouweb.complete(chamadas web e chamadas de teste com microfone no builder) com o payload estável documentado abaixo, umevent_idpor entrega, um tempo limite de 30 s e tentativas por até 24 h. - O webhook legado de URL única recebe uma tentativa síncrona (tempo limite de 10 s, sem tentativas) com um payload ligeiramente diferente — consulte Diferenças do payload legado.
Payload da solicitação (entregas de endpoint)
Motivos de término
Formato da transcrição
Cada entrada emtranscripts é um turno de conversa. As funções são
user (fala de quem liga), model (fala do agente e chamadas de ferramenta),
tool (resultados de ferramentas) e system (eventos da chamada, como
trocas de idioma).
Para o histórico de turnos totalmente estruturado (com marcadores de
interrupção, prompts de confirmação e posições brutas), use
GET /v1/calls/{call_id}/history.
Diferenças do payload legado
O envelope do webhook legado de URL única é{"type": "telephony.complete" | "web.complete", "data": {…}}, sem
event_id, e seus data diferem do payload do endpoint:
- O array de turnos fica em
history, não emtranscripts(com o mesmo schema de turno mostrado acima). - O conjunto de campos é o relatório bruto de fim de chamada e pode incluir campos internos adicionais além da tabela acima — trate campos desconhecidos como informativos.
- Chamadas web (
direction: "web") omitemfrom_number/to_numbere adicionamorigin_domain. - Chamadas de teste de microfone no Builder são reportadas como
telephony.completeno caminho legado (o sistema de endpoints as mapeia paraweb.complete). - Coordenação de transferência: quando uma chamada termina em uma transferência, o
webhook legado é chamado de forma síncrona e pode responder
{"transfer_ready": false}para sinalizar que o destino da transferência não está pronto. Qualquer outra resposta (ou a ausência de webhook legado) permite que a transferência prossiga. As entregas ao endpoint nunca são consultadas para isso.
Exemplo de manipulador
Casos de uso comuns
Integração com CRM
Armazene a transcrição e a URL da gravação de cada chamada junto aos
registros dos seus clientes.
Análises
Envie transcrições para um pipeline de modelagem de tópicos, extração
de sinais de CSAT ou monitoramento da taxa de transferências.
Revisão de qualidade
Abra chamadas em uma ferramenta de QA para revisão humana ou processe-as
com seu próprio modelo de avaliação.
Notificações
Acione um colega humano em caso de transferência ou falha.
Relacionados
telephony.incoming / web.incoming
A contraparte bloqueante executada no início da chamada.
Catálogo de eventos
Outros tipos de evento que você pode assinar.
API de histórico de chamadas
Os mesmos dados acessíveis via REST para preenchimento retroativo ou reprodução.