Start a batch

Queues up to 1,000 calls in one request. Each row is checked on its own: valid rows are queued, invalid rows come back in rejected with the row’s index. Batch calls are dialled as lines free up, behind single calls.

Scope: calls:write.

POST /batches

Start a batch

cURL

curl --request POST \
  --url https://api.telleo.ai/v1/batches \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agent_id": "17ea33d2-5b6c-4c1e-9a1f-2d4e6f8a9b0c",
  "calls": [
    {
      "phone_number": "[phone]",
      "contact": {
        "name": "Asha Verma",
        "external_id": "lead-8812"
      },
      "variables": {
        "course": "NEET 2027"
      }
    },
    {
      "phone_number": "[phone]",
      "contact": {
        "name": "Rohan Das",
        "external_id": "lead-8813"
      },
      "variables": {
        "course": "JEE 2027"
      }
    }
  ]
}
'

201

Example

{
  "id": "batch_2b9e0c1d4f6a8e7c5b3a1d0f",
  "object": "batch",
  "agent_id": "<string>",
  "test": true,
  "accepted_count": 123,
  "rejected_count": 123,
  "calls": [
    {
      "index": 123,
      "id": "<string>",
      "phone_number": "<string>",
      "external_id": "<string>"
    }
  ],
  "rejected": [
    {
      "index": 123,
      "phone_number": "<string>",
      "code": "invalid_request",
      "message": "<string>",
      "call_id": "<string>"
    }
  ]
}

Authorizations

X-API-Key · string · header · required

Your AI calling API key (vak_call_…). Authorization: Bearer <key> also works.

Body

application/json

agent_id · string · required

Default agent for every row.

calls · object[] · required

Required array length: 1 - 1000 elements

Show child attributes

test · boolean · default: false

Response

201

application/json

The batch was created.

id · string

Example:

"batch_2b9e0c1d4f6a8e7c5b3a1d0f"

object · string

Allowed value: "batch"

agent_id · string

test · boolean

accepted_count · integer

rejected_count · integer

calls · object[]

Show child attributes

rejected · object[]

Show child attributes