Skip to main content
GET
/
batch-call
/
{id}
curl -X GET "https://api.zudu.ai/batch-call/batch_abc123" \
  -H "X-API-KEY: sk_Abc123Def456..." \
  -H "X-API-SECRET: s3cr3t_Xyz789..." \
{
  "message": "Batch call retrieved successfully",
  "status": "success",
  "data": {
    "batch_call_id": "batch_abc123",
    "name": "Customer Follow-up Campaign",
    "status": "COMPLETED",
    "total_task_count": 100,
    "completed_task_count": 95,
    "failed_task_count": 5,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T11:45:00Z"
  }
Get detailed information about a batch call including status, task counts, and metrics.
curl -X GET "https://api.zudu.ai/batch-call/batch_abc123" \
  -H "X-API-KEY: sk_Abc123Def456..." \
  -H "X-API-SECRET: s3cr3t_Xyz789..." \
{
  "message": "Batch call retrieved successfully",
  "status": "success",
  "data": {
    "batch_call_id": "batch_abc123",
    "name": "Customer Follow-up Campaign",
    "status": "COMPLETED",
    "total_task_count": 100,
    "completed_task_count": 95,
    "failed_task_count": 5,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T11:45:00Z"
  }

Headers

X-API-KEY
string
required
Your API key (format: sk_...)
X-API-SECRET
string
required
Your API secret (format: s3cr3t_...)

Path Parameters

id
string
required
The batch call ID (format: batch_...)Example: batch_abc123def456

Response Fields

batch_call_id
string
Unique identifier for the batch call
status
string
Current status: DRAFT, SCHEDULED, SENT, COMPLETED, FAILED
total_task_count
number
Total number of tasks in the batch
completed_task_count
number
Number of successfully completed tasks
failed_task_count
number
Number of failed tasks
created_at
string
ISO 8601 timestamp when batch call was created
updated_at
string
ISO 8601 timestamp of last update

Error Responses

error
string
Not Found - Batch call does not exist
{
  "message": "Batch call not found",
  "status": "error",
  "error": "Batch call with ID 'batch_abc123' does not exist"
}