Get a batch summary

Request

Retrieve a summary of a batch call operation, including statistics on completed, failed, in-progress, and queued calls. This provides an overview of the batch execution state and individual call session states.

Security

BasicAuth or SinchOAuth2

Path

projectIdstring, (uuid)(Project ID)required

The ID of the project.

batchIdstring, (ulid)(Batch ID)required

The ID of the batch.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://voice.api.sinch.com/v2/projects/{projectId}/batches/{batchId}'

Responses

A batch call summary

Bodyapplication/json

batchIdstring, (ulid)required

Unique identifier of the batch call operation (ULID). Use this value to retrieve the batch details ([GET] /v2/projects/{projectId}/batches/{batchId}/details) or stop processing ([DELETE] /v2/projects/{projectId}/batches/{batchId}).

sessionCountintegerrequired

Total number of call sessions requested in this batch.

Example:100

queuedintegerrequired

Number of call sessions that are queued and waiting to be initiated (not yet in progress).

Example:5

inProgressintegerrequired

Number of call sessions that are in progress.

Example:2

completedintegerrequired

Number of call sessions that have completed successfully.

Example:93

expiredintegerrequired

Number of queued call sessions that were not initiated before the batch TTL (ttlSeconds) elapsed and therefore expired.

Example:0

requestedCpsintegerrequired

Requested maximum call initiation rate, in calls per second (CPS), for this batch. Actual CPS may be lower depending on routing, carrier, and platform capacity, as well as account limitations.

Example:10

endTimestring, (date-time)

Timestamp (RFC 3339) when the batch finished processing (all call sessions reached a final state). Returns

Omitted if the batch is still in progress or has not completed yet.

ttlSecondsinteger

Batch time-to-live (TTL) in seconds. The maximum amount of time the platform will keep attempting to start queued call sessions in this batch. When the TTL expires, any call sessions that have not yet been initiated will stop being processed (calls already in progress are not affected).

Example:10800

Response

{
  "batchId": "01BX5ZZKBKACTAV9WEVGEMMVRC",
  "sessionCount": 3,
  "queued": 1,
  "inProgress": 1,
  "completed": 1,
  "expired": 0,
  "requestedCps": 10,
  "ttlSeconds": 3600
}

We'd love to hear from you!