Skip to main content
GET

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

Cabeçalhos da requisição

string
obrigatório
Token Bearer para autenticação. Formato: Bearer talq_your_environment_token_here

Parâmetros de consulta

string
Filtrar por status da campanha. Opções: draft, active, paused, completed, cancelled
string
Filtrar por tipo de campanha. Opções: sales, follow_up, reminder, custom
string
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).
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

Resposta

Resposta de Sucesso (200 OK)

Campos da Resposta

boolean
obrigatório
Indica se a operação foi bem-sucedida.
array
obrigatório
Array de objetos de campanha.
object
obrigatório
Metadados de paginação.

Respostas de erro

422 Erro de Validação

401 Não Autorizado

500 Erro do Servidor

Códigos de erro

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

  1. Use filtros - Aproveite os filtros para encontrar campanhas específicas
  2. Monitore estatísticas - Acompanhe as estatísticas de desempenho das campanhas
  3. Use paginação - Sempre use paginação para grandes conjuntos de dados
  4. Pesquise eficientemente - Use pesquisa de texto para encontrar campanhas rapidamente
  5. 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