Voice Platform APISessions

Get session details

View as Markdown

Look up details for a session owned by your app.

Authentication

AuthorizationBearer
Application auth. Send `Authorization: Bearer <app_uuid>:<api_key>`. See [Authentication](https://voice-platform.docs.buildwithfern.com/api/authentication) for details.

Path parameters

uuidstringRequired

Session UUID (format {5-char-prefix}-{uuid}).

Response

Session details
caller_idstring

Caller ID in canonical international E.164 format with leading + (e.g. +972527121102). 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. +972747713001). Empty for websocket sessions (no phone leg).

session_uuidstring
Opaque session identifier. Return it to the API exactly as received.
statusenum

Current lifecycle status of the session. connecting applies to a websocket session whose backend WebSocket has not yet connected.

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
  • webrtc: a WebRTC client
  • websocket: a standalone WebSocket session with no phone leg
  • unknown: could not be determined

Errors

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