Listar campanhas
Lista as campanhas de voz e de texto do alcance do chamador, da mais nova para a mais antiga, com a cadência e os contadores de cada uma. Os contatos e as tentativas não vêm embutidos: estão em /campaigns/{campaign_id}/contacts e /attempts. agent_id casa com o agente de voz da campanha ou com o agente de texto que atende o canal dela.
Autorização
bearer campaigns:readCredencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: campaigns:read
Parâmetros de consulta
Estreita a um cliente do alcance.
int64voice ou text.
Valor em
- "voice"
- "text"
O agente de voz da campanha, ou o agente de texto que atende o canal dela.
uuidO estado de uma campanha. scheduled e active são tratados igual pelo
motor — os dois reivindicam contatos devidos, e a janela é quem segura —:
scheduled diz "começa quando a janela abrir", active diz "em curso".
completed é escrito pela plataforma quando todo contato terminou.
Valor em
- "draft"
- "scheduled"
- "active"
- "paused"
- "completed"
- "cancelled"
Cursor opaco devolvido em page.next_cursor da página anterior. Omita para começar do início.
Tamanho da página. Padrão 50; o máximo é o da coleção: 200, ou até 500 nas coleções de itens pequenos.
int320 <= valueCorpo da resposta
application/json
application/json
curl -X GET "https://example.com/campaigns"{ "data": [ { "cadence": { "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "call_spacing_seconds": 0, "created_at": "2019-08-24T14:15:22Z", "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "max_attempts": 0, "name": "string", "retry_interval_seconds": 0, "tenant_id": 0, "updated_at": "2019-08-24T14:15:22Z" }, "counters": { "active": 0, "answered": 0, "completed": 0, "failed": 0, "pending": 0, "total": 0 }, "created_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "next_attempt_at": "2019-08-24T14:15:22Z", "progress": 0, "status": "draft", "tenant_id": 0, "updated_at": "2019-08-24T14:15:22Z", "window": { "allowed_weekdays": [ 0 ], "daily_end_time": "string", "daily_start_time": "string", "end_at": "2019-08-24T14:15:22Z", "start_at": "2019-08-24T14:15:22Z", "timezone": "string" }, "type": "voice", "voice": { "agent_context_columns": [ "string" ], "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "agent_task": "string", "source_file_name": "string" } } ], "page": { "has_more": true, "next_cursor": "string" }}