Skip to main content
GET
Get a batch

Autorisierungen

Authorization
string
header
erforderlich

Generate (or rotate) your token on the Outbound Calls page in your dashboard. The token is shown once - store it securely; rotating it invalidates the previous token. A token only reaches your own agents and data.

Pfadparameter

id
string<uuid>
erforderlich

The batch_id returned when you placed the call(s).

Abfrageparameter

page
integer
Standard:1
Erforderlicher Bereich: x >= 1

Antwort

Batch detail.

success
boolean
Beispiel:

true

batch_id
string<uuid>
agent_name
string | null
agent_number
string
batch_created_at
string<date-time>
consents
object[]
total_pages
integer
current_page
integer
summary
object