AXaxilioai
phones

Phone availability summary

Changed on

Returns a capacity snapshot to check before POST /phones:allocate: shared-pool availability broken down by phone type and by location, plus the caller org's dedicated phones with how many are idle (claimable right now). Optional phone_type and location filters narrow every count. Advisory only - availability can change between this read and an allocate, so allocation remains the authority and can still refuse.

get/phones/availability

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-Axilio-Api-Key

Query parameters

phone_type'android' | 'iphone'

Only count phones of this platform.

locationstring

Only count phones at this location slug.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "/api/v1/PhoneAvailabilityResponse.json"
}

Changes

  • 49b1da5a7974Revision changes
    • warning

      added the new android enum value to the /// response property for the response status

    • warning

      added the new android enum value to the /// response property for the response status

    • warning

      added the new iphone enum value to the /// response property for the response status

    • warning

      added the new iphone enum value to the /// response property for the response status

    • warning

      added the new unknown enum value to the /// response property for the response status

    • warning

      added the new unknown enum value to the /// response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 0544f51ba55aRevision changes
    • info

      endpoint added