Batch Management
When you submit leads, SimZ creates a batch and returns a batchId. Save that value in your CRM or application so you can check progress and control dialing later.
Check batch status
Use GET /api/lead-receive-service/agent/batches/{batchId} to inspect the batch summary and per-entry call progress.
The response includes batch status, accepted and rejected counts, and entry-level call fields such as status, callSid, and callDuration.
Pause a batch
POST /api/lead-receive-service/agent/batches/{batchId}/pause pauses only the accepted backlog that has not yet been dialed.
- Dispatchable batches (
queuedorprocessing) can be paused. - Leads already in
acceptedstatus and waiting to dial are held. - Calls already accepted by core may continue and remain traceable.
Resume a batch
POST /api/lead-receive-service/agent/batches/{batchId}/resume resumes a paused batch that still has accepted backlog.
- Only batches in
pausedstatus can be resumed. - If nothing has been dialed yet, the batch returns to
queued. - If dialing already started, the batch returns to
processing.
Cancel a batch
POST /api/lead-receive-service/agent/batches/{batchId}/cancel cancels accepted leads that have not yet been dialed.
- Accepted backlog entries are cancelled and will not be dialed.
- The batch is marked
cancelledeven when no accepted backlog remains (cancelledEntriesmay be0). - Calls already accepted by core may still complete and remain traceable.
- You can optionally pass a
reasonin the request body. SimZ stores it on cancelled entries and defaults tocancelled_by_clientwhen omitted.
Pause all or cancel all
Use company-wide controls when you need to stop multiple active batches at once.
Both endpoints accept an optional JSON body:
agentIdscopes the operation to one agent. Omit it to affect all matching batches for your company.reasonis optional, only applies tocancel-all, and defaults tocancelled_by_clientwhen omitted.
Skip behavior: neither endpoint fails the whole request when individual batches do not qualify.
pause-allskips batches that are not dispatchable (queuedorprocessing), already paused, or have no accepted backlog.cancel-allconsiders controllable batches (queued,processing, orpaused) and skips any batch where no accepted entries were cancelled.
Common errors
See Errors and Rate Limits for submission errors and retry guidance.
