Agendar uma ligação
Põe um job na fila do agente: ele liga para o contato no horário dado, e tenta de novo se a discagem falhar por algo passageiro (até max_attempts, padrão 3). Um job por pedido. A Idempotency-Key é obrigatória: uma retentativa depois de um timeout devolve o mesmo job em vez de agendar a ligação duas vezes. Um horário no passado é recusado; um horário já ocupado por outro job do mesmo agente responde 409; cliente bloqueado responde 402 e nada é agendado — a ligação não sairia até o pagamento.
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 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 requisição
application/json
Definições TypeScript
Use o tipo request body no TypeScript.
Pedido de um job na fila: uma ligação agendada para um contato.
Corpo da resposta
application/json
application/json
curl -X POST "https://example.com/call-jobs" \ -H "Idempotency-Key: b3f0c1e2-4a5b-4c6d-8e9f-0a1b2c3d4e5f" \ -H "Content-Type: application/json" \ -d '{ "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "destination_number": "string", "scheduled_at": "string" }'{ "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"}