Cancel Call Batch
Stop a batch for good. There is no undo, and a batch cannot be deleted.
Everyone not yet called immediately reads as canceled. Calls already
ringing or in progress are not dropped — they run to their natural end,
and the batch is only finished once they have.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
The hours a batch may dial in, on the batch's own clock.
A window that crosses midnight (21:00–06:00) is valid and means
exactly what an evening consumer-calling window means: the day check applies
to the start side, so 21:00–06:00 on days: [5] runs Friday
21:00 through Saturday 06:00.
scheduled, running, paused, completed, canceled, failed What a call ran, frozen at the moment it started.
Written only when the call differs from "the published agent, as-is" — so a
null agent_plan means exactly that. members[0] is the agent that
answered.