AXaxilioai
phones

Get a session recording

Changed on

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

get/phones/sessions/{session_id}/recording

Request

Path parameters

session_idstring uuid required

Phone session identifier

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

status'ready' | 'pending' | 'expired' | 'off' | 'unavailable' required

'unavailable' when it never arrived, for example a failed upload. 'ready' when a recording URL is returned, 'pending' while the recording is still being processed, 'expired' when it is past the plan's recording retention window, or 'off' when the session was not recorded (recording is off unless requested at allocation, or on the agent for its runs).

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"
}

Changes

  • 80de09d0e643Revision changes
    • warning

      added the new unavailable enum value to the response property for the response status

  • 49b1da5a7974Revision changes
    • warning

      added the new off enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status