# Requisição 1: Obter detalhes de uma campanha específica
curl -X GET "https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter detalhes de uma campanha específica
const response = await fetch('https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": {
"id": "campaign-uuid-1",
"name": "Campanha de Vendas Q1",
"description": "Campanha de vendas outbound para Q1",
"status": "active",
"campaign_type": "sales",
"start_date": "2024-01-01",
"days_of_week": [1, 2, 3, 4, 5],
"earliest_call_time": "09:00:00",
"latest_call_time": "17:00:00",
"timezone": "America/Sao_Paulo",
"agent_id": "agent-uuid-1",
"initial_call_delay": 0,
"max_retries": 3,
"retry_cooldown_hours": 24,
"enable_post_completion_cooldown": true,
"post_completion_cooldown_hours": 168,
"success_cooldown_hours": 168,
"voicemail_cooldown_hours": 24,
"no_answer_cooldown_hours": 24,
"busy_cooldown_hours": 24,
"failed_cooldown_hours": 24,
"do_not_call_enabled": true,
"do_not_call_list_source": "environment",
"auto_add_to_dnc_enabled": true,
"auto_dnc_trigger_statuses": ["completed", "voicemail"],
"auto_dnc_trigger_errors": ["invalid_number", "disconnected"],
"agent": {
"id": "agent-uuid-1",
"name": "Agente de Vendas",
"label": "Agente de Vendas Label"
},
"calls": [
{
"id": "call-uuid-1",
"to": "+5511987654321",
"status": "completed",
"retries": 0,
"created_at": "2024-01-01T00:00:00Z"
}
],
"files": [
{
"id": "file-uuid-1",
"original_filename": "contacts.csv",
"processed_filename": "processed_contacts.csv",
"status": "processed",
"total_records": 1000,
"processed_records": 950
}
],
"stats": {
"total_calls": 100,
"completed_calls": 80,
"failed_calls": 20,
"success_rate": 80.0,
"average_duration": 120
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
}
Chamadas e Campanhas
Obter Campanha
Recuperar detalhes de uma campanha específica
GET
/
api
/
v1
/
campaigns
/
{campaign_id}
# Requisição 1: Obter detalhes de uma campanha específica
curl -X GET "https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter detalhes de uma campanha específica
const response = await fetch('https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": {
"id": "campaign-uuid-1",
"name": "Campanha de Vendas Q1",
"description": "Campanha de vendas outbound para Q1",
"status": "active",
"campaign_type": "sales",
"start_date": "2024-01-01",
"days_of_week": [1, 2, 3, 4, 5],
"earliest_call_time": "09:00:00",
"latest_call_time": "17:00:00",
"timezone": "America/Sao_Paulo",
"agent_id": "agent-uuid-1",
"initial_call_delay": 0,
"max_retries": 3,
"retry_cooldown_hours": 24,
"enable_post_completion_cooldown": true,
"post_completion_cooldown_hours": 168,
"success_cooldown_hours": 168,
"voicemail_cooldown_hours": 24,
"no_answer_cooldown_hours": 24,
"busy_cooldown_hours": 24,
"failed_cooldown_hours": 24,
"do_not_call_enabled": true,
"do_not_call_list_source": "environment",
"auto_add_to_dnc_enabled": true,
"auto_dnc_trigger_statuses": ["completed", "voicemail"],
"auto_dnc_trigger_errors": ["invalid_number", "disconnected"],
"agent": {
"id": "agent-uuid-1",
"name": "Agente de Vendas",
"label": "Agente de Vendas Label"
},
"calls": [
{
"id": "call-uuid-1",
"to": "+5511987654321",
"status": "completed",
"retries": 0,
"created_at": "2024-01-01T00:00:00Z"
}
],
"files": [
{
"id": "file-uuid-1",
"original_filename": "contacts.csv",
"processed_filename": "processed_contacts.csv",
"status": "processed",
"total_records": 1000,
"processed_records": 950
}
],
"stats": {
"total_calls": 100,
"completed_calls": 80,
"failed_calls": 20,
"success_rate": 80.0,
"average_duration": 120
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
}
Obter Campanha
Recuperar detalhes completos de uma campanha específica, incluindo configurações, estatísticas, chamadas associadas e arquivos.Endpoint
GET /api/v1/campaigns/{campaign_id}
Parâmetros de caminho
string
obrigatório
O identificador único da campanha. Você pode encontrá-lo na lista de campanhas.
Cabeçalhos da requisição
string
obrigatório
Token Bearer para autenticação. Formato:
Bearer talq_your_environment_token_hereExemplos de Requisição
# Requisição 1: Obter detalhes de uma campanha específica
curl -X GET "https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter detalhes de uma campanha específica
const response = await fetch('https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Requisição 2: Obter campanha com ID específico
curl -X GET "https://app.talkover.ai/api/v1/campaigns/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 2: Obter campanha com ID específico
const campaign_id = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(`https://app.talkover.ai/api/v1/campaigns/${campaign_id}`, {
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": "campaign-uuid-1",
"name": "Campanha de Vendas Q1",
"description": "Campanha de vendas outbound para Q1",
"status": "active",
"campaign_type": "sales",
"start_date": "2024-01-01",
"days_of_week": [1, 2, 3, 4, 5],
"earliest_call_time": "09:00:00",
"latest_call_time": "17:00:00",
"timezone": "America/Sao_Paulo",
"agent_id": "agent-uuid-1",
"initial_call_delay": 0,
"max_retries": 3,
"retry_cooldown_hours": 24,
"enable_post_completion_cooldown": true,
"post_completion_cooldown_hours": 168,
"success_cooldown_hours": 168,
"voicemail_cooldown_hours": 24,
"no_answer_cooldown_hours": 24,
"busy_cooldown_hours": 24,
"failed_cooldown_hours": 24,
"do_not_call_enabled": true,
"do_not_call_list_source": "environment",
"auto_add_to_dnc_enabled": true,
"auto_dnc_trigger_statuses": ["completed", "voicemail"],
"auto_dnc_trigger_errors": ["invalid_number", "disconnected"],
"agent": {
"id": "agent-uuid-1",
"name": "Agente de Vendas",
"label": "Agente de Vendas Label"
},
"calls": [
{
"id": "call-uuid-1",
"to": "+5511987654321",
"status": "completed",
"retries": 0,
"created_at": "2024-01-01T00:00:00Z"
}
],
"files": [
{
"id": "file-uuid-1",
"original_filename": "contacts.csv",
"processed_filename": "processed_contacts.csv",
"status": "processed",
"total_records": 1000,
"processed_records": 950
}
],
"stats": {
"total_calls": 100,
"completed_calls": 80,
"failed_calls": 20,
"success_rate": 80.0,
"average_duration": 120
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
}
Campos da Resposta
boolean
obrigatório
Indica se a operação foi bem-sucedida.
object
obrigatório
Dados completos da campanha.
Mostrar Objeto de Campanha
Mostrar Objeto de Campanha
string
obrigatório
Identificador único da campanha.
string
obrigatório
Nome da campanha.
string
Descrição da campanha.
string
obrigatório
Status da campanha. Opções:
draft, active, paused, completed, cancelled.string
obrigatório
Tipo da campanha. Opções:
sales, follow_up, reminder, custom.string
obrigatório
Data de início da campanha (formato: YYYY-MM-DD).
array
obrigatório
Array de dias da semana (1=Segunda, 7=Domingo).
string
obrigatório
Horário mais cedo para fazer chamadas (formato: HH:MM:SS).
string
obrigatório
Horário mais tarde para fazer chamadas (formato: HH:MM:SS).
string
obrigatório
Fuso horário para agendamento de chamadas.
string
obrigatório
ID do agente atribuído à campanha.
integer
obrigatório
Atraso inicial da chamada em segundos.
integer
obrigatório
Número máximo de tentativas.
integer
obrigatório
Tempo de espera entre tentativas em horas.
boolean
obrigatório
Se o cooldown pós-conclusão está habilitado.
integer
obrigatório
Tempo de cooldown pós-conclusão em horas.
integer
obrigatório
Tempo de cooldown após sucesso em horas.
integer
obrigatório
Tempo de cooldown após caixa postal em horas.
integer
obrigatório
Tempo de cooldown após sem resposta em horas.
integer
obrigatório
Tempo de cooldown após ocupado em horas.
integer
obrigatório
Tempo de cooldown após falha em horas.
boolean
obrigatório
Se a lista de não chamar está habilitada.
string
obrigatório
Fonte da lista de não chamar.
boolean
obrigatório
Se a adição automática à DNC está habilitada.
array
obrigatório
Status que disparam adição automática à DNC.
array
obrigatório
Erros que disparam adição automática à DNC.
object
obrigatório
array
obrigatório
array
obrigatório
Lista de arquivos associados à campanha.
object
obrigatório
Estatísticas da campanha.
string
obrigatório
Timestamp ISO 8601 quando a campanha foi criada.
string
obrigatório
Timestamp ISO 8601 quando a campanha foi atualizada pela última vez.
Respostas de erro
404 Não Encontrado
{
"success": false,
"message": "Campaign not found"
}
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 |
|---|---|---|
CAMPAIGN_NOT_FOUND | Campanha especificada não existe | 404 |
INVALID_TOKEN | Token de autenticação inválido ou ausente | 401 |
SERVER_ERROR | Erro interno do servidor ocorreu | 500 |
Notas Importantes
Dados completos. Este endpoint retorna todos os detalhes da campanha incluindo configurações, estatísticas e relacionamentos.
Chamadas incluídas. A resposta inclui uma lista das chamadas associadas à campanha.
Arquivos incluídos. A resposta inclui uma lista dos arquivos associados à campanha.
Estatísticas em tempo real. As estatísticas são calculadas em tempo real com base nas chamadas atuais.
Melhores Práticas
- Monitore estatísticas - Use as estatísticas para acompanhar o desempenho da campanha
- Verifique chamadas - Analise as chamadas para entender o comportamento da campanha
- Acompanhe arquivos - Monitore o processamento de arquivos para garantir que todos os registros sejam processados
- Use dados para otimização - Use os dados retornados para otimizar configurações da campanha
- Verifique configurações - Confirme se todas as configurações estão corretas
Endpoints relacionados
- Listar Campanhas:
GET /api/v1/campaigns - Criar Campanha:
POST /api/v1/campaigns - Atualizar Campanha:
PUT /api/v1/campaigns/{campaign_id} - Atualizar Status da Campanha:
PATCH /api/v1/campaigns/{campaign_id}/status - Excluir Campanha:
DELETE /api/v1/campaigns/{campaign_id} - Fazer Chamada de Campanha:
POST /api/v1/campaigns/{campaign_id}/call
Esta página foi útil?