# Requisição 1: Obter todas as campanhas
curl -X GET "https://app.talkover.ai/api/v1/campaigns" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todas as campanhas
const response = await fetch('https://app.talkover.ai/api/v1/campaigns', {
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,
"agent": {
"id": "agent-uuid-1",
"name": "Agente de Vendas",
"label": "Agente de Vendas Label"
},
"stats": {
"total_calls": 100,
"completed_calls": 80,
"failed_calls": 20,
"success_rate": 80.0
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 5,
"per_page": 20,
"total": 100,
"from": 1,
"to": 20
}
}
Chamadas e Campanhas
Listar Campanhas
Recuperar uma lista de campanhas para o ambiente autenticado
GET
/
api
/
v1
/
campaigns
# Requisição 1: Obter todas as campanhas
curl -X GET "https://app.talkover.ai/api/v1/campaigns" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todas as campanhas
const response = await fetch('https://app.talkover.ai/api/v1/campaigns', {
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,
"agent": {
"id": "agent-uuid-1",
"name": "Agente de Vendas",
"label": "Agente de Vendas Label"
},
"stats": {
"total_calls": 100,
"completed_calls": 80,
"failed_calls": 20,
"success_rate": 80.0
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 5,
"per_page": 20,
"total": 100,
"from": 1,
"to": 20
}
}
Listar Campanhas
Recuperar uma lista de campanhas para o ambiente autenticado com opções de filtragem por status, tipo de campanha, agente e datas.Endpoint
GET /api/v1/campaigns
Cabeçalhos da requisição
string
obrigatório
Token Bearer para autenticação. Formato:
Bearer talq_your_environment_token_hereParâmetros de consulta
string
Filtrar por status da campanha. Opções:
draft, active, paused, completed, cancelledstring
Filtrar por tipo de campanha. Opções:
sales, follow_up, reminder, customstring
Filtrar por ID do agente.
string
Filtrar campanhas a partir da data (formato: YYYY-MM-DD).
string
Filtrar campanhas até a data (formato: YYYY-MM-DD).
string
Pesquisar no nome ou descrição da campanha.
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 campanhas
curl -X GET "https://app.talkover.ai/api/v1/campaigns" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todas as campanhas
const response = await fetch('https://app.talkover.ai/api/v1/campaigns', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Requisição 2: Filtrar campanhas ativas de vendas
curl -X GET "https://app.talkover.ai/api/v1/campaigns?status=active&campaign_type=sales&per_page=50" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 2: Filtrar campanhas ativas de vendas
const response = await fetch('https://app.talkover.ai/api/v1/campaigns?status=active&campaign_type=sales&per_page=50', {
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,
"agent": {
"id": "agent-uuid-1",
"name": "Agente de Vendas",
"label": "Agente de Vendas Label"
},
"stats": {
"total_calls": 100,
"completed_calls": 80,
"failed_calls": 20,
"success_rate": 80.0
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 5,
"per_page": 20,
"total": 100,
"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 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.
object
obrigatório
object
obrigatório
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.
object
obrigatório
Metadados de paginação.
Mostrar Objeto de Paginação
Mostrar Objeto de Paginação
Respostas de erro
422 Erro de Validação
{
"success": false,
"message": "The given data was invalid.",
"errors": {
"status": [
"The selected status is invalid."
],
"campaign_type": [
"The selected campaign type is invalid."
]
}
}
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 |
|---|---|---|
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 disponíveis. Use filtros para encontrar campanhas específicas por status, tipo ou agente.
Estatísticas incluídas. Cada campanha inclui estatísticas de desempenho.
Suporte à paginação. Use parâmetros
page e per_page para navegar pelos resultados.Pesquisa de texto. Use o parâmetro
search para pesquisar no nome ou descrição.Melhores Práticas
- Use filtros - Aproveite os filtros para encontrar campanhas específicas
- Monitore estatísticas - Acompanhe as estatísticas de desempenho das campanhas
- Use paginação - Sempre use paginação para grandes conjuntos de dados
- Pesquise eficientemente - Use pesquisa de texto para encontrar campanhas rapidamente
- Verifique status - Monitore o status das campanhas regularmente
Endpoints relacionados
- Criar Campanha:
POST /api/v1/campaigns - Obter Campanha:
GET /api/v1/campaigns/{campaign_id} - 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?