# 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"

{
  "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"
  }
}

GET

api

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"

{
  "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

campaign

string

obrigatório

O identificador único da campanha. Você pode encontrá-lo na lista de campanhas.

Cabeçalhos da requisição

Authorization

string

obrigatório

Token Bearer para autenticação. Formato: Bearer talq_your_environment_token_here

Exemplos 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 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"

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

success

boolean

obrigatório

Indica se a operação foi bem-sucedida.

data

object

obrigatório

Dados completos da campanha.

Mostrar Objeto de Campanha

string

obrigatório

Identificador único da campanha.

name

string

obrigatório

Nome da campanha.

description

string

Descrição da campanha.

status

string

obrigatório

Status da campanha. Opções: draft, active, paused, completed, cancelled.

campaign_type

string

obrigatório

Tipo da campanha. Opções: sales, follow_up, reminder, custom.

start_date

string

obrigatório

Data de início da campanha (formato: YYYY-MM-DD).

days_of_week

array

obrigatório

Array de dias da semana (1=Segunda, 7=Domingo).

earliest_call_time

string

obrigatório

Horário mais cedo para fazer chamadas (formato: HH:MM:SS).

latest_call_time

string

obrigatório

Horário mais tarde para fazer chamadas (formato: HH:MM:SS).

timezone

string

obrigatório

Fuso horário para agendamento de chamadas.

agent_id

string

obrigatório

ID do agente atribuído à campanha.

initial_call_delay

integer

obrigatório

Atraso inicial da chamada em segundos.

max_retries

integer

obrigatório

Número máximo de tentativas.

retry_cooldown_hours

integer

obrigatório

Tempo de espera entre tentativas em horas.

enable_post_completion_cooldown

boolean

obrigatório

Se o cooldown pós-conclusão está habilitado.

post_completion_cooldown_hours

integer

obrigatório

Tempo de cooldown pós-conclusão em horas.

success_cooldown_hours

integer

obrigatório

Tempo de cooldown após sucesso em horas.

voicemail_cooldown_hours

integer

obrigatório

Tempo de cooldown após caixa postal em horas.

no_answer_cooldown_hours

integer

obrigatório

Tempo de cooldown após sem resposta em horas.

busy_cooldown_hours

integer

obrigatório

Tempo de cooldown após ocupado em horas.

failed_cooldown_hours

integer

obrigatório

Tempo de cooldown após falha em horas.

do_not_call_enabled

boolean

obrigatório

Se a lista de não chamar está habilitada.

do_not_call_list_source

string

obrigatório

Fonte da lista de não chamar.

auto_add_to_dnc_enabled

boolean

obrigatório

Se a adição automática à DNC está habilitada.

auto_dnc_trigger_statuses

array

obrigatório

Status que disparam adição automática à DNC.

auto_dnc_trigger_errors

array

obrigatório

Erros que disparam adição automática à DNC.

agent

object

obrigatório

Informações do agente.

Mostrar Objeto do Agente

string

obrigatório

ID do agente.

name

string

obrigatório

Nome do agente.

label

string

obrigatório

Label do agente.

calls

array

obrigatório

Lista de chamadas associadas à campanha.

Mostrar Objeto de Chamada

string

obrigatório

ID da chamada.

string

obrigatório

Número de telefone de destino.

status

string

obrigatório

Status da chamada.

retries

integer

obrigatório

Número de tentativas.

created_at

string

obrigatório

Timestamp de criação da chamada.

files

array

obrigatório

Lista de arquivos associados à campanha.

Mostrar Objeto de Arquivo

string

obrigatório

ID do arquivo.

original_filename

string

obrigatório

Nome original do arquivo.

processed_filename

string

obrigatório

Nome do arquivo processado.

status

string

obrigatório

Status do processamento.

total_records

integer

obrigatório

Número total de registros.

processed_records

integer

obrigatório

Número de registros processados.

stats

object

obrigatório

Estatísticas da campanha.

Mostrar Objeto de Estatísticas

total_calls

integer

obrigatório

Número total de chamadas.

completed_calls

integer

obrigatório

Número de chamadas completadas.

failed_calls

integer

obrigatório

Número de chamadas falhadas.

success_rate

number

obrigatório

Taxa de sucesso em porcentagem.

average_duration

integer

obrigatório

Duração média das chamadas em segundos.

created_at

string

obrigatório

Timestamp ISO 8601 quando a campanha foi criada.

updated_at

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

Criar Campanha Atualizar Campanha

​Obter Campanha

​Endpoint

​Parâmetros de caminho

​Cabeçalhos da requisição

​Exemplos de Requisição

​Resposta

​Resposta de Sucesso (200 OK)

​Campos da Resposta

​Respostas de erro

​404 Não Encontrado

​401 Não Autorizado

​500 Erro do Servidor

​Códigos de erro

​Notas Importantes

​Melhores Práticas

​Endpoints relacionados

Obter Campanha

Endpoint

Parâmetros de caminho

Cabeçalhos da requisição

Exemplos de Requisição

Resposta

Resposta de Sucesso (200 OK)

Campos da Resposta

Respostas de erro

404 Não Encontrado

401 Não Autorizado

500 Erro do Servidor

Códigos de erro

Notas Importantes

Melhores Práticas

Endpoints relacionados