phone

Start a phone

post/v1/phones/{id}/start

Request

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

Path parameters

idstring required

Request body

idle_timeoutinteger
max_durationinteger
waitboolean

Response

The phone is ready.

idstring required
object'phone' required
namestring required
status'creating' | 'starting' | 'ready' | 'parking' | 'parked' | 'unavailable' | 'failed' | 'deleted' required
countrystring nullable required
metadataobject required
created_atstring date-time required

ISO 8601 timestamp (UTC)

last_active_atstring date-time nullable required

ISO 8601 timestamp (UTC)

Changes

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