Skip to navigation
API OverviewSessions & Calls

Get session details

View as Markdown

Get details for a session.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Path parameters

uuidstringRequired

Session identifier.

uuidstringRequired

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.

Response

Session details
caller_idstring

Caller ID in canonical international E.164 format with leading + (e.g. +972500000000). Empty for websocket sessions (no phone leg).

created_atdatetime

When the session was created, as an RFC 3339 / ISO 8601 UTC string (e.g. “2025-05-06T12:41:36.000Z”). Storage resolution is one second, so the millisecond fraction is always .000. Empty string if the originating timestamp is missing or unparseable.

didstring

Called DID in canonical E.164 format with leading + (e.g. +972740000000). Empty for websocket sessions (no phone leg).

session_uuidstring
Session identifier.
stateenum

Current lifecycle state of the session. connecting applies to a websocket session whose WebSocket server connection has not yet been established.

typeenum

The nature of the session:

  • phone_in: inbound phone call from a carrier
  • phone_out: outbound phone call placed with dial
  • sip: a registered SIP device
  • websocket: a WebSocket session with no phone leg
  • unknown: could not be determined or is not a supported public session type
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable Error
500
Internal Server Error