Get a session details by the session ID

Request

Retrieve detailed information about a specific session, including all associated calls and their current states. Sessions represent the complete interaction lifecycle and can contain multiple related calls.

Security

BasicAuth or SinchOAuth2

Path

projectIdstring, (uuid)(Project ID)required

The ID of the project.

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

sessionIdstring, (ulid)(Session ID)required

The ID of the session.

Example:01BX5ZZKBKACTAV9WEVGEMMVRB

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

Responses

A session object

Bodyapplication/json

sessionIdstring, (ulid)(Session ID)required

The ID of the session.

Example:"01BX5ZZKBKACTAV9WEVGEMMVRB"

projectIdstring, (uuid)(Project ID)required

The Id of the project associated with the call.

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

serviceIdstring, (uuid)(Service ID)required

The ID of the service used.

Example:"6e124178-c29d-46a5-943c-5c2ae544aade"

callsArray of objects(Call Resource)required

createTimestring, (date-time)read-onlyrequired

Timestamp (RFC 3339) indicating when the session was created.

Example:"2025-01-01 00:00:00+00:00"

statestring(Session States)read-onlyrequired

The state of the current session. Sessions can either be in a "transitional" or "final" state. Sessions in a transitional state are ongoing. Sessions in a final state have will not send any more events.

Enum Value	Description
QUEUED	The session is queued, no calls have been initiated for this session. This is a transitional state.
IN_PROGRESS	At least one call has been initiated or received for this session. This is a transitional state.
COMPLETED	The session was completed. This is a final state.
EXPIRED	The call session was not initiated before the batch time-to-live (TTL) elapsed. This is a final state.

Example:"COMPLETED"

updateTimestring, (date-time)read-only

Timestamp (RFC 3339) indicating when the session was last updated.

Omitted if no updates were performed on this session.

Example:"2025-01-01 00:00:00+00:00"

endTimestring, (date-time)read-only

Timestamp (RFC 3339) indicating when the session ended.

Omitted for ongoing sessions.

Example:"2025-01-01 00:00:00+00:00"

Response

{
  "sessionId": "01BX5ZZKBKACTAV9WEVGEMMVRB",
  "projectId": "5c5bf2b1-35ae-4825-ab89-457e07bb60e6",
  "serviceId": "6e124178-c29d-46a5-943c-5c2ae544aade",
  "state": "COMPLETED",
  "createTime": "2025-02-10T09:00:00Z",
  "updateTime": "2025-02-10T09:00:47Z",
  "endTime": "2025-02-10T09:00:47Z",
  "calls": [
    { … }
  ]
}