KaiCalls Phone System API

openapi: 3.2.0
info:
  title: KaiCalls Public Phone System API
  version: '2026-06-05'
  description: Machine-readable surface for KaiCalls external developers and client agents.
servers:
- url: https://www.kaicalls.com/api
security:
- bearerAuth: []
tags:
- name: Phone System
paths:
  /v1/phone-system:
    get:
      summary: 'Phone-system status for a business: which carrier owns its numbers and, for…'
      parameters:
      - name: business_id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Phone-system status
      x-required-scopes: numbers:read
      tags:
      - Phone System
      operationId: getV1PhoneSystem
      x-operation-id-source: derived
    post:
      summary: Provision (or resume provisioning) the hosted phone system for a business…
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                business_id:
                  type: string
                action:
                  type: string
                  enum:
                  - provision
                  - register_platform_webhook
                  - add_ring_group_member
                  - get_flow
                  - save_flow
                  - propose_flow
                  default: provision
                  description: get_flow reads the reconciled phone flow (who rings, for how long, business-hours mode) from the phone system; save_flow validates and applies a flow idempotently (loop guard on every member, schedule derived from business hours); propose_flow turns free text into a validated flow plus a one-sentence readback without applying it.
                flow:
                  type: object
                  description: 'save_flow: the phone flow — { version: 1, hours: { mode: always | business_hours, afterHours: kai }, ring: { members: [{ kind: cell, phone, label, requirePressOne } | { kind: desk_phone | user, userId, label }], timeoutSeconds }, overflow: kai }.'
                text:
                  type: string
                  description: 'propose_flow: how the phones should ring, in the owner''s words (e.g. "me and Maria ring for 20 seconds, after hours straight to Kai").'
                owner_mobile:
                  type: string
                  description: E.164 override for the ring-group member (defaults to the owner mobile on file).
                business_address:
                  type: object
                  description: 'provision: the business street address to save before provisioning — { street, city, state, zip } (US). Required only when no complete address is on file (409 missing_address).'
                  properties:
                    street:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    zip:
                      type: string
                phone_number:
                  type: string
                  description: 'add_ring_group_member: the teammate cell (E.164) to add to the team ring group. Owners/admins are also registered on the admin roster so calling the business line from that cell reaches the secretary. The forwarded-from office line is refused (loop guard).'
                name:
                  type: string
                  description: 'add_ring_group_member: display name.'
                role:
                  type: string
                  enum:
                  - owner
                  - admin
                  - member
                  description: 'add_ring_group_member: member only rings; owner/admin can call Kai.'
      responses:
        '200':
          description: Provisioning result (ids, created/reused, warnings)
        '409':
          description: Provisioning blocked (missing address / owner mobile)
      x-required-scopes: numbers:write
      tags:
      - Phone System
      operationId: postV1PhoneSystem
      x-operation-id-source: derived
  /v1/phone-system/devices:
    get:
      summary: Desk-phone shipping requests for a business (handset count, status, tracking)…
      parameters:
      - name: business_id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Device requests, newest first
      x-required-scopes: numbers:read
      tags:
      - Phone System
      operationId: getV1PhoneSystemDevices
      x-operation-id-source: derived
    post:
      summary: 'Request desk phones for the hosted phone system: handset count + shipping…'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              - handset_count
              - address
              properties:
                business_id:
                  type: string
                handset_count:
                  type: integer
                  minimum: 1
                  maximum: 100
                contact_name:
                  type: string
                address:
                  type: object
                  required:
                  - line1
                  - city
                  - state
                  - postal_code
                  properties:
                    line1:
                      type: string
                    line2:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    postal_code:
                      type: string
                    country:
                      type: string
                      default: US
                notes:
                  type: string
      responses:
        '200':
          description: Saved device request
        '400':
          description: Missing handset count or address
      x-required-scopes: numbers:write
      tags:
      - Phone System
      operationId: postV1PhoneSystemDevices
      x-operation-id-source: derived
  /v1/phone-system/desk-phones:
    get:
      summary: The desk phones plugged into a business's phone system, read live (name, MAC…
      parameters:
      - name: action
        in: query
        required: false
        schema:
          type: string
          enum:
          - setup
        description: Owner-only private setup address; requires numbers:write for API keys.
      - name: business_id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Desk phones or owner-only setup address
        '403':
          description: Business access or required role/scope denied
      x-required-scopes: numbers:read
      tags:
      - Phone System
      operationId: getV1PhoneSystemDeskPhones
      x-operation-id-source: derived
    post:
      summary: 'Add a desk phone by MAC address: creates its line, registers the phone, and…'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              oneOf:
              - required:
                - mac_address
                - name
                not:
                  required:
                  - action
              - required:
                - action
                - device_id
              properties:
                business_id:
                  type: string
                mac_address:
                  type: string
                  example: 00:04:13:aa:bb:cc
                name:
                  type: string
                  example: Front Desk
                action:
                  type: string
                  enum:
                  - refresh
                  - attach_emergency_location
                  description: Send 'refresh' with device_id to reload settings. Send 'attach_emergency_location' to attach the provisioned main office location only when the phone has no location; existing locations are preserved. Both require owner role or numbers:write.
                device_id:
                  type: string
      responses:
        '200':
          description: Phone added, settings reload requested, or emergency location verified by readback
        '400':
          description: Invalid MAC address or missing name
        '409':
          description: Duplicate phone, phone system not set up, or address not validated
      x-required-scopes: numbers:write
      tags:
      - Phone System
      operationId: postV1PhoneSystemDeskPhones
      x-operation-id-source: derived
    delete:
      summary: Remove a desk phone and its line from the phone system.
      parameters:
      - name: business_id
        in: query
        required: true
        schema:
          type: string
      - name: device_id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Removed
        '404':
          description: Phone not found
      x-required-scopes: numbers:write
      tags:
      - Phone System
      operationId: deleteV1PhoneSystemDeskPhones
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'KaiCalls API key. Per-operation scope requirements are published on each operation as `x-required-scopes` — a scope string, or a nested `{ allOf: [...] }` / `{ anyOf: [...] }` expression. An operation with no `x-required-scopes` requires a valid key but no particular scope.'
      x-scopes:
      - workspaces:read
      - workspaces:write
      - numbers:read
      - numbers:write
      - agents:read
      - agents:write
      - communication-runs:read
      - communication-runs:write
      - calls:read
      - calls:write
      - sms:read
      - sms:write
      - webhooks:read
      - webhooks:write
      - events:read
      - events:replay
      - lifecycle:write
      - leads:read
      - leads:write
      - emails:read
      - emails:write
      - sdr:read
      - sdr:write
      - evals:read
      - evals:write
      - appointments:read
      - appointments:write
      - knowledge:read
      - knowledge:write
      - products:read
      - products:write
      - integrations:write
      - approvals:write
      - concierge:write
      - billing:read
      - billing:write
      - call_evidence:read
      - call_evidence:write
      - support:write
    sessionAuth:
      type: apiKey
      in: cookie
      name: sb-access-token
      description: Authenticated dashboard session cookie. Used by first-party flows that mint or manage API keys.