Sign in

v12

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-014994227.2 KB
phones

List phones ready to start a session

Returns the phones the caller can start a session on right now: every active phone in the shared pool, plus the caller org's own dedicated phones that are currently free. Only free + active phones appear here, so a dedicated phone that is busy or offline is intentionally absent - use GET /phones/my to see the org's full dedicated inventory including in-use ones. Optionally filtered by phone_type; counts by type are included alongside the list.

get/phones/available

Query parameters

phone_type'iphone' | 'android'

only return phones of this type

only return phones of this type

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

android_countinteger required

Number of available Android devices.

iphone_countinteger required

Number of available iPhones.

Example response

{
  "$schema": "/api/v1/PhoneAvailableListResponse.json",
  "phones": [
    {
      "$schema": "/api/v1/PhoneSummary.json"
    }
  ]
}