API Reference

Phone Numbers & DIDs API

Programmatically query, search, provision, and route dedicated inbound and outbound clinical eFax numbers (DIDs) across healthcare telecom carriers.

GET/v1/phone-numbers

Returns an array of phone numbers associated with the organization, including telecom carrier, inbound routing numbers, and total document transmission metrics.

Response Example (200 OK)

{
  "phoneNumbers": [
    {
      "id": "pn_4f8a1290bb",
      "number": "+14155552671",
      "friendlyName": "Primary Clinical Intake",
      "carrier": "SINCH",
      "inboundRoutingNumber": "+14155552671",
      "isActive": true,
      "autoProcessAi": true,
      "documentCount": 342,
      "createdAt": "2026-09-18T12:00:00.000Z",
      "updatedAt": "2026-09-21T16:45:00.000Z"
    },
    {
      "id": "pn_9b1c7844aa",
      "number": "+14155558912",
      "friendlyName": "Specialist Referral Line",
      "carrier": "RINGCENTRAL",
      "inboundRoutingNumber": "+14155558912",
      "isActive": true,
      "autoProcessAi": true,
      "documentCount": 89,
      "createdAt": "2026-09-19T08:30:00.000Z",
      "updatedAt": "2026-09-20T11:20:00.000Z"
    }
  ]
}
GET/v1/phone-numbers/available

Fetches active, provisioned phone numbers directly from the organization's connected carrier account (e.g. Sinch or RingCentral) ready to be linked into Intellectua.

Response Example (200 OK)

{
  "success": true,
  "isConfigured": true,
  "carrier": "SINCH",
  "numbers": [
    {
      "phoneNumber": "+14155552671",
      "friendlyName": "Clinical Intake Fax"
    },
    {
      "phoneNumber": "+14155558912",
      "friendlyName": "Referral Processing Line"
    }
  ]
}
POST/v1/phone-numbers

Provisions a new phone number record and binds it to the specified carrier integration trunk for immediate inbound webhook listening.

Request Body Schema

FieldTypeRequiredDescription
numberstringYesPhone number in E.164 format (e.g. +14155552671).
friendlyNamestringNoHuman-readable label for clinic staff (e.g. "Oncology Intake").
carrierstringNoCarrier trunk (SINCH, RINGCENTRAL, etc. Default: SINCH).
autoProcessAibooleanNoWhether to trigger automatic AI OCR demographic extraction on arrival (default: true).
PATCH/v1/phone-numbers/:id

Updates metadata or enables/disables traffic on a dedicated phone number line.

DELETE/v1/phone-numbers/:id

Unlinks the phone number from the workspace and ceases inbound carrier webhook routing for this DID.