AXaxilioai
phones

Get a phone's live screen preview

Changed on

Returns a short-lived URL for the phone's current screen preview — a rolling JPEG refreshed every few seconds while the phone is paired, available with or without an active session. Poll this endpoint and swap the image; every call mints a fresh URL. Status is "pending" when no preview exists yet. Authorized to the org that owns the phone or currently holds its active session; any other org reads as not found.

get/phones/{phone_id}/preview

Request

Path parameters

phone_idstring required

Phone identifier

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

status'ready' | 'pending' required

'ready' when a preview URL is returned, or 'pending' when no preview exists.

urlstring

URL for the current preview JPEG, set only when status is 'ready'. Time-limited; poll for a fresh image.

Example response

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

Changes

  • 49b1da5a7974Revision changes
    • 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

  • e2261ff54e62Revision changes
    • info

      the endpoint scheme security bearerAuth was removed from the API