Skip to main content
GET
Get a batch

Autorisierungen

Authorization
string
header
erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Pfadparameter

id
string<uuid>
erforderlich

ID of the batch.

Abfrageparameter

page
integer
Standard:1

Page of call records, starting at 1.

Erforderlicher Bereich: x >= 1

Antwort

Batch detail.

success
boolean

Always true.

Beispiel:

true

batch_id
string<uuid>

ID of the batch.

agent_name
string | null

Name of the agent that placed the calls, if it still exists.

agent_number
string

Number or SIP ID of the agent.

batch_created_at
string<date-time>

When the batch was created.

consents
object[]

Call records of the batch, one per destination.

total_pages
integer

Number of pages of call records.

current_page
integer

Page returned.

summary
object

Counts over the whole batch.