Get Batch Status

GEThttps://api.trillet.ai/v1/api/batch-calls/{batchId}

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Path Parameters

batchIdstringrequired

The unique identifier of the batch call operation

Response

idstring

The batch ID

statusstring

Current status of the batch operation

queued - Batch is waiting to be processed
processing - Calls are currently being made
completed - All calls have been completed
cancelled - Batch was cancelled
failed - Batch failed due to an error

isCompleteboolean

Whether the batch operation has finished

totalCallsnumber

Total number of calls in the batch

progressobject

Detailed progress information

timestampnumber

Timestamp of when this status was retrieved

Example Usage

curl -X GET "https://api.trillet.ai/v1/api/batch-calls/batch_7891011121314" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Example Response

{
  "id": "batch_7891011121314",
  "status": "processing",
  "isComplete": false,
  "totalCalls": 150,
  "progress": {
    "waiting": 45,
    "active": 5,
    "completed": 95,
    "failed": 5,
    "total": 150,
    "startTime": 1703097600000,
    "lastCompletedTime": 1703101200000,
    "completedTime": null,
    "averageCallDuration": 45.2,
    "recent_calls": [
      {
        "jobId": "call_123",
        "status": "completed",
        "phone_number": "+1234567890",
        "completedAt": 1703101200000
      }
    ]
  },
  "timestamp": 1703101300000
}

Error Responses

errorstring

Error message describing what went wrong

messagestring

Additional context about the error

Common Error Codes:

404 - Batch not found with the specified ID
500 - Server error retrieving batch information

Status Monitoring

You can poll this endpoint to monitor the progress of your batch calls. The response includes detailed metrics about call completion rates, timing information, and recent call results.