Skip to main content
GET
/
batch-call
/
{id}
Get batch call by ID
curl --request GET \
  --url http://localhost:8080/batch-call/{id} \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>'
{
  "message": "Batch call retrieved successfully",
  "status": "success",
  "error": null,
  "data": {
    "batch_call_id": "batch_call_a1b2c3d4e5f6789012345678901234567",
    "name": "Q1 Sales Campaign",
    "from_number": "+14157774444",
    "scheduled_timestamp": 1735718400000,
    "total_task_count": 100,
    "total": 100,
    "sent": 100,
    "picked_up": 75,
    "completed": 68,
    "agent_id": "agent_7ff47846-c8a0-4304-ae13-88cfc31c1a03",
    "organization_id": "e3yn0c4mivqs8y4yhb5k",
    "status": "completed",
    "timezone": "UTC",
    "last_sent_timestamp": 1735718500000,
    "tasks_url": "https://storage.azure.com/.../tasks.json",
    "created_timestamp": 1735718400000
  }
}

Authorizations

X-API-KEY
string
header
required

API Key for MCP server and external service authentication

X-API-SECRET
string
header
required

API Secret for MCP server and external service authentication

Path Parameters

id
string
required

Batch call ID (batch_call_[32-hex-chars])

Example:

"batch_call_a1b2c3d4e5f6789012345678901234567"

Response

Batch call retrieved successfully

message
string
status
string
error
string | null
data
object