Editar ou cancelar um job da fila
Altera os campos enviados e deixa os outros como estão; null limpa o nome do contato e a tarefa do agente. Para cancelar, envie só {"status": "cancelled"} — cancelar e editar no mesmo pedido é recusado. Um job que já está sendo discado, foi discado ou terminou não se edita, e só um job agendado ou que falhou se cancela: os dois respondem 409. Um horário no passado, ou já ocupado por outro job do mesmo agente, é recusado.
Autorização
bearer calls:writeCredencial 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:write
Parâmetros de caminho
Id do job
Corpo da requisição
application/json
Definições TypeScript
Use o tipo request body no TypeScript.
Alteração parcial de um job da fila. Campo ausente fica como está; null
limpa (só em contact_name e agent_task).
Para cancelar, envie só {"status": "cancelled"}: cancelar e editar no
mesmo pedido é recusado, porque um dos dois teria de ser ignorado.
Corpo da resposta
application/json
application/json
curl -X PATCH "https://example.com/call-jobs/string" \ -H "Content-Type: application/json" \ -d '{}'{ "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"}