Skip to main content
GET

Listar chamadas

Retorna as chamadas do ambiente autenticado, da mais recente para a mais antiga, com filtros por status, direção, agente, data e número. Passe include=insight para receber o resultado da conversa em cada chamada.

Endpoint

Cabeçalhos da requisição

string
obrigatório
Token Bearer. Formato: Bearer talq_seu_token_de_ambiente

Parâmetros de consulta

string
Acrescenta o resultado da conversa a cada chamada, como um objeto insight. Único valor aceito: insight. Qualquer outro valor, ou um array (include[]=insight), devolve 422. Veja O bloco insight.
string
Filtra por status da chamada. Opções: completed, canceled, no-answer, busy, failed, voicemail, in-progress.
string
Filtra por direção. Opções: inbound, outbound.
string
Só chamadas deste agente.
string
Início do período, por created_at. Formato YYYY-MM-DD. Padrão: 30 dias atrás.
string
Fim do período, inclusivo. Formato YYYY-MM-DD.
Prefixo do número to ou from, ou um id exato de chamada. Mínimo de 3 caracteres; valores menores são ignorados.
integer
Itens por página. Entre 1 e 100. Padrão: 20.
string
Cursor da página a buscar, como devolvido em pagination.next_cursor ou pagination.prev_cursor.

Exemplos de requisição

Resposta

Resposta de sucesso (200 OK)

O exemplo abaixo foi pedido com include=insight. Sem ele, a chave insight não aparece.

Campos da resposta

boolean
obrigatório
Se a requisição foi bem-sucedida.
array
obrigatório
Array de objetos de chamada.
object
obrigatório
Paginação por cursor. Não há contagem total.

O bloco insight

O que o agente capturou na conversa. Os mesmos dados que o webhook event_call_report entrega, disponíveis por consulta para uma página inteira de chamadas. summary e transcript não entram aqui por causa do tamanho; leia-os com Obter resultado da chamada.
string
obrigatório
Estado da análise pós-chamada. Opções: completed, pending, unavailable. A análise roda depois que a chamada termina; pending significa “consulte de novo mais tarde”, unavailable significa “não haverá resultado”. Regras completas em Obter resultado da chamada.
integer | null
obrigatório
Duração da chamada em segundos. Presente em qualquer estado. null quando não houve tempo de conversa medido (voicemail, no-answer, failed, busy).
boolean | null
obrigatório
Uma pessoa atendeu.
boolean | null
obrigatório
O objetivo configurado no agente foi atingido.
string | null
obrigatório
Opções: success, partial_contact, unsuccessful.
object | null
obrigatório
Os campos que o seu agente está configurado para coletar, com os valores extraídos da conversa. As chaves são as suas. {} quando nada foi coletado.
string | null
obrigatório
Campanha que originou a discagem. null fora de campanha. Cada retentativa é uma chamada própria.
human_detected, objective_achieved, call_result e collected_data são null sempre que analysis_status não for completed. Um false ali é resultado real, nunca análise ausente.

Respostas de erro

401 Não autorizado

422 Erro de validação

Devolvido para include desconhecido, status ou direction inválidos, ou data fora de YYYY-MM-DD.

Notas

Reconciliar um dia. Consulte com include=insight, date_from e date_to pelo menos 30 minutos depois do fim da última chamada. A essa altura analysis_status é completed ou unavailable para toda chamada, e o pending sumiu.
Janela padrão. Sem date_from, só os últimos 30 dias são devolvidos.
Fora desta resposta. O SID do provedor de telefonia e flags internos de roteamento ficam de fora de propósito. Gravações são servidas por GET /api/v1/calls/{call_id}/recording-url, que responde 404 quando não há.

Endpoints relacionados

  • Obter resultado da chamada: GET /api/v1/calls/{call_id}/insight — resumo e transcrição de uma chamada.
  • Obter chamadas do agente: GET /api/v1/agents/{agent_id}/calls
  • Obter URL da gravação: GET /api/v1/calls/{call_id}/recording-url
  • Fazer chamada: POST /api/v1/agents/{agent_id}/call