curl -X POST "https://app.talkover.ai/api/v1/campaigns/campaign-uuid/clear" \
-H "Authorization: Bearer talq_your_environment_token_here" \
-H "Content-Type: application/json" \
-d '{
"delete_calls": true,
"delete_statuses": ["pending", "queued", "processing", "awaiting_report", "completed", "failed", "canceled", "paused", "terminated"]
}'
{
"success": true,
"data": {
"files_cleared": 1,
"files_failed": 0,
"completed_calls": 15204,
"terminated_calls": 3138,
"leftover_calls_deleted": 0,
"sftp_export_queued": false
},
"message": "Campaign cleared. 1 files cleared, 15204 completed, 3138 terminated."
}
Chamadas e Campanhas
Limpar campanha
Encerra todas as listas de contatos da campanha sem apagar a campanha
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
clear
curl -X POST "https://app.talkover.ai/api/v1/campaigns/campaign-uuid/clear" \
-H "Authorization: Bearer talq_your_environment_token_here" \
-H "Content-Type: application/json" \
-d '{
"delete_calls": true,
"delete_statuses": ["pending", "queued", "processing", "awaiting_report", "completed", "failed", "canceled", "paused", "terminated"]
}'
{
"success": true,
"data": {
"files_cleared": 1,
"files_failed": 0,
"completed_calls": 15204,
"terminated_calls": 3138,
"leftover_calls_deleted": 0,
"sftp_export_queued": false
},
"message": "Campaign cleared. 1 files cleared, 15204 completed, 3138 terminated."
}
Limpar campanha
Encerra todas as listas de contatos ativas da campanha e, se você pedir, remove as chamadas — o mesmo que Limpar campanha no painel. A campanha, as configurações e o histórico de chamadas continuam.Endpoint
POST /api/v1/campaigns/{campaign_id}/clear
Parâmetros de caminho
string
obrigatório
UUID da campanha.
Cabeçalhos da requisição
string
obrigatório
Token Bearer. Formato:
Bearer talq_your_environment_token_hereCorpo da requisição
boolean
padrão:"true"
Quando a campanha tem exportação SFTP configurada, exporta os resultados antes de remover as chamadas.
boolean
padrão:"false"
Remove as chamadas cujo status está em
delete_statuses. Sem isso, as chamadas não concluídas só são paradas.string[]
padrão:"[]"
Status a remover quando
delete_calls é true: pending, queued, processing, awaiting_report, completed, failed, canceled, paused, terminated.delete_statuses vazio não remove nada. Para remover as chamadas de todos os status, envie todos os status na lista.O que limpar faz
- Toda chamada não concluída (pendente, pausada, em processamento) é parada, então nada das listas antigas volta a ser discado. Chamadas concluídas são mantidas.
- Com
delete_calls, as chamadas nos status escolhidos saem da campanha. Elas ficam ocultas, não destruídas: gravação, transcrição e cobrança continuam. - Números removidos podem ser importados de novo na hora. Isso também zera o período de espera deles: um número que já concluiu uma chamada pode ser ligado de novo pela próxima lista.
- A resposta volta quando as listas estão encerradas. Só a exportação SFTP, quando configurada, roda depois.
Exemplos
curl -X POST "https://app.talkover.ai/api/v1/campaigns/campaign-uuid/clear" \
-H "Authorization: Bearer talq_your_environment_token_here" \
-H "Content-Type: application/json" \
-d '{
"delete_calls": true,
"delete_statuses": ["pending", "queued", "processing", "awaiting_report", "completed", "failed", "canceled", "paused", "terminated"]
}'
Resposta
{
"success": true,
"data": {
"files_cleared": 1,
"files_failed": 0,
"completed_calls": 15204,
"terminated_calls": 3138,
"leftover_calls_deleted": 0,
"sftp_export_queued": false
},
"message": "Campaign cleared. 1 files cleared, 15204 completed, 3138 terminated."
}
Respostas de erro
500 — Limpeza parcial
Pelo menos uma lista não pôde ser encerrada (files_failed > 0) e continua ativa. Não suba a próxima lista ainda: envie a limpeza de novo — ela só mexe nas listas que continuam ativas.
{
"success": false,
"data": { "files_cleared": 2, "files_failed": 1, "completed_calls": 9120, "terminated_calls": 410, "leftover_calls_deleted": 0, "sftp_export_queued": false },
"message": "Campaign partially cleared: 1 list(s) failed. Retry the clear before uploading."
}
404 — Campanha não encontrada
A campanha não existe ou pertence a outro ambiente.Ciclo diário
Para trocar o mailing de uma campanha todo dia por script:- Limpar:
POST /campaigns/{campaign_id}/clear. Em500, repita até voltar200. - Subir:
POST /campaigns/{campaign_id}/filescom o CSV novo. Em422, corrija o arquivo — nada foi importado. - Acompanhar:
GET /campaigns/{campaign_id}/files/{file_data_id}/progressa cada poucos segundos atécompletedoufailed.
Esta página foi útil?