Heimster · Schema

PostApiV1TelephonyCallsRequest

Real EstateSoftwareCRMArtificial IntelligenceSwiss

Properties

Name Type Description
callId string The phone system's call id (idempotency key). Derived from agent + number + start when missing.
number string The external number.
direction string in | out (also inbound / outbound).
status string answered | missed.
callType string Alternatively 3CX's Inbound | Outbound | Missed | Notanswered.
start string Call start: ISO-8601 or epoch milliseconds (default now).
duration string Talk time in seconds or hh:mm:ss.
agentEmail string E‑mail of the agent (a member of your organisation).
agent string Extension of the agent («Durchwahl»).
contactId string The contact, when already known (e.g. from the lookup).
createContact boolean Create a minimal contact for an unknown number (default false).
name string Caller name for a created contact.
note string Note stored with the call.
View JSON Schema on GitHub

JSON Schema

heimster-ch-post-api-v1-telephony-calls-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/heimster-ch/json-schema/heimster-ch-post-api-v1-telephony-calls-request-schema.json",
  "title": "PostApiV1TelephonyCallsRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/heimster-ch-openapi-generated.yml#/components/schemas/PostApiV1TelephonyCallsRequest",
  "type": "object",
  "properties": {
    "callId": {
      "type": "string",
      "description": "The phone system's call id (idempotency key). Derived from agent + number + start when missing."
    },
    "number": {
      "type": "string",
      "description": "The external number."
    },
    "direction": {
      "type": "string",
      "description": "in | out (also inbound / outbound)."
    },
    "status": {
      "type": "string",
      "description": "answered | missed."
    },
    "callType": {
      "type": "string",
      "description": "Alternatively 3CX's Inbound | Outbound | Missed | Notanswered."
    },
    "start": {
      "type": "string",
      "description": "Call start: ISO-8601 or epoch milliseconds (default now)."
    },
    "duration": {
      "type": "string",
      "description": "Talk time in seconds or hh:mm:ss."
    },
    "agentEmail": {
      "type": "string",
      "description": "E‑mail of the agent (a member of your organisation)."
    },
    "agent": {
      "type": "string",
      "description": "Extension of the agent («Durchwahl»)."
    },
    "contactId": {
      "type": "string",
      "description": "The contact, when already known (e.g. from the lookup)."
    },
    "createContact": {
      "type": "boolean",
      "description": "Create a minimal contact for an unknown number (default false)."
    },
    "name": {
      "type": "string",
      "description": "Caller name for a created contact."
    },
    "note": {
      "type": "string",
      "description": "Note stored with the call."
    }
  },
  "required": [
    "number"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/heimster-ch-post-api-v1-telephony-calls-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.