Batch Details

Your API key for authentication.

The unique identifier for the batch of calls you want to retrieve.

Whether or not to include individual call data in the response.

If calls are included, can be set to false to exclude transcripts from the response.

If calls are included, can be set to false to exclude analysis from the response.

The status of the batch. Possible values are in-progress and completed.

• in-progress: The batch is still in progress.
• completed: Every call in the batch has completed.

An object containing parameters and settings for the batch.

The unique identifier of the batch - used as the batch_id parameter in other API calls.

The creation timestamp of the batch.

The label or description of the batch.

The base prompt used for calls in this batch.

The endpoint code used for API integration.

An object containing parameters for the calls in the batch.

An object containing analysis data for the batch.

The total number of calls in the batch, including completed and in-progress calls.

The total number of completed calls in the batch.

The total number of in-progress calls in the batch.

An object containing the number of calls in each queue status.

Example:

{
  "complete": 237,
  "queued": 2,
  "call_error": 1
}

Contains average, average_nonzero, summary and all fields.

• average: The average call length in minutes.
• average_nonzero: The average call length in minutes, excluding calls with a length of less than one second.
• summary: A summary of the call lengths, grouped into ranges.
• all: Contains each call length, in case you want to use a different grouping than the default.

Contains each call_id in the batch.

Contains any error messages that calls in the batch may have.

Example:

[
  {
    "call_id": "c52f5f8c-147e-478c-4b40-88214feeba29",
    "error_message": "Cannot transfer to +12223334444 - Call is no longer active"
  }
]

Contains the number of calls that have been sent to each endpoint. Applicable only to API integrations.

An array of objects, each representing individual call data.

The timestamp when the individual call was created.

The phone number the call was made to.

The phone number the call was made from.

Indicates if the call was completed.

The unique identifier for each individual call.

The duration of the call in minutes.

Contains a string value if the batch had answered_by_enabled set to true.

Values:

• voicemail
• human
• unknown
• no-answer
• null