GET
/
v1
/
api
/
batch-calls
/
{batchId}
/
status
curl --request GET \
  --url https://api.trillet.ai/v1/api/batch-calls/{batchId}/status \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "status": "<string>",
  "isComplete": true,
  "waiting": 123,
  "active": 123,
  "completed": 123,
  "failed": 123,
  "total": 123,
  "startTime": 123,
  "lastCompletedTime": 123,
  "completedTime": 123,
  "averageCallDuration": 123,
  "recent_calls": [
    {}
  ],
  "error": "<string>"
}

​
Headers

​
x-api-key
string
required

API key used for authenticating requests to the API.

​
x-workspace-id
string
required

Workspace identifier for the API.

​
Path Parameters

​
batchId
string
required

The unique identifier of the batch call operation

​
Response

​
status
string

Current status of the batch operation

​
isComplete
boolean

Whether the batch operation has finished

​
waiting
number

Number of calls waiting in queue

​
active
number

Number of calls currently being processed

​
completed
number

Number of successfully completed calls

​
failed
number

Number of failed calls

​
total
number

Total number of calls in the batch

​
startTime
number

Timestamp when the batch started processing

​
lastCompletedTime
number

Timestamp of the last completed call

​
completedTime
number

Timestamp when the batch was completed (if finished)

​
averageCallDuration
number

Average duration of completed calls in seconds

​
recent_calls
array

Array of recent call results for monitoring

​
Example Usage

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

​
Example Response

{
  "status": "processing",
  "isComplete": false,
  "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,
      "duration": 42
    },
    {
      "jobId": "call_124", 
      "status": "failed",
      "phone_number": "+1987654321",
      "failedAt": 1703101150000,
      "error": "Number busy"
    }
  ]
}

​
Error Responses

​
error
string

Error message describing what went wrong

Common Error Codes:

  • 500 - Server error retrieving batch progress information

​
Progress Tracking

This endpoint provides real-time progress updates for your batch call operations. Use it to build dashboards or monitor batch completion in your applications.