Skip to main content
GET
Get a phone's live screen preview
Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key
string
header
required

Customer API key (axl_ prefix).

Path Parameters

phone_id
string
required

Phone identifier

Response

OK

Phone preview lookup result.

status
enum<string>
required

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

Available options:
ready,
pending
url
string

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