recordings

Start a recording

Starts recording the phone's screen. One recording runs at a time per phone; a project keeps at most 20, each deleted 7 days after it starts.

post/v1/phones/{id}/recordings

Request

  • Base URL: https://phonebox.dev
  • URL: https://phonebox.dev/v1/phones/{id}/recordings
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring

A name to tell the recording apart, up to 80 characters.

Response

The recording, now recording.

object'recording' required
idstring required
phonestring required
namestring nullable required
status'recording' | 'processing' | 'ready' | 'failed' required

recording, then processing once stopped, then ready to download; or failed.

started_atstring date-time required

ISO 8601 timestamp (UTC)

ended_atstring date-time nullable required

ISO 8601 timestamp (UTC)

duration_msinteger nullable required
size_bytesinteger nullable required
expires_atstring date-time required

When Phonebox deletes the recording: 7 days after it started.

Changes

No recorded changes to this operation across all 1 revision of this API.