Despachar um job agora
Disca o job agora, sem esperar o horário agendado — e gasta uma tentativa. A Idempotency-Key é obrigatória: uma retentativa depois de um timeout devolve o primeiro despacho em vez de discar de novo. outcome diz o que aconteceu: dispatched (a ligação saiu, e está em call_id), deferred (nada foi discado: a campanha está fora da janela, ou o cliente está bloqueado e a ligação sai quando o bloqueio cair) ou failed (o serviço de voz recusou ou falhou; detail diz qual, e o status do job diz se ele volta para a fila). A linha do agente ocupada responde 409 e deixa o job como estava — também quando outra ligação a toma no meio do despacho —, e um job que não está agendado nem falho também. O agente do job que não pode discar (desligado, fora do estado que executa, mal configurado ou removido) responde a recusa (409 ou 422) sem gastar o job: ele continua como estava e sai depois de o agente ser corrigido.
Autorização
bearer calls:executeCredencial 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:execute
Parâmetros de caminho
Id do job
Parâmetros de cabeçalho
Chave de 1 a 255 caracteres ASCII visíveis, estável por intenção do usuário: a mesma chave numa retentativa devolve a primeira resposta em vez de repetir o efeito.
Corpo da resposta
application/json
application/json
curl -X POST "https://example.com/call-jobs/string/dispatches" \ -H "Idempotency-Key: b3f0c1e2-4a5b-4c6d-8e9f-0a1b2c3d4e5f"{ "call_id": "0d0a16ab-a508-4d58-bf24-5dc3cb248f3e", "detail": "string", "job": { "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" }, "outcome": "dispatched"}