1. Telefonia
Khal Docs
  • Raiz
    • CRM
      • CRM — Overview
      • Genérico (data)
        • CRM - Genérico
        • Listar/filtrar registros (qualquer tabela do CRM)
        • Criar/atualizar registros (qualquer tabela do CRM)
        • Hard-delete (não permitido para tabelas company)
      • Empresas Relacionadas
        • CRM - Empresas relacionadas
        • Listar relacionamentos de uma empresa (ambas as direções)
        • Tipos de relacionamento disponíveis
        • Criar relacionamento entre duas empresas
        • Alterar o tipo do relacionamento
        • Inativar relacionamento (reversível)
        • Excluir relacionamento (hard-delete)
      • Ticket ↔ Empresa
        • CRM - Ticket <-> Empresa
        • Empresas elegíveis para o ticket
        • Vincular / trocar a empresa do ticket
      • Templates
        • CRM - Templates
        • Listar templates do tenant (apenas IDs, sem fields)
        • Detalhe completo do template (com fields)
        • Pesquisa formatada por scope (CRMSearchResult)
      • Empresas do cliente
        • Listar tipos de relacionamento
        • Listar empresas de um cliente
        • Vincular empresa ao cliente
        • Trocar a empresa principal
        • Alterar tipo de relacionamento
        • Inativar vínculo
        • Reativar vínculo
        • Excluir vínculo
    • Workflow
      • Workflow - Overview
      • Tickets
        • Workflow - Tickets
        • Criar ticket com auto-vínculo / criação de customer via contato
        • Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
        • Criar ticket (básico, com integração CRM opcional)
        • Movimentar ticket entre fases (ou finalizar)
        • Atualizar dados do ticket (nome, descrição, valor)
        • Vincular cliente CRM a um ticket existente
        • Adicionar nota ou mensagem ao ticket
        • Atribuir ou transferir o responsável do ticket
      • Workspaces & Workflows
        • Workflow - Workspaces & Workflows
        • Listar workspaces e workflows acessíveis ao usuário
        • Listar fases de um workflow
        • Listar tickets de uma ou mais fases (paginado)
    • Webhooks
      • Eventos
        • 📨 [Contrato] Evento entregue na sua URL
        • Catálogo de eventos disponíveis
      • Assinaturas
        • Listar webhooks cadastrados
        • Criar webhook (o secret aparece UMA única vez)
        • Testar conectividade de uma URL
        • Detalhar webhook
        • Atualizar webhook
        • Ativar/desativar webhook (toggle)
        • Remover webhook (soft delete)
      • Entregas
        • Log de entregas de uma assinatura
        • Reprocessar uma entrega
        • Reprocessar TODAS as entregas com falha
      • Integrações
        • Voz IA (ElevenLabs)
          • Criar ou atualizar a integração de Voz IA
          • Consultar a integração de Voz IA
          • Alterar a integração de Voz IA (secret, toggle, allowlist)
          • Remover a integração de Voz IA
          • Webhook pós-chamada (chamado pelo provedor de voz)
    • Configurações
      • Canais
        • WhatsApp oficial
          • Listar conexões de WhatsApp (a tela Canais › WhatsApp oficial)
          • Listar números disponíveis de uma WABA
          • Criar conexão de WhatsApp oficial
          • Conectar o número oficial (ativar a conexão)
        • Telefonia
          • Anexar gravação de ligação (telefonia de terceiros)
            POST
          • Registrar CSAT de ligação
            POST
          • Consultar status da gravação enviada
            GET
      • Templates
        • WhatsApp oficial
          • Listar templates HSM (a tela Templates › WhatsApp oficial)
          • Criar template HSM (+ Novo modelo)
          • Detalhar template
          • Atualizar template
          • Excluir template
          • Sincronizar templates com a Meta
          • Upload de mídia para o header do template
        • RCS
          • Listar templates de RCS
      • Base de dados
        • Modelo de colunas do CSV
        • Importar base (CSV) para uma tabela do CRM
        • Acompanhar as importações (validar o resultado)
        • Erros de uma importação
        • Exportar os erros em planilha
    • Raiz
      • Workflow
        • Tarefas
          • Criar tarefa
          • Listar tarefas
          • Resumo de tarefas
          • Consultar tarefa
          • Editar tarefa
          • Concluir tarefa
          • Cancelar (excluir) tarefa
          • Silenciar alarme
          • Tarefas do ticket
  • Esquemas
    • LoginRequest
    • FilterOperator
    • WebhookSubscription
    • ClienteEmpresaTipo
    • LoginResponse
    • FilterCondition
    • WebhookSubscriptionResumo
    • ClienteEmpresa
    • Error
    • Pagination
    • WebhookDelivery
    • ErroRegra
    • FilterRequest
    • WebhookEventEnvelope
    • FilterResponse
    • SetMethod
    • SetRequest
    • DeleteRequest
    • SuccessEnvelope
    • ErrorEnvelope
    • Empresa
    • EmpresaResumo
    • EmpresaRelacionadaCreate
    • EmpresaRelacionada
    • TicketInfoResponse
  1. Telefonia

Anexar gravação de ligação (telefonia de terceiros)

POST
/api/v3/telephony/recording
Registra a gravação de uma ligação feita em PABX próprio do parceiro e anexa o áudio dentro do ticket, reproduzível pelo agente.
A plataforma baixa o arquivo da URL informada, re-hospeda no storage do tenant e cria a mensagem de áudio no ticket — depois disso a gravação não depende mais da infraestrutura do parceiro.

Fluxo#

1.
POST /api/v2/ticket/custom cria o ticket e devolve o id (no topo da resposta, sem envelope).
2.
Este endpoint recebe esse id em ticket_id, junto do identificador da chamada e da URL da gravação.

Resposta 202, não 200#

O 202 significa aceito e enfileirado, não "áudio já disponível". O download é assíncrono.

Cuidados#

PontoRegra
Validade da URLPrecisa continuar acessível por ~20 minutos. A primeira tentativa ocorre ~15s após o 202, e em caso de falha há mais 19 tentativas de minuto em minuto
Query stringSuportada, desde que a extensão venha antes da ?. .../call.mp3?sig=abc funciona; .../download?file=call não
ReenvioSeguro com o mesmo call_id: não gera áudio duplicado. Enquanto o download está pendente, o reenvio devolve 202 mas não troca a URL do job em curso; depois de falha definitiva, reprocessa com a URL nova
Identidade da chamadaO call_id é a identidade da ligação no tenant. Reaproveitar um call_id já usado em outro ticket devolve 422 — proteção contra anexar áudio no atendimento errado
Ligação sem gravaçãorecording_url é obrigatória. Para registrar ligação sem áudio, use uma nota no ticket (POST /api/v2/ticket/message com is_note: true)
Rede internaURLs apontando para endereço privado, loopback ou link-local são recusadas
TamanhoTeto de 100 MB (~1h45 de wav 8 kHz mono). Acima disso o download é abortado e o áudio não entra no ticket — o 202 já terá sido devolvido

Requisição

Parâmetros Header

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢202Aceito
application/json
Gravação aceita e enfileirada para download. O áudio aparece no ticket em alguns minutos.
Bodyapplication/json

🟠400Requisição Inválida
🟠401Não Autorizado
🟠422Não Processável
🟠429Limite Excedido
🔴500Erro Interno
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/api/v3/telephony/recording' \
--header 'api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{
    "call_id": "1772743063.6136820",
    "ticket_id": "84cefe00-761e-467c-9f77-fbb05ecb7af9",
    "recording_url": "https://gravacoes.parceiro.com.br/2026/09/22/call-1772743063.mp3?X-Amz-Signature=abc",
    "phone": "5511988884444",
    "dial_status": "ANSWER",
    "ramal": "5056"
}'
Response Response Example
202 - Exemplo de Sucesso
{
    "ok": true,
    "message": "Gravação aceita. O áudio aparecerá no ticket em alguns minutos.",
    "call_id": "1772743063.6136820",
    "ticket_id": "84cefe00-761e-467c-9f77-fbb05ecb7af9"
}
Modificado em 2026-11-04 02:53:16
Página anterior
Conectar o número oficial (ativar a conexão)
Próxima página
Registrar CSAT de ligação
Built with