Skip to main content
Retrieves the live, individual status of every call within a batch from the memory cache (Redis). This is the primary endpoint for monitoring a campaign in real-time within 30 days of its creation.
  • Endpoint: GET /api/v1/status/batch
  • Method: GET
  • Query Parameters:
    • batchId (string, required): The ID returned from POST /api/v1/batch.
  • Retention: Data is available for 30 days. After 30 days, please use the Batch Statistics endpoint for persistent records.
  • Success Response (200 OK): Returns a calls array containing the status object for every call in the batch. 
    {
  "batchId": "batch_1678886400_agent_clx123...",
  "calls": [
    {
      "callId": "call_clxabc123...",
      "status": "COMPLETED",
      "startTime": "2025-11-15T14:31:02.456Z",
      "phoneNumber": "+15551234567",
      "error": null,
      "duration": 62,
      "recordingUrl": "https://s3..."
    },
    {
      "callId": "call_clxdef456...",
      "status": "ONGOING",
      "startTime": "2025-11-15T14:32:15.789Z",
      "phoneNumber": "+15557654321",
      "error": null,
      "duration": null,
      "recordingUrl": null
    },
    {
      "callId": "call_clxghi789...",
      "status": "MISSED",
      "startTime": "2025-11-15T14:31:05.123Z",
      "phoneNumber": "+15559876543",
      "error": "Call was not answered",
      "duration": 22,
      "recordingUrl": null
    }
  ]
}