v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-065499150.5 KB

phones

List phones ready to start a session

Returns the Android 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.

get/phones/available

Query parameters

phone_type'android'

only return Android phones

Response

$schemastring uri

A URL to the JSON Schema for this object.

android_countinteger required

Number of available Android devices.

Example response

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