v12

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-014994227.2 KB
phones

Get a session recording

Returns a short-lived URL for the session's screen recording, keyed on session_id — so it works for workflow runs and workflow-less interactive leases alike. Status is "pending" (no URL) when the recording hasn't finished uploading yet. Org-scoped: another org's session reads as not found.

get/phones/sessions/{session_id}/recording

Path parameters

session_idstring uuid required

Phone session identifier

Phone session identifier

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

status'ready' | 'pending' | 'expired' required

'ready' when a recording URL is returned, 'pending' while the recording is still being processed, or 'expired' when it is past the plan's recording retention window.

urlstring

Playback URL for the recording MP4, set only when status is 'ready'. The URL is time-limited.

Example response

{
  "$schema": "/api/v1/PhoneSessionRecordingResponse.json"
}