phone

Create a phone

post/v1/phones

Request

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

Headers

Idempotency-Keystring

Send one with every create: without it, a create whose reply was lost can't be told apart from one that failed. The same key and body return the same phone, as it is now, for 24 hours.

Request body

namestring
country'AR' | 'AU' | 'AT' | 'BE' | 'BR' | 'CA' | 'CL' | 'CO' | 'CZ' | 'DK' | 'EG' | 'FI' | 'FR' | 'DE' | 'GR' | 'HK' | 'IN' | 'ID' | 'IE' | 'IL' | 'IT' | 'JP' | 'KE' | 'MY' | 'MX' | 'NL' | 'NZ' | 'NG' | 'NO' | 'PH' | 'PL' | 'PT' | 'RO' | 'SA' | 'SG' | 'ZA' | 'KR' | 'ES' | 'SE' | 'CH' | 'TW' | 'TH' | 'TR' | 'UA' | 'AE' | 'GB' | 'US' | 'VN'
metadataobject
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.