phone

Get a phone

get/v1/phones/{id}

Request

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

Path parameters

idstring required

Query parameters

wait'ready' | 'parked'
timeoutinteger

Response

The phone. With wait, long-polls up to timeout seconds, and answers at once when the phone can't reach that status without a new request. Poll again only while it is creating or starting (wait=ready) or parking (wait=parked).

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.