# Requisição 1: Obter todas as chamadas de um agente
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/calls" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todas as chamadas de um agente
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/calls', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": [
{
"id": "uuid",
"sid": "call_sid_123",
"to": "+5511987654321",
"to_formatted": "(123) 456-7890",
"from": "+0987654321",
"from_formatted": "(098) 765-4321",
"is_testing": false,
"direction": "outbound",
"status": "completed",
"duration": 120,
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "uuid-2",
"sid": "call_sid_456",
"to": "+5511976543210",
"to_formatted": "(987) 654-3210",
"from": "+5511987654321",
"from_formatted": "(123) 456-7890",
"is_testing": true,
"direction": "inbound",
"status": "answered",
"duration": 85,
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 3,
"per_page": 20,
"total": 50,
"from": 1,
"to": 20
}
}
Chamadas e Campanhas
Obter Chamadas do Agente
Recuperar uma lista de chamadas para um agente específico
GET
/
api
/
v1
/
agents
/
{agent_id}
/
calls
# Requisição 1: Obter todas as chamadas de um agente
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/calls" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todas as chamadas de um agente
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/calls', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": [
{
"id": "uuid",
"sid": "call_sid_123",
"to": "+5511987654321",
"to_formatted": "(123) 456-7890",
"from": "+0987654321",
"from_formatted": "(098) 765-4321",
"is_testing": false,
"direction": "outbound",
"status": "completed",
"duration": 120,
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "uuid-2",
"sid": "call_sid_456",
"to": "+5511976543210",
"to_formatted": "(987) 654-3210",
"from": "+5511987654321",
"from_formatted": "(123) 456-7890",
"is_testing": true,
"direction": "inbound",
"status": "answered",
"duration": 85,
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 3,
"per_page": 20,
"total": 50,
"from": 1,
"to": 20
}
}
Obter Chamadas do Agente
Recuperar uma lista de chamadas para um agente específico com opções de filtragem por status, direção e datas.Endpoint
GET /api/v1/agents/{agent_id}/calls
Parâmetros de caminho
string
obrigatório
O identificador único do agente. Você pode encontrá-lo na lista de agentes.
Cabeçalhos da requisição
string
obrigatório
Token Bearer para autenticação. Formato:
Bearer talq_your_environment_token_hereParâmetros de consulta
string
Acrescenta o resultado da conversa a cada chamada. Único valor aceito:
insight. Qualquer outro valor devolve 422. Veja Listar chamadas para os campos.string
Filtrar por status da chamada. Opções:
initiated, ringing, answered, completed, failed, busy, no-answerstring
Filtrar por direção da chamada. Opções:
inbound, outboundstring
Filtrar chamadas a partir da data (YYYY-MM-DD)
string
Filtrar chamadas até a data (YYYY-MM-DD)
string
Pesquisar em números de telefone ou SID da chamada
integer
Número de itens por página (padrão: 20, máximo: 100)
integer
Número da página (padrão: 1)
Exemplos de Requisição
# Requisição 1: Obter todas as chamadas de um agente
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/calls" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todas as chamadas de um agente
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/calls', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Requisição 2: Filtrar por chamadas completadas
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/calls?status=completed&direction=outbound&per_page=50" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 2: Filtrar por chamadas completadas
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/calls?status=completed&direction=outbound&per_page=50', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Requisição 3: Filtrar por período específico
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/calls?date_from=2024-01-01&date_to=2024-01-31" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 3: Filtrar por período específico
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/calls?date_from=2024-01-01&date_to=2024-01-31', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
Resposta
Resposta de Sucesso (200 OK)
{
"success": true,
"data": [
{
"id": "uuid",
"sid": "call_sid_123",
"to": "+5511987654321",
"to_formatted": "(123) 456-7890",
"from": "+0987654321",
"from_formatted": "(098) 765-4321",
"is_testing": false,
"direction": "outbound",
"status": "completed",
"duration": 120,
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "uuid-2",
"sid": "call_sid_456",
"to": "+5511976543210",
"to_formatted": "(987) 654-3210",
"from": "+5511987654321",
"from_formatted": "(123) 456-7890",
"is_testing": true,
"direction": "inbound",
"status": "answered",
"duration": 85,
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 3,
"per_page": 20,
"total": 50,
"from": 1,
"to": 20
}
}
Campos da Resposta
boolean
obrigatório
Indica se a operação foi bem-sucedida.
array
obrigatório
Array de objetos de chamada.
Mostrar Objeto de Chamada
Mostrar Objeto de Chamada
string
obrigatório
Identificador único da chamada.
string
obrigatório
SID da chamada do provedor de telefonia.
string
obrigatório
Número de telefone de destino em formato E.164.
string
obrigatório
Número de telefone de destino formatado para exibição.
string
obrigatório
Número de telefone de origem em formato E.164.
string
obrigatório
Número de telefone de origem formatado para exibição.
boolean
obrigatório
Se a chamada é uma chamada de teste.
string
obrigatório
Direção da chamada. Opções:
inbound, outbound.string
obrigatório
Status atual da chamada. Opções:
initiated, ringing, answered, completed, failed, busy, no-answer.integer
Duração da chamada em segundos (quando aplicável).
string
obrigatório
Timestamp ISO 8601 quando a chamada foi criada.
string
obrigatório
Timestamp ISO 8601 quando a chamada foi atualizada pela última vez.
object
obrigatório
Metadados de paginação.
Mostrar Objeto de Paginação
Mostrar Objeto de Paginação
Respostas de erro
404 Não Encontrado
{
"success": false,
"message": "Agent not found"
}
422 Erro de Validação
{
"success": false,
"message": "The given data was invalid.",
"errors": {
"status": [
"The selected status is invalid."
],
"direction": [
"The selected direction is invalid."
],
"date_from": [
"The date from field must be a valid date."
],
"date_to": [
"The date to field must be a valid date."
]
}
}
401 Não Autorizado
{
"success": false,
"message": "Unauthorized"
}
500 Erro do Servidor
{
"success": false,
"message": "Internal server error."
}
Códigos de erro
| Código | Descrição | Status HTTP |
|---|---|---|
AGENT_NOT_FOUND | Agente especificado não existe | 404 |
VALIDATION_ERROR | Validação dos parâmetros de consulta falhou | 422 |
INVALID_TOKEN | Token de autenticação inválido ou ausente | 401 |
SERVER_ERROR | Erro interno do servidor ocorreu | 500 |
Notas Importantes
Filtros específicos do agente. Este endpoint filtra automaticamente as chamadas pelo agente especificado.
Suporte à paginação. Use parâmetros
page e per_page para navegar pelos resultados.Filtros de data. Use
date_from e date_to para filtrar chamadas por período específico.Análise de desempenho. Use este endpoint para analisar o desempenho de agentes específicos.
Melhores Práticas
- Use paginação - Sempre use paginação para grandes conjuntos de dados
- Filtre por período - Use filtros de data para analisar chamadas em períodos específicos
- Monitore status - Filtre por status para acompanhar o progresso das chamadas
- Analise desempenho - Use este endpoint para avaliar o desempenho de agentes específicos
- Identifique testes - Use
is_testingpara separar chamadas de teste das de produção
Resultado da conversa. Passe
include=insight para receber analysis_status, human_detected, call_result, collected_data e campaign_id em cada chamada. Sem ele, a resposta não muda.Endpoints relacionados
- Listar Chamadas:
GET /api/v1/calls - Obter Agente:
GET /api/v1/agents/{agent_id} - Fazer Chamada:
POST /api/v1/calls - Listar Agentes:
GET /api/v1/agents - Obter resultado da chamada:
GET /api/v1/calls/{call_id}/insight
Esta página foi útil?