Get batch details

Request

Retrieve per-session details for a batch, including the current state of each call session in the batch. Use this endpoint when individual session-level visibility is needed (for example, to inspect which sessions are QUEUED, IN_PROGRESS or COMPLETED). EXPIRED sessions are never returned because they were never initiated.

Security

BasicAuth or SinchOAuth2

Path

projectIdstring, (uuid)(Project ID)required

The ID of the project.

Example:5c5bf2b1-35ae-4825-ab89-457e07bb60e6

batchIdstring, (ulid)(Batch ID)required

The ID of the batch.

Example:01BX5ZZKBKACTAV9WEVGEMMVRC

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

Responses

Batch details

Bodyapplication/json

sessionsArray of objectsrequired

Example:

[
  {
    "id": "01F8Z5J4X2G9Y3J4X2G9Y3J4X2G9",
    "state": "COMPLETED",
    "parameters": { … }
  },
  {
    "id": "01F8Z5J4X2G9Y3J4X2G9Y3J4X5YJ",
    "state": "IN_PROGRESS",
    "parameters": { … }
  }
]

Response

{
  "sessions": [
    { … },
    { … },
    { … }
  ]
}