Listar a fila de discagem
Lista os jobs de discagem do alcance do chamador, do mais próximo de discar para o mais antigo. Um job é uma ligação futura: depois de discado ele continua aqui, e a ligação que ele produziu aparece em /calls. A trava do agente não vem embutida — ela é lida em /agents/{agent_id}/call-lock.
Autorização
bearer calls: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: calls:read
Parâmetros de consulta
Estreita para um cliente (dentro do alcance).
int64Só os jobs deste agente de voz.
uuidO estado do job na fila.
Valor em
- "scheduled"
- "dispatching"
- "dispatched"
- "answered"
- "rejected"
- "failed"
- "completed"
- "cancelled"
De onde o job veio: manual ou campaign.
Valor em
- "manual"
- "campaign"
Só os jobs desta campanha.
uuidCursor 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/call-jobs"{ "data": [ { "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "agent_task": "string", "answered_at": "string", "attempts": 0, "call_id": "0d0a16ab-a508-4d58-bf24-5dc3cb248f3e", "completed_at": "string", "contact_name": "string", "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407", "created_at": "string", "custom_fields": null, "destination_number": "string", "dispatched_at": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "last_error": "string", "max_attempts": 0, "metadata": null, "scheduled_at": "string", "status": "scheduled", "tenant_id": 0, "timezone": "string", "updated_at": "string" } ], "page": { "has_more": true, "next_cursor": "string" }}